Skip to content

chore(docs): update grid layout docs (closes #5332) #5333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 9, 2020
Merged

chore(docs): update grid layout docs (closes #5332) #5333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f5c3893
chore(docs): update grid layout docs (closes #5332)
tmorehouse May 8, 2020
ad539c0
Update package.json
tmorehouse May 8, 2020
77ffb13
Merge branch 'dev' into issue-5332
tmorehouse May 8, 2020
7807315
Update README.md
jacobmllr95 May 9, 2020
4977c78
Merge branch 'dev' into issue-5332
jacobmllr95 May 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions src/components/layout/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,8 +450,15 @@ each tier as needed. See the example below for a better idea of how it all works

Use flexbox alignment utilities to vertically and horizontally align columns.

**Note:** Internet Explorer 11 does not support vertical alignment of flex items when the flex
container has a `min-height` as shown below.
[See Flexbugs #3 for more details](https://github.com/philipwalton/flexbugs#flexbug-3).

### Vertical alignment

For vertical alignment of all grid cells in a row, use the `align-v` prop on `<b-row>`. Possible
values are `'start'`, `'center'`, `'end'`, `'baseline'`, and `'stretch'`:

```html
<b-container class="bv-example-row bv-example-row-flex-cols">
<b-row align-v="start">
Expand All @@ -471,25 +478,47 @@ Use flexbox alignment utilities to vertically and horizontally align columns.
<b-col>One of three columns</b-col>
<b-col>One of three columns</b-col>
</b-row>

<b-row align-v="baseline">
<b-col style="font-size: 0.75rem;">One of three columns</b-col>
<b-col>One of three columns</b-col>
<b-col style="font-size: 1.25rem;">One of three columns</b-col>
</b-row>

<b-row align-v="stretch">
<b-col>One of three columns</b-col>
<b-col>One of three columns</b-col>
<b-col>One of three columns</b-col>
</b-row>
</b-container>

<!-- b-grid-vertical-alignment.vue -->
```

For individual grid cell vertical alignment, use the `align-self` prop on `<b-col>`. Possible values
are `'start'`, `'center'`, `'end'`, `'baseline'`, and `'stretch'`:

```html
<b-container class="bv-example-row bv-example-row-flex-cols">
<b-row>
<b-col align-self="start">One of three columns</b-col>
<b-col align-self="center">One of three columns</b-col>
<b-col align-self="end">One of three columns</b-col>
</b-row>
<b-row>
<b-col align-self="baseline">One of two columns</b-col>
<b-col align-self="stretch">One of two columns</b-col>
</b-row>
</b-container>

<!-- b-grid-align-self.vue -->
```

### Horizontal alignment

To horizontally align grid cells within a row, use the `align-h` prop on `<b-row>`. Possible values
are: `'start'`, `'center'`, `'end'`, `'around'`, and `'between'`:

```html
<b-container class="bv-example-row">
<b-row align-h="start">
Expand Down
4 changes: 2 additions & 2 deletions src/components/layout/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
},
{
"prop": "alignV",
"description": "Vertical alignment of all columns in a row: 'start', 'center', or 'end'"
"description": "Vertical alignment of all columns in a row: 'start', 'center', 'end', 'baseline', or 'stretch'"
},
{
"prop": "alignH",
Expand Down Expand Up @@ -66,7 +66,7 @@
"props": [
{
"prop": "alignSelf",
"description": "Vertical alignment of the grid cell with respect to the row: 'start', 'center', or 'end'"
"description": "Vertical alignment of the grid cell with respect to the row: 'start', 'center', 'end', 'baseline', or 'stretch'"
},
{
"prop": "col",
Expand Down