Skip to content

Commit 443aed3

Browse files
Update README.md (#95)
Updated default theme keys to DEFAULT to match tailwind 2.x configuration Co-authored-by: Robin Malfait <[email protected]>
1 parent 5136c73 commit 443aed3

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Diff for: README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -220,17 +220,17 @@ module.exports = {
220220
}
221221
```
222222

223-
Customizations should be applied to a specific modifier like `default` or `xl`, and must be added under the `css` property. Customizations are authored in the same [CSS-in-JS syntax](https://tailwindcss.com/docs/plugins#css-in-js-syntax) used to write Tailwind plugins.
223+
Customizations should be applied to a specific modifier like `DEFAULT` or `xl`, and must be added under the `css` property. Customizations are authored in the same [CSS-in-JS syntax](https://tailwindcss.com/docs/plugins#css-in-js-syntax) used to write Tailwind plugins.
224224

225225
It's important to note that all customizations are **merged** with the defaults. If you'd like to completely override a provided size modifier, you can do so by disabling that modifier so the default styles are not included.
226226

227227
See [the default styles](./src/styles.js) for this plugin for more in-depth examples of configuring each modifier.
228228

229229
### Customizing shared styles
230230

231-
Many styles _(for example colors, font weight, and text decoration)_ are shared between all size modifiers, and are therefore defined only for the `default` modifier, since modifiers are designed to be used with the [multi-class modifier pattern](http://nicolasgallagher.com/about-html-semantics-front-end-architecture/#component-modifiers).
231+
Many styles _(for example colors, font weight, and text decoration)_ are shared between all size modifiers, and are therefore defined only for the `DEFAULT` modifier, since modifiers are designed to be used with the [multi-class modifier pattern](http://nicolasgallagher.com/about-html-semantics-front-end-architecture/#component-modifiers).
232232

233-
If you'd like to customize these sorts of styles, do so using the `default` modifier:
233+
If you'd like to customize these sorts of styles, do so using the `DEFAULT` modifier:
234234

235235
```js
236236
// tailwind.config.js
@@ -326,7 +326,7 @@ module.exports = {
326326

327327
This option acts as a _safelist_, so you can list only the modifiers you'd actually like included and the others will be removed.
328328

329-
The `default` modifier is always included and cannot be disabled.
329+
The `DEFAULT` modifier is always included and cannot be disabled.
330330

331331
### Disabling responsive variants
332332

0 commit comments

Comments
 (0)