Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update getting started guide and sandbox example for custom theme usage #944

Merged
merged 1 commit into from
Nov 12, 2024
Merged

docs: update getting started guide and sandbox example for custom theme usage #944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 67 additions & 24 deletions packages/react-docs/pages/getting-started/usage/index.page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,30 @@ import {
theme, // [optional] Required only for customizing the theme
} from '@tonic-ui/react';

// Enable CSS variables
theme.config.useCSSVariables = true;

function App(props) {
const customTheme = {
...theme,
// Set default props for specific components
//
// Example:
// ```js
// components: {
// 'ToastCloseButton': {
// defaultProps: {
// 'aria-label': 'Close toast',
// },
// },
// }
// ```
components: {},
// Enable CSS variables
config: {
...theme?.config,
useCSSVariables: true,
},
};
};

return (
<TonicProvider
colorMode={{
Expand All @@ -29,7 +49,7 @@ function App(props) {
colorStyle={{
defaultValue: colorStyle, // Custom color style
}}
theme={theme}
theme={customTheme}
useCSSBaseline={true} // If `true`, apply CSS reset and base styles
>
<Box {...props} />
Expand All @@ -54,10 +74,30 @@ import {
useTheme,
} from '@tonic-ui/react';

// Enable CSS variables
theme.config.useCSSVariables = true;

function App(props) {
const customTheme = {
...theme,
// Set default props for specific components
//
// Example:
// ```js
// components: {
// 'ToastCloseButton': {
// defaultProps: {
// 'aria-label': 'Close toast',
// },
// },
// }
// ```
components: {},
// Enable CSS variables
config: {
...theme?.config,
useCSSVariables: true,
},
};
};

return (
<TonicProvider
colorMode={{
Expand All @@ -66,7 +106,7 @@ function App(props) {
colorStyle={{
defaultValue: colorStyle, // Custom color style
}}
theme={theme}
theme={customTheme}
useCSSBaseline={true} // If `true`, apply CSS reset and base styles
>
<ToastManager
Expand Down Expand Up @@ -180,24 +220,26 @@ Sometimes you may need to apply base CSS styles to your application. Tonic UI pr
Tonic UI supports converting theme tokens defined in the theme to CSS variables. You can enable this behavior by configuring the theme as shown below:

```jsx
import { TonicProvider, theme } from '@tonic-ui/react';

// Enable CSS variables
theme.config.useCSSVariables = true;

// Pass `theme` to `TonicProvider`
<TonicProvider theme={theme} />
<TonicProvider
theme={{
...theme,
config: {
...theme?.config,
useCSSVariables: true,
},
}}
/>
```

For example, consider a theme object that looks like this:

```js disabled
const theme = {
```js
{
colors: {
'gray:10': '#fafafa',
'gray:20': '#f7f7f7',
},
};
}
```

When this theme is passed to `TonicProvider`, Tonic UI will generate CSS variables automatically, as shown below:
Expand Down Expand Up @@ -270,7 +312,7 @@ const customColorStyle = {
colorStyle={{
defaultValue: customColorStyle,
}}
theme={theme}
theme={customTheme}
useCSSBaseline={true}
>
{children}
Expand All @@ -296,14 +338,15 @@ Override the theme object and pass it to the `<ThemeProvider>` component.
```js
import { theme } from '@tonic-ui/react';

// Enable CSS variables
theme.config.useCSSVariables = true;

// Let's say you want to add more colors
const customTheme = {
...theme,
config: {
...theme?.config,
useCSSVariables: true,
},
colors: {
...theme.colors,
...theme?.colors,
brand: {
90: "#1a365d",
80: "#153e75",
Expand All @@ -315,7 +358,7 @@ const customTheme = {

#### 2. Setting up the provider

```jsx disabled
```jsx
<TonicProvider theme={customTheme}>
{children}
</TonicProvider>
Expand Down
67 changes: 44 additions & 23 deletions packages/react-docs/sandbox/create-react-app.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,29 +77,50 @@ const customColorStyle = {
},
};

// Enable CSS variables
theme.config.useCSSVariables = true;

const Root = (props) => (
<TonicProvider
colorMode={{
defaultValue: 'dark',
}}
colorStyle={{
defaultValue: customColorStyle,
}}
theme={theme}
useCSSBaseline={true}
>
<PortalManager>
<ToastManager>
<Layout>
<Box {...props} />
</Layout>
</ToastManager>
</PortalManager>
</TonicProvider>
);
const Root = (props) => {
const customTheme = {
...theme,
// Set default props for specific components
//
// Example:
// \`\`\`js
// components: {
// 'ToastCloseButton': {
// defaultProps: {
// 'aria-label': 'Close toast',
// },
// },
// }
// \`\`\`
components: {},
// Enable CSS variables
config: {
...theme?.config,
useCSSVariables: true,
},
};

return (
<TonicProvider
colorMode={{
defaultValue: 'dark',
}}
colorStyle={{
defaultValue: customColorStyle,
}}
theme={customTheme}
useCSSBaseline={true}
>
<PortalManager>
<ToastManager>
<Layout>
<Box {...props} />
</Layout>
</ToastManager>
</PortalManager>
</TonicProvider>
);
};

const Layout = (props) => {
const [colorMode] = useColorMode();
Expand Down
Loading