Skip to content
This repository was archived by the owner on Sep 20, 2024. It is now read-only.

Commit 459ac06

Browse files
committed
docs(theme): add config info to docs
1 parent 788fc25 commit 459ac06

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

website/pages/theme.mdx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,4 +252,26 @@ export default {
252252
tooltip: 1800,
253253
},
254254
};
255+
```
256+
257+
## Config
258+
259+
The theme's config is to provide global settings that are used by different
260+
parts of the Chakra UI system.
261+
262+
| Property | Description | Default |
263+
| ------------------------- | ----------------------------------------------------------------------------------------------------------- | -------- |
264+
| `cssVarPrefix` | The prefix to use for the generated CSS custom properties | `chakra` |
265+
| `initialColorMode` | The initial color mode your application should start with. <br reset/> Can be either `light` or `dark` mode | `light` |
266+
| `useSystemColorMode` | If `true`, the chakra system will update color mode <br reset/> based on your system preferences | `false` |
267+
268+
You can leverage the `extendTheme` function to override a specific theme config
269+
property.
270+
271+
```js
272+
export default {
273+
config: {
274+
cssVarPrefix: "ck",
275+
},
276+
};
255277
```

0 commit comments

Comments
 (0)