Skip to content

Commit 9d53be2

Browse files
committed
Docs: Enhance grid documentation with basic usage examples for grid-auto-columns, grid-auto-flow, grid-auto-rows, grid-column, grid-columns, grid-row, grid-rows, grid-template-areas, grid-template-columns, grid-template-rows, and grid-template. Update syntaxes for improved clarity and accuracy. Resolved #190
1 parent 8384fa0 commit 9d53be2

21 files changed

Lines changed: 293 additions & 56 deletions

File tree

‎site/app/[locale]/reference/grid-auto-columns/content.mdx‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,32 @@
11
## Overview [sr-only]
22
<Overview/>
33

4+
## Basic usage
5+
### Size implicit columns
6+
Use `grid-auto-columns` to size columns created outside the explicit grid.
7+
<Demo $py={0}>
8+
<DemoPanel>
9+
<div className="grid grid-flow:column grid-auto-cols:96px gap:2x overflow:auto">
10+
<div className="min-w:0 p:3x r:8 bg:blue-5 bg:blue-95@dark border:1|solid|blue-20 border-color:blue-80@dark text:center">
11+
<div className="fg:blue-60 font:11 font-weight:700 text:ellipsis overflow:hidden white-space:nowrap">96px</div>
12+
<div className="fg:strong font:14 font-weight:560">A</div>
13+
</div>
14+
<div className="min-w:0 p:3x r:8 bg:gray-5 bg:gray-90@dark text:center">B</div>
15+
<div className="min-w:0 p:3x r:8 bg:gray-5 bg:gray-90@dark text:center">C</div>
16+
</div>
17+
</DemoPanel>
18+
</Demo>
19+
```html
20+
<div class="grid grid-flow:column">
21+
<!-- @MARK grid-auto-cols:96px -->
22+
<div class="grid-auto-cols:96px">A</div>
23+
<div>B</div>
24+
<div>C</div>
25+
</div>
26+
```
27+
428
### Apply conditionally
529
Apply styles based on different states using [selectors](/guide/state-selectors) and [conditional queries](/guide/conditional-queries).
630
```html
7-
<div class="grid-auto-columns:auto:hover grid-auto-columns:auto@sm grid-auto-columns:auto@dark grid-auto-columns:auto@print">…</div>
31+
<div class="grid-auto-cols:96px:hover grid-auto-cols:96px@sm grid-auto-cols:96px@dark grid-auto-cols:96px@print">…</div>
832
```
9-

‎site/app/[locale]/reference/grid-auto-columns/syntaxes.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ const syntaxes = [
22
['grid-auto-cols:`value`'],
33
['grid-auto-cols:minmax(`min`,`max`)'],
44
'grid-auto-cols:auto',
5-
'grid-auto-cols:min',
6-
'grid-auto-cols:max',
5+
'grid-auto-cols:min-content',
6+
'grid-auto-cols:max-content',
77
]
88

9-
export default syntaxes
9+
export default syntaxes

‎site/app/[locale]/reference/grid-auto-flow/content.mdx‎

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,38 @@
11
## Overview [sr-only]
22
<Overview/>
33

4+
## Basic usage
5+
### Fill by column
6+
Use `grid-auto-flow` to control how auto-placed grid items flow into the grid.
7+
<Demo $py={0}>
8+
<DemoPanel>
9+
<div className="grid grid-template-rows:56px|56px grid-auto-flow:column gap:2x">
10+
<div className="min-w:0 p:3x r:8 bg:blue-5 bg:blue-95@dark border:1|solid|blue-20 border-color:blue-80@dark text:center">1</div>
11+
<div className="min-w:0 p:3x r:8 bg:gray-5 bg:gray-90@dark text:center">2</div>
12+
<div className="min-w:0 p:3x r:8 bg:gray-5 bg:gray-90@dark text:center">3</div>
13+
<div className="min-w:0 p:3x r:8 bg:gray-5 bg:gray-90@dark text:center">4</div>
14+
</div>
15+
</DemoPanel>
16+
</Demo>
17+
```html
18+
<!-- @MARK grid-auto-flow:column -->
19+
<div class="grid grid-template-rows:56px|56px grid-auto-flow:column">
20+
<div>1</div>
21+
<div>2</div>
22+
<div>3</div>
23+
<div>4</div>
24+
</div>
25+
```
26+
27+
### Fill gaps densely
28+
Use `dense` to let later items fill earlier holes when possible.
29+
```html
30+
<!-- @MARK grid-auto-flow:row|dense -->
31+
<div class="grid grid-auto-flow:row|dense">…</div>
32+
```
33+
434
### Apply conditionally
535
Apply styles based on different states using [selectors](/guide/state-selectors) and [conditional queries](/guide/conditional-queries).
636
```html
7-
<div class="grid-auto-flow:row:hover grid-auto-flow:row@sm grid-auto-flow:row@dark grid-auto-flow:row@print">…</div>
37+
<div class="grid-auto-flow:column:hover grid-auto-flow:column@sm grid-auto-flow:column@dark grid-auto-flow:column@print">…</div>
838
```
9-
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
const syntaxes = [
2-
['grid-auto-flow:`value`'],
32
'grid-auto-flow:row',
43
'grid-auto-flow:column',
54
'grid-auto-flow:dense',
65
'grid-auto-flow:row|dense',
76
'grid-auto-flow:column|dense',
87
]
98

10-
export default syntaxes
9+
export default syntaxes

‎site/app/[locale]/reference/grid-auto-rows/content.mdx‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,30 @@
11
## Overview [sr-only]
22
<Overview/>
33

4+
## Basic usage
5+
### Size implicit rows
6+
Use `grid-auto-rows` to size rows created outside the explicit grid.
7+
<Demo $py={0}>
8+
<DemoPanel>
9+
<div className="grid grid-cols:2 grid-auto-rows:64px gap:2x">
10+
<div className="min-w:0 p:3x r:8 bg:blue-5 bg:blue-95@dark border:1|solid|blue-20 border-color:blue-80@dark">
11+
<div className="fg:blue-60 font:11 font-weight:700 text:ellipsis overflow:hidden white-space:nowrap">64px row</div>
12+
<div className="fg:strong font:14 font-weight:560">A</div>
13+
</div>
14+
<div className="min-w:0 p:3x r:8 bg:gray-5 bg:gray-90@dark">B</div>
15+
<div className="min-w:0 p:3x r:8 bg:gray-5 bg:gray-90@dark">C</div>
16+
</div>
17+
</DemoPanel>
18+
</Demo>
19+
```html
20+
<!-- @MARK grid-auto-rows:64px -->
21+
<div class="grid grid-cols:2 grid-auto-rows:64px">
22+
<div>A</div><div>B</div><div>C</div>
23+
</div>
24+
```
25+
426
### Apply conditionally
527
Apply styles based on different states using [selectors](/guide/state-selectors) and [conditional queries](/guide/conditional-queries).
628
```html
7-
<div class="grid-auto-rows:min:hover grid-auto-rows:min@sm grid-auto-rows:min@dark grid-auto-rows:min@print">…</div>
29+
<div class="grid-auto-rows:64px:hover grid-auto-rows:64px@sm grid-auto-rows:64px@dark grid-auto-rows:64px@print">…</div>
830
```
9-
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
const syntaxes = [
22
['grid-auto-rows:`value`'],
33
'grid-auto-rows:auto',
4-
'grid-auto-rows:min',
5-
'grid-auto-rows:max',
4+
'grid-auto-rows:min-content',
5+
'grid-auto-rows:max-content',
66
['grid-auto-rows:minmax(`min`,`max`)'],
77
]
88

9-
export default syntaxes
9+
export default syntaxes

‎site/app/[locale]/reference/grid-column/content.mdx‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,32 @@
11
## Overview [sr-only]
22
<Overview/>
33

4+
## Basic usage
5+
### Place an item by columns
6+
Use `grid-column` to place an item between column grid lines.
7+
<Demo $py={0}>
8+
<DemoPanel>
9+
<div className="grid grid-cols:4 grid-template-rows:64px gap:2x">
10+
<div className="grid-column:2/4 min-w:0 p:3x r:8 bg:blue-5 bg:blue-95@dark border:1|solid|blue-20 border-color:blue-80@dark">
11+
<div className="fg:blue-60 font:11 font-weight:700 text:ellipsis overflow:hidden white-space:nowrap">grid-column:2/4</div>
12+
<div className="fg:strong font:14 font-weight:560">Item</div>
13+
</div>
14+
</div>
15+
</DemoPanel>
16+
</Demo>
17+
```html
18+
<!-- @MARK grid-column:2/4 -->
19+
<div class="grid-column:2/4">Item</div>
20+
```
21+
22+
### Span columns
23+
```html
24+
<!-- @MARK grid-col-span:2 -->
25+
<div class="grid-col-span:2">Spans two columns</div>
26+
```
27+
428
### Apply conditionally
529
Apply styles based on different states using [selectors](/guide/state-selectors) and [conditional queries](/guide/conditional-queries).
630
```html
7-
<div class="grid-column:1:hover grid-column:1@sm grid-column:1@dark grid-column:1@print">…</div>
31+
<div class="grid-column:2/4:hover grid-column:2/4@sm grid-column:2/4@dark grid-column:2/4@print">…</div>
832
```
9-
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
const syntaxes = [
2-
['grid-col:`value`'],
2+
['grid-column:`value`'],
3+
['grid-column:2/4'],
34
['grid-col-span:`value`'],
45
['grid-col-start:`value`'],
56
['grid-col-end:`value`'],
67
]
78

8-
export default syntaxes
9+
export default syntaxes

‎site/app/[locale]/reference/grid-columns/content.mdx‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,27 @@
11
## Overview [sr-only]
22
<Overview/>
33

4+
## Basic usage
5+
### Create equal columns
6+
Use `grid-cols` to create an equal-width column grid. It also sets `display:grid`.
7+
<Demo $py={0}>
8+
<DemoPanel>
9+
<div className="grid-cols:3 gap:2x">
10+
<div className="min-w:0 p:3x r:8 bg:blue-5 bg:blue-95@dark border:1|solid|blue-20 border-color:blue-80@dark text:center">1</div>
11+
<div className="min-w:0 p:3x r:8 bg:gray-5 bg:gray-90@dark text:center">2</div>
12+
<div className="min-w:0 p:3x r:8 bg:gray-5 bg:gray-90@dark text:center">3</div>
13+
</div>
14+
</DemoPanel>
15+
</Demo>
16+
```html
17+
<!-- @MARK grid-cols:3 -->
18+
<div class="grid-cols:3">
19+
<div>1</div><div>2</div><div>3</div>
20+
</div>
21+
```
22+
423
### Apply conditionally
524
Apply styles based on different states using [selectors](/guide/state-selectors) and [conditional queries](/guide/conditional-queries).
625
```html
7-
<div class="grid-cols:12:hover grid-cols:12@sm grid-cols:12@dark grid-cols:12@print">…</div>
26+
<div class="grid-cols:3:hover grid-cols:3@sm grid-cols:3@dark grid-cols:3@print">…</div>
827
```
9-
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const syntaxes = [
2-
['grid-cols:`value`']
2+
['grid-cols:`count`']
33
]
44

5-
export default syntaxes
5+
export default syntaxes

0 commit comments

Comments
 (0)