Skip to content

Commit bd9691c

Browse files
treborFil
andauthored
add grid class documentation (#559)
* add grid doc * change how example code is rendered * remove word salid * improve advice * fix capitolization * Update docs/layout/grid.md Co-authored-by: Philippe Rivière <[email protected]> * Update docs/layout/grid.md Co-authored-by: Philippe Rivière <[email protected]> * Update docs/layout/grid.md Co-authored-by: Philippe Rivière <[email protected]> * Update docs/layout/grid.md Co-authored-by: Philippe Rivière <[email protected]> * remove overshare --------- Co-authored-by: Philippe Rivière <[email protected]>
1 parent 3b6e75b commit bd9691c

File tree

1 file changed

+104
-0
lines changed

1 file changed

+104
-0
lines changed

docs/layout/grid.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
toc: false
3+
theme: dashboard
4+
---
5+
6+
# Layout: grid
7+
8+
The CLI provides a set of grid CSS classes to help layout page content. These grids pair well with the [dashboard](./themes#dashboard) theme and the [card](./card) class. This page uses both.
9+
10+
To see these examples change dynamically, adjust the page width or collapse the sidebar on the left.
11+
12+
## Classes
13+
14+
The following CSS classes are provided for grid layouts:
15+
16+
Class | Description
17+
---------------- | ------------
18+
`grid` | specify a grid layout for an element
19+
`grid-cols-2` | restrict grid to two columns
20+
`grid-cols-3` | restrict grid to three columns
21+
`grid-cols-4` | restrict grid to four columns
22+
`grid-colspan-2` | specify that a grid cell spans two columns
23+
`grid-colspan-3` | specify that a grid cell spans three columns
24+
`grid-colspan-4` | specify that a grid cell spans four columns
25+
`grid-rowspan-2` | specify that a grid cell spans two rows
26+
`grid-rowspan-3` | specify that a grid cell spans three rows
27+
`grid-rowspan-4` | specify that a grid cell spans four rows
28+
29+
30+
## Two column grid
31+
32+
<div class="grid grid-cols-2">
33+
<div class="card"><h1>A</h1>1 × 1</div>
34+
<div class="card grid-rowspan-2"><h1>B</h1> 1 × 2</div>
35+
<div class="card"><h1>C</h1>1 × 1</div>
36+
<div class="card grid-colspan-2"><h1>D</h1>1 × 2</div>
37+
<div class="card grid-colspan-2 grid-rowspan-2"><h1>E</h1>2 × 2</div>
38+
</div>
39+
40+
```html run=false
41+
<div class="grid grid-cols-2">
42+
<div class="card"><h1>A</h1>1 × 1</div>
43+
<div class="card grid-rowspan-2"><h1>B</h1> 1 × 2</div>
44+
<div class="card"><h1>C</h1>1 × 1</div>
45+
<div class="card grid-colspan-2"><h1>D</h1>1 × 2</div>
46+
<div class="card grid-colspan-2 grid-rowspan-2"><h1>E</h1>2 × 2</div>
47+
</div>
48+
```
49+
50+
## Four column grid
51+
52+
<div class="grid grid-cols-4">
53+
<div class="card"><h1>A</h1>1 × 1</div>
54+
<div class="card"><h1>B</h1>1 × 1</div>
55+
<div class="card"><h1>C</h1>1 × 1</div>
56+
<div class="card"><h1>D</h1>1 × 1</div>
57+
<div class="card grid-colspan-3 grid-rowspan-2"><h1>E</h1>3 × 2</div>
58+
<div class="card grid-rowspan-2"><h1>F</h1>1 × 2</div>
59+
<div class="card grid-colspan-2"><h1>G</h1>2 × 1</div>
60+
<div class="card grid-colspan-2"><h1>H</h1>2 × 1</div>
61+
</div>
62+
63+
```html run=false
64+
<div class="grid grid-cols-4">
65+
<div class="card"><h1>A</h1>1 × 1</div>
66+
<div class="card"><h1>B</h1>1 × 1</div>
67+
<div class="card"><h1>C</h1>1 × 1</div>
68+
<div class="card"><h1>D</h1>1 × 1</div>
69+
<div class="card grid-colspan-3 grid-rowspan-2"><h1>E</h1>3 × 2</div>
70+
<div class="card grid-rowspan-2"><h1>F</h1>1 × 2</div>
71+
<div class="card grid-colspan-2"><h1>G</h1>2 × 1</div>
72+
<div class="card grid-colspan-2"><h1>H</h1>2 × 1</div>
73+
</div>
74+
```
75+
76+
## Three column grid with customizations
77+
78+
Note that the minimum row height is set to 150px, and cell **D** does not use the `card` class.
79+
80+
<div
81+
class="grid grid-cols-3"
82+
style="grid-auto-rows: minmax(150px, auto); color: red;"
83+
>
84+
<div class="card"><h1>A</h1>1 × 1</div>
85+
<div class="card"><h1>B</h1>1 × 1</div>
86+
<div class="card"><h1>C</h1>1 × 1</div>
87+
<div class="grid-rowspan-2"><h1>D</h1>1 × 2</div>
88+
<div class="card grid-colspan-2"><h1>E</h1>2 × 1</div>
89+
<div class="card grid-colspan-2"><h1>F</h1>2 × 1</div>
90+
</div>
91+
92+
```html run=false
93+
<div
94+
class="grid grid-cols-3"
95+
style="grid-auto-rows: minmax(150px, auto); color: red;"
96+
>
97+
<div class="card"><h1>A</h1>1 × 1</div>
98+
<div class="card"><h1>B</h1>1 × 1</div>
99+
<div class="card"><h1>C</h1>1 × 1</div>
100+
<div class="grid-rowspan-2"><h1>D</h1>1 × 2</div>
101+
<div class="card grid-colspan-2"><h1>E</h1>2 × 1</div>
102+
<div class="card grid-colspan-2"><h1>F</h1>2 × 1</div>
103+
</div>
104+
```

0 commit comments

Comments
 (0)