Skip to content

Latest commit

 

History

History
121 lines (83 loc) · 3.92 KB

README.md

File metadata and controls

121 lines (83 loc) · 3.92 KB
Raw

Welcome to Chakra UI Pro Theme

The Chakra UI Pro Theme extends the base Chakra UI theme by introducing additional component variants, sizes, and a collection of semantic tokens and text layer styles. Made to fit perfectly with the original Chakra UI theme, the Pro Theme makes your user interface look even better, and it won't mess up your current setup. Just a heads up though - if your custom variants have the same names as ours, you might see a few changes. For the best experience with the Pro Theme, you might want to check out our comparison here.

Installation

Ensure Chakra UI is installed in your project. If not, you can follow the installation guide on Chakra UI's website. To install Chakra UI Pro Theme, you can use yarn:

yarn add install @chakra-ui/pro-theme

Alternatively, if you prefer using npm:

npm install @chakra-ui/pro-theme

Setting up the Pro Theme

Setting up the Pro Theme is a straightforward process.

1. Import Required Themes

Firstly, you'll need to import the theme from the pro theme package nd the extendTheme function provided by Chakra UI. Use the following code snippet:

import { theme } from '@chakra-ui/pro-theme'
import { extendTheme, ChakraProvider } from '@chakra-ui/react'

2. Create the Extended Theme

Next, create a new theme that combines the Pro Theme with your custom settings.

const proTheme = extendTheme(theme)
const extendedConfig = {
  colors: { ...proTheme.colors, brand: proTheme.colors.teal },
}
const myTheme = extendTheme(extendedConfig, proTheme)

3. Integrate your Theme in Your Application

Finally, wrap your application within the ChakraProvider and apply the custom theme.

return (
  <ChakraProvider theme={myTheme}>
    <App />
  </ChakraProvider>
)

Font Configuration

Chakra UI Pro Theme uses Spline Sans as heading font family and Open Sans as body font family by default. To include this, first, you need to install the font:

yarn add @fontsource-variable/spline-sans @fontsource-variable/open-sans

Then, you can import it in your theme setup:

import '@fontsource-variable/open-sans'
import '@fontsource-variable/spline-sans'

Note: Depending on the platform/framework, the best way to install fonts may differ.

Using a Different Font

To use a different font, such as Inter, you first need to install the font:

yarn add @fontsource-variable/inter

Then, import the font and adjust the fonts key in your theme configuration:

import { theme } from '@chakra-ui/pro-theme'
import { extendTheme } from '@chakra-ui/react'
import '@fontsource-variable/inter'

const proTheme = extendTheme(theme)
const extenstion = {
  colors: { ...proTheme.colors, brand: proTheme.colors.teal },
  fonts: {
    heading: "'Inter Variable', -apple-system, system-ui, sans-serif",
    body: "'Inter Variable', -apple-system, system-ui, sans-serif",
  },
}
const myTheme = extendTheme(extenstion, proTheme)

Generating Theme Typings

With Chakra UI Pro Theme, you can enhance your development experience by generating theme typings. This makes the theme tokens used in the Pro Theme available to your IDE's intellisense, aiding in faster and more accurate development.

To generate the theme typings, follow these steps:

First, install the Chakra CLI as a dev dependency:

yarn add --dev @chakra-ui/cli

Next, generate the theme typings using the following command. Replace './path-to-theme.ts' with the actual path to your theme file:

yarn chakra-cli tokens ./path-to-theme.ts

Once this is completed, you may need to "Restart the TS Server" in VSCode to see the changes.

For further information about the Chakra CLI and theme typings, check out the Chakra CLI documentation.