Skip to content

Commit 2d0aadc

Browse files
committed
Update ReadMe
- Grammar and clarity edits.
1 parent 7f8b3a9 commit 2d0aadc

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Then, in our code, set the value based on the breakpoint condition.
9595
> expand: ResponsiveBreakpoints.of(context).largerThan('EXPAND_SIDE_PANEL')
9696

9797
### Responsive Framework Widgets
98-
The ResponsiveFramework includes a few custom widgets that to supplement Flutter's responsive capabilities. They are showcased in the demo projects.
98+
The ResponsiveFramework includes a few custom widgets that supplement Flutter's responsive capabilities. They are showcased in the demo projects.
9999

100100
- *[ResponsiveValue](https://github.com/Codelessly/ResponsiveFramework/blob/master/lib/responsive_value.dart)*
101101
- *[ResponsiveRowColumn](https://github.com/Codelessly/ResponsiveFramework/blob/master/lib/responsive_row_column.dart)*
@@ -107,9 +107,9 @@ The ResponsiveFramework includes a few custom widgets that to supplement Flutter
107107
## Legacy ReadMe (v0.2.0 and below)
108108

109109
### ResponsiveWrapper Migration
110-
The legacy ResponsiveWrapper combined multiple features into one widget. This made it difficult to use at times when custom behavior was required. The updated V1 implementation separates each feature into its own widget and is now more modular.
110+
The legacy ResponsiveWrapper combined multiple features into one widget. This made it difficult to use at times when custom behavior was required. The updated V1 implementation separates each feature into its own widget.
111111

112-
Responsive Framework v1 introduces some new widgets:
112+
Responsive Framework v1 introduces some new widgets as well:
113113

114114
- ResponsiveScaledBox
115115
- MaxWidthBox
@@ -120,15 +120,21 @@ Responsive Framework v1 introduces some new widgets:
120120

121121
Replaces the core AutoScale functionality of ResponsiveWrapper. ResponsiveScaledBox renders the `child` widget with the specified `width`.
122122

123-
This widget simply wraps the Flutter `FittedBox` widget with a `LayoutBuilder` and `MediaQuery`. Use a `ResponsiveScaledBox` instead of a `FittedBox` if the layout being wrapped is full screen as the widget helps calculate scaled `MediaQueryData`.
123+
This widget wraps the Flutter `FittedBox` widget with a `LayoutBuilder` and `MediaQuery`.
124+
125+
**Why should you use a `ResponsiveScaledBox`?**
126+
127+
Use a `ResponsiveScaledBox` instead of a `FittedBox` if the layout is full screen as the widget helps calculate correctly scaled `MediaQueryData`.
124128

125129
#### MaxWidthBox
126130
> MaxWidthBox(maxWidth: maxWidth, background: background, child: child);
127131

128-
Limits the `child` widget to the `maxWidth` and paints an optional `background` behind the widget. This widget is helpful for limiting the content width on large desktop displays and creating gutters on the left and right side of the page.
132+
Limit the `child` widget to the `maxWidth` and paints an optional `background` behind the widget.
133+
134+
This widget is helpful for limiting the content width on large desktop displays and creating gutters on the left and right side of the page.
129135

130136

131-
### The remainder of the legacy ReadMe is preserved below as the concepts are useful and supported by the new widgets. ResponsiveWrapper has been deprecated and removed.
137+
### The remainder of the legacy ReadMe is preserved below as the concepts are still useful and used by the new widgets. ResponsiveWrapper has been deprecated and removed.
132138

133139
### The Problem
134140
Supporting multiple display sizes often means recreating the same layout multiple times. Under the traditional _Bootstrap_ approach, building responsive UI is time consuming, frustrating and repetitive. Furthermore, getting everything pixel perfect is near impossible and simple edits take hours.

0 commit comments

Comments
 (0)