From 69d414f758f991d731f84c30412e9628b79d90f0 Mon Sep 17 00:00:00 2001 From: Andrey Sitnik Date: Wed, 6 Dec 2023 15:07:42 +0100 Subject: [PATCH] Improve docs --- .../themes/docs/getting-started/postcss.md | 62 +++++++++---------- 1 file changed, 30 insertions(+), 32 deletions(-) diff --git a/code/addons/themes/docs/getting-started/postcss.md b/code/addons/themes/docs/getting-started/postcss.md index a90ae8a786ea..3748dd272a10 100644 --- a/code/addons/themes/docs/getting-started/postcss.md +++ b/code/addons/themes/docs/getting-started/postcss.md @@ -2,8 +2,6 @@ ## 📦 Install addon - - To get started, **install the package** as a dev dependency yarn: @@ -41,6 +39,36 @@ module.exports = { }; ``` +## 🏷️ Add class to `prefers-color-scheme` media + +CSS has special media at-rule for dark theme: `@media (prefers-color-scheme: dark)`. [`postcss-dark-theme-class`](https://github.com/postcss/postcss-dark-theme-class) can copy content of those at-rules to `.is-dark` selector. + +Check your project for existing PostCSS config: `postcss.config.js` in the project root, `"postcss"` section in `package.json` or postcss in bundle config. + +Add plugin to the list. + +```diff +module.exports = { + plugins: [ ++ require('postcss-dark-theme-class'), + require('autoprefixer') + ] +} +``` + +Use `prefers-color-scheme` media in your CSS: + +```css +:root { + --text-color: black; +} +@media (prefers-color-scheme: dark) { + html { + --text-color: white + } +} +``` + ## 🥾 Import your CSS To give your stories access to styles, import them into your `.storybook/preview.js` file. @@ -59,8 +87,6 @@ export default preview; ## 🎨 Provide your theme(s) -Tailwind supports light and dark color modes out of the box. These modes can be activated by setting a `.dark` class on a parent element. - To enable switching between these modes in a click for your stories, use our `withThemeByClassName` decorator by adding the following code to your `.storybook/preview.js` file. ```diff @@ -86,31 +112,3 @@ const preview: Preview = { export default preview; ``` - -## 🏷️ Add class to `prefers-color-scheme` media - -Check your project for existing PostCSS config: postcss.config.js in the project root, "postcss" section in package.json or postcss in bundle config. - -Add plugin to the list. - -```diff -module.exports = { - plugins: [ -+ require('postcss-dark-theme-class'), - require('autoprefixer') - ] -} -``` - -Use `prefers-color-scheme` media in your CSS: - -```css -:root { - --text-color: black; -} -@media (prefers-color-scheme: dark) { - html { - --text-color: white - } -} -``` \ No newline at end of file