Skip to content

Commit 96fefc6

Browse files
committed
update README
1 parent 392e3a4 commit 96fefc6

File tree

1 file changed

+32
-37
lines changed

1 file changed

+32
-37
lines changed

README.md

Lines changed: 32 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -29,51 +29,46 @@ module.exports = {
2929

3030
```html
3131
<!-- Container queries without a specific container name -->
32-
<div>
32+
<div class="@container">
3333
<!-- Container query with a size of `lg` defined in your tailwind.config.js file -->
3434
<div class="@lg:underline"></div>
35-
<div class="@[(min-width:_1024px)]:underline"></div>
3635
<div class="@[1024px]:underline"></div>
3736
</div>
3837

3938
<!-- Container queries that apply for a defined container name -->
40-
<div class="container/sidebar">
39+
<div class="@container/sidebar">
4140
<div class="@lg/sidebar:underline"></div>
42-
<div class="@[(min-width:_1024px)]/sidebar:underline"></div>
4341
<div class="@[1024px]/sidebar:underline"></div>
4442
</div>
4543
```
4644

47-
Named containers look like this:
45+
### Container types
4846

49-
```css
50-
/* `container/sidebar` results in: */
51-
.container\/sidebar {
52-
container-type: inline;
53-
container-name: sidebar;
54-
}
55-
56-
/* `container-inline/sidebar` results in: */
57-
.container-inline\/sidebar {
58-
container-type: inline;
59-
container-name: sidebar;
60-
}
61-
62-
/* `container-block/sidebar` results in: */
63-
.container-block\/sidebar {
64-
container-type: block;
65-
container-name: sidebar;
66-
}
67-
68-
/* `container-[size]/sidebar` results in: */
69-
.container-\[size\]\/sidebar {
70-
container-type: size;
71-
container-name: sidebar;
72-
}
73-
```
47+
| Class | css |
48+
| --------------------------- | ------------------------------------------------------- |
49+
| `@container` | `container-type: inline-size;` |
50+
| `@container/sidebar` | `container-type: inline-size; container-name: sidebar;` |
51+
| `@container-normal` | `container-type: normal;` |
52+
| `@container-normal/sidebar` | `container-type: inline-size; container-name: sidebar;` |
7453

7554
## Configuration
7655

56+
By default we ship with the following configured values:
57+
58+
| Name | Value |
59+
| ----- | ------- |
60+
| `xs` | `20rem` |
61+
| `sm` | `24rem` |
62+
| `md` | `28rem` |
63+
| `lg` | `32rem` |
64+
| `xl` | `36rem` |
65+
| `2xl` | `42rem` |
66+
| `3xl` | `48rem` |
67+
| `4xl` | `56rem` |
68+
| `5xl` | `64rem` |
69+
| `6xl` | `72rem` |
70+
| `7xl` | `80rem` |
71+
7772
You can configure which values are available for this plugin under the `containers` key in your `tailwind.config.js` file:
7873

7974
```js
@@ -82,14 +77,14 @@ module.exports = {
8277
theme: {
8378
extend: {
8479
containers: {
85-
xs: '(min-width: 20rem)',
86-
sm: '(min-width: 24rem)',
87-
md: '(min-width: 28rem)',
88-
lg: '(min-width: 32rem)',
89-
xl: '(min-width: 36rem)',
80+
xs: '20rem',
81+
sm: '24rem',
82+
md: '28rem',
83+
lg: '32rem',
84+
xl: '36rem',
9085
// etc...
91-
}
92-
}
86+
},
87+
},
9388
},
9489
}
9590
```

0 commit comments

Comments
 (0)