@chakra-xui/gatsby-plugin

Gatsby plugin for adding Chakra xui

Installation

⚡ To use Chakra xui in your Gatsby site, you need to install the plugin and its peer dependencies.

npm i @chakra-xui/gatsby-plugin @chakra-xui/react @emotion/react @emotion/styled framer-motion

# or

yarn add @chakra-xui/gatsby-plugin @chakra-xui/react @emotion/react @emotion/styled framer-motion

Usage

1. Add @chakra-xui/gatsby-plugin as a plugin in your Gatsby config.

// gatsby-config.js
module.exports = {
  plugins: ["@chakra-xui/gatsby-plugin"],
}

2. Use Chakra ⚡

// src/pages/index.js
import React from "react"
import { Box, Text } from "@chakra-xui/react"

function IndexPage() {
  return (
    <Box p={8}>
      <Text fontSize="xl">Hello World</Text>
    </Box>
  )
}

export default IndexPage

Plugin options

By default, this plugin adds a couple of context providers to make all components work correctly.

• ThemeProvider: To provide the theme context to all components.
• ColorModeProvider: To provide the current preferred color mode stored in localStorage
• GlobalStyles: To add global styles defined in theme.styles.global
• CSSReset: To add browser reset styles
• PortalManager: To manage portals used by modal, popover, etc

<ThemeProvider theme={theme}>
  <ColorModeProvider>
    <GlobalStyle />
    {isResettingCSS && <CSSReset />}
    <PortalManager zIndex={portalZIndex}>{element}</PortalManager>
  </ColorModeProvider>
</ThemeProvider>

You can disable either of these with Gatsby options:

// gatsby-config.js
module.exports = {
  plugins: [
    {
      resolve: "@chakra-xui/gatsby-plugin",
      options: {
        /**
         * @property {boolean} [isResettingCSS=true]
         * if `false`, this plugin will not use `<CSSReset />
         */
        isResettingCSS: true,
        /**
         * @property {boolean} [isUsingColorMode=true]
         * if `false`, this plugin will not use <ColorModeProvider />
         */
        isUsingColorMode: true,
        /**
         * @property {number} [portalZIndex=40]
         * The z-index to apply to all portal nodes. This is useful
         * if your app uses a lot z-index to position elements.
         */
        portalZIndex: 40,
      },
    },
  ],
}

Customizing the theme

To use customize the theme in your Gatsby site, you can shadow the plugin's src/@chakra-xui/gatsby-plugin/theme.js file with your own theme:

// src/@chakra-xui/gatsby-plugin/theme.js
const theme = {}

export default theme

You can learn more about custom theme at Chakra xui's documentation.

By default, Chakra provides a sensible default theme inspired by Tailwind CSS.