docs: Theming guide #1413
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| --- | ||
| title: OnchainKit Themes · OnchainKit | ||
| description: Customize the appearance of OnchainKit's components | ||
| --- | ||
|
|
||
| # OnchainKit Themes | ||
| {/* <img alt="Themes" | ||
| src="" | ||
| height="364"/> */} | ||
|
|
||
| ## Overview | ||
|
|
||
| OnchainKit provides flexible appearance control through two main features: `mode` and `theme`. | ||
|
|
||
| - **Mode**: Controls the light/dark appearance and includes an auto option that inherits the system preference. | ||
| - **Theme**: Governs the overall styling across components. | ||
|
|
||
| You can choose from built-in themes or dynamically switch modes based on user preference or system settings, allowing for a customized and responsive user interface. | ||
|
|
||
| ## Built-in Themes | ||
|
|
||
| OnchainKit offers multiple themes to quickly style your components. Set the theme via the `OnchainKitProvider` using `config.appearance.theme`: | ||
|
|
||
| - `default`: Includes both light and dark modes. | ||
| - `base`: Single mode only. | ||
| - `cyberpunk`: Single mode only. | ||
| - `hacker`: Single mode only. | ||
|
|
||
| If no theme is selected, the **`default`** theme is applied automatically. | ||
|
|
||
| ```tsx twoslash | ||
| // @noErrors: 2304 17008 1005 | ||
| <OnchainKitProvider | ||
| apiKey={process.env.NEXT_PUBLIC_ONCHAINKIT_API_KEY} | ||
| chain={base} | ||
| config={{ // [!code focus] | ||
| appearance: { // [!code focus] | ||
| mode: 'auto', // 'auto' | 'light' | 'dark' | ||
| theme: 'default', // 'default' | 'base' | 'cyberpunk' | 'hacker' // [!code focus] | ||
| }, // [!code focus] | ||
| }} // [!code focus] | ||
| > | ||
| ``` | ||
|
|
||
| ## Mode | ||
|
|
||
| Control the color scheme by setting the `config.appearance.mode` property of the `OnchainKitProvider`: | ||
|
|
||
| - `auto`: Automatically switches between light and dark mode based on the user’s OS preference. | ||
| - `light`: Forces all components to use the light version of the theme. | ||
| - `dark`: Forces all components to use the dark version of the theme. | ||
|
|
||
| If no mode is specified, `auto` mode will be applied by default. | ||
|
|
||
| ```tsx twoslash | ||
| // @noErrors: 2304 17008 1005 | ||
| <OnchainKitProvider | ||
| apiKey={process.env.NEXT_PUBLIC_ONCHAINKIT_API_KEY} | ||
| chain={base} | ||
| config={{ | ||
| appearance: { | ||
| mode: 'auto', // 'auto' | 'light' | 'dark' // [!code focus] | ||
| theme: 'default', // 'default' | 'base' | 'cyberpunk' | 'hacker' | ||
| }, | ||
| }} | ||
| > | ||
| ``` | ||
|
|
||
| ## CSS Overrides | ||
|
|
||
| You can further customize the appearance by overriding CSS styles. This allows for fine-tuning the look of individual components beyond the provided themes. | ||
|
|
||
| ```css | ||
| @layer base { | ||
| :root | ||
| .default-light, | ||
| .default-dark, | ||
| .base, | ||
| .cyberpunk, | ||
| .hacker { | ||
| --ock-font-family: 'your-custom-value'; | ||
| --ock-border-radius: 'your-custom-value'; | ||
| --ock-border-radius-inner: 'your-custom-value'; | ||
| --ock-text-inverse: 'your-custom-value'; | ||
| --ock-text-foreground: 'your-custom-value'; | ||
| --ock-text-foreground-muted: 'your-custom-value'; | ||
| --ock-text-error: 'your-custom-value'; | ||
| --ock-text-primary: 'your-custom-value'; | ||
| --ock-text-success: 'your-custom-value'; | ||
| --ock-text-warning: 'your-custom-value'; | ||
| --ock-text-disabled: 'your-custom-value'; | ||
|
|
||
| --ock-bg-default: 'your-custom-value'; | ||
| --ock-bg-default-hover: 'your-custom-value'; | ||
| --ock-bg-default-active: 'your-custom-value'; | ||
| --ock-bg-alternate: 'your-custom-value'; | ||
| --ock-bg-alternate-hover: 'your-custom-value'; | ||
| --ock-bg-alternate-active: 'your-custom-value'; | ||
| --ock-bg-inverse: 'your-custom-value'; | ||
| --ock-bg-inverse-hover: 'your-custom-value'; | ||
| --ock-bg-inverse-active: 'your-custom-value'; | ||
| --ock-bg-primary: 'your-custom-value'; | ||
| --ock-bg-primary-hover: 'your-custom-value'; | ||
| --ock-bg-primary-active: 'your-custom-value'; | ||
| --ock-bg-primary-washed: 'your-custom-value'; | ||
| --ock-bg-primary-disabled: 'your-custom-value'; | ||
| --ock-bg-secondary: 'your-custom-value'; | ||
| --ock-bg-secondary-hover: 'your-custom-value'; | ||
| --ock-bg-secondary-active: 'your-custom-value'; | ||
| --ock-bg-error: 'your-custom-value'; | ||
| --ock-bg-warning: 'your-custom-value'; | ||
| --ock-bg-success: 'your-custom-value'; | ||
| --ock-bg-default-reverse: 'your-custom-value'; | ||
|
|
||
| --ock-icon-color-primary: 'your-custom-value'; | ||
| --ock-icon-color-foreground: 'your-custom-value'; | ||
| --ock-icon-color-foreground-muted: 'your-custom-value'; | ||
| --ock-icon-color-inverse: 'your-custom-value'; | ||
| --ock-icon-color-error: 'your-custom-value'; | ||
| --ock-icon-color-success: 'your-custom-value'; | ||
| --ock-icon-color-warning: 'your-custom-value'; | ||
|
|
||
| --ock-line-primary: 'your-custom-value'; | ||
| --ock-line-default: 'your-custom-value'; | ||
| --ock-line-heavy: 'your-custom-value'; | ||
| --ock-line-inverse: 'your-custom-value'; | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo fix