diff --git a/packages/react/public/switch-theme.gif b/packages/react/public/switch-theme.gif new file mode 100644 index 0000000..7c5b9af Binary files /dev/null and b/packages/react/public/switch-theme.gif differ diff --git a/packages/react/src/docs/theming.mdx b/packages/react/src/docs/theming.mdx new file mode 100644 index 0000000..eb16c49 --- /dev/null +++ b/packages/react/src/docs/theming.mdx @@ -0,0 +1,133 @@ +import { Canvas, Meta, Story, Source, ArgsTable } from '@storybook/addon-docs'; + + + +# Theming + +Cunningham has a built-in theming feature available. You can customize themes already provided or add your own themes ! + +## Included themes + +Cunningham natively has a `default` theme ( aka light theme ) and a `dark` theme. + +You can switch between these two themes by clicking on the button in the top-bar and visualize all the components in their +different versions. ✨ + +
+ +
+ +## Code implementation + +No panic it's easy. You can switch the current theme by using the prop `theme` of `CunninghamProvider`, here is an example +with a `MyApp` component. + + { + const [theme, setTheme] = useState("default"); + return ( + + + + ); +}; + +`}> + +> You can find a fully working example [here](https://github.com/openfun/cunningham/blob/main/apps/demo/src/App.tsx) in the demo app. + +## What about CSS variables ? + +It's seamless ! You can still use variables in CSS like this + + + +The variable will be automatically switched across the DOM when switching theme via `CunninghamProvider`. + +## Customizing themes + +As you have see in the previous sections you can customize the design tokens by editing `cunningham.ts`, you may have noticed +that in all the examples you had to wrap the modifications inside the following fields: + + + +In reality in this case you are editing the theme called `default` ( which refer to the light theme ), if you want to edit +the dark theme you have to provide the `dark` key accordingly + + + +## Creating your theme + +The logic is the same as what we saw previously. Just add a new key inside the `themes` object. + +> ⚠️ All themes extends the `default` theme by default, that's why it is named `default` and not `light`. A consequence is that you don't have to provide all existing design tokens when creating a new theme, you can just customize the one you want. + +