Skip to content

Commit bc6b5e0

Browse files
didooKristinLBradleydchyun
authored
Apply suggestions from code review
Co-authored-by: Kristin Bradley <kristin.bradley@hashicorp.com> Co-authored-by: Dylan Hyun <dylan.hyun@hashicorp.com>
1 parent 484ef5d commit bc6b5e0

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

website/docs/layouts/flex/partials/code/component-api.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
If a `@wrap` parameter is provided, the flex items can wrap onto multiple lines when there is not enough space in the container to fit them all in a single line.
3030
</C.Property>
3131
<C.Property @name="gap" @type="enum|[enum,enum]" @values={{array "4" "8" "12" "16" "24" "32" "48"}}>
32-
Use the `@gap` argument to control the spacing between flex items. To differentiate the vertical and horizontal spacing between items when they wrap on multiple rows, provide an array of two values , where the first value refers to the vertical gap between "rows" of items (`row-gap` in CSS), the second one to the horizontal spacing between "columns" of items (`column-gap` in CSS).
32+
Use the `@gap` argument to control the spacing between flex items. To differentiate the vertical and horizontal spacing between items when they wrap on multiple rows, provide an array of two values, where the first value refers to the vertical gap between "rows" of items (`row-gap` in CSS), and the second one to the horizontal spacing between "columns" of items (`column-gap` in CSS).
3333
</C.Property>
3434
<C.Property @name="isInline" @type="boolean" @default="false">
3535
If an `@isInline` parameter is provided, then the element will be displayed as `inline-flex` (useful to achieve specific layouts). Otherwise, it will have a `flex` layout.
@@ -50,24 +50,24 @@ The `Layout::Flex::Item` component, yielded as contextual component, to be used
5050
HTML tag to be used to render the flex item element.
5151
</C.Property>
5252
<C.Property @name="basis" @type="string|0">
53-
The value (size) of the CSS `flex-basis` property, which sets the initial main size the flex item (for a technical explanation: [see MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-basis)).
53+
The value (size) of the CSS `flex-basis` property, which sets the initial main size of the flex item (for a technical explanation: [see MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-basis)).
5454
<br/><br/>
55-
<em>Notice: when the value is set to `0` a CSS class is used to apply the `flex-basis` property; in all the other cases an inline `style` declaration is used, to accomodate for all the possible values that this CSS property can have.</em>
55+
<em>Notice: when the value is set to `0`, a CSS class is used to apply the `flex-basis` property. In all other cases, an inline `style` declaration is used to accommodate all the possible values that this CSS property can have.</em>
5656
</C.Property>
5757
<C.Property @name="grow" @type="boolean|number|string">
5858
The value (size or keyword) of the CSS `flex-grow` property, which sets the flex grow factor of the flex item (for a technical explanation: [see MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-grow)).
5959
<br/><br/>
60-
<em>Notice: when the value is set to `true/false` or `0/1` a CSS class is used to apply the `flex-grow` property; in all the other cases an inline `style` declaration is used, to accomodate for all the possible values that this CSS property can have.</em>
60+
<em>Notice: when the value is set to `true/false` or `0/1` a CSS class is used to apply the `flex-grow` property. In all other cases, an inline `style` declaration is used, to accommodate all the possible values that this CSS property can have.</em>
6161
</C.Property>
6262
<C.Property @name="shrink" @type="boolean|number|string">
6363
The value (size or keyword) of the CSS `flex-shrink` property, which sets sets the flex shrink factor of the flex item (for a technical explanation: [see MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-shrink)).
6464
<br/><br/>
65-
<em>Notice: when the value is set to `true/false` or `0/1` a CSS class is used to apply the `flex-shrink` property; in all the other cases an inline `style` declaration is used, to accomodate for all the possible values that this CSS property can have.</em>
65+
<em>Notice: when the value is set to `true/false` or `0/1` a CSS class is used to apply the `flex-shrink` property. In all other cases, an inline `style` declaration is used, to accommodate all the possible values that this CSS property can have.</em>
6666
</C.Property>
6767
<C.Property @name="enableCollapseBelowContentSize" @type="boolean">
68-
When this special argument is set to `true` it applies a `min-width: 0` to the element, allowing the flex item to shrink below its content's intrinsic minimum width (e.g. used with elliptized text)
68+
When this special argument is set to `true`, it applies `min-width: 0` to the element, allowing the flex item to shrink below its content's intrinsic minimum width (e.g., used with elliptized text)
6969
<br/><br/>
70-
<em>Notice: this may have accessibility implications, be considerate in how this special argument is used and how this impacts the content of the flex item element.</em>
70+
<em>Notice: this may have accessibility implications; be considerate in how this special argument is used and how this impacts the content of the flex item element.</em>
7171
</C.Property>
7272
<C.Property @name="yield">
7373
Elements passed as children are yielded as inner content of the element.

website/docs/layouts/flex/partials/code/how-to-use.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44

55
It's much easier to use this component if one is familiar with the CSS3 Flexible Box specifications.
66
<br/>
7-
A good and quick introduction to flexbox can be found in [**this MDN guide**](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flexible_box_layout/Basic_concepts_of_flexbox).
7+
A good and quick introduction to flexbox can be found in [this MDN guide](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flexible_box_layout/Basic_concepts_of_flexbox).
88

99
!!!
1010

1111
The `Layout::Flex` and optional `Layout::Flex::Item` components provide a way to quickly build out flexbox-based layouts of components or elements without needing to write a lot of custom CSS code or understand all the intricacies of CSS flexbox styles.
1212

1313
### Basic usage
1414

15-
The simplest way to implementat a flexbox layout is by using the `Layout::Flex` component to wrap some content:
15+
The simplest way to implement a flexbox layout is by using the `Layout::Flex` component to wrap some content:
1616

1717
```handlebars{data-execute=false}
1818
<Hds::Layout::Flex>

0 commit comments

Comments
 (0)