@chakra-xui/props-docs v1.0.6

Chakra xui provides a set of accessible, reusable, and composable React components that make it super easy to create websites and apps.

Looking for the documentation? 📝

For older versions, head over here => https://v0.chakra-xui.com

Latest version (v1) => https://chakra-xui.com

Features 🚀

• Ease of Styling: Chakra xui contains a set of layout components like Box and Stack that make it easy to style your components by passing props. Learn more
• Flexible & composable: Chakra xui components are built on top of a React UI Primitive for endless composability.
• Accessible. Chakra xui components follow the WAI-ARIA guidelines specifications and have the right aria-* attributes.
• Dark Mode 😍: Most components in Chakra xui are dark mode compatible.

Support Chakra xui 💖

By donating \$5 or more you can support the ongoing development of this project. We'll appreciate some support. Thank you to all our supporters! 🙏 [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

Testimonials

People throw React component libraries and design systems at me regularly. This might be the best one I've seen. The APIs are simple but composable and the accessibility on the couple components I looked is complete.

Great work @thesegunadebayo, really inspiring work. – Ryan Florence

Awesome new open-source component library from @thesegunadebayo. Really impressive stuff! – Colm Tuite

This is incredible work. Amazing job Segun! – Lee Robinson

Chakra xui is glorious! I love the consistent use of focus styling and the subtle animation – Guillermo ▲

Installing Chakra xui

To use Chakra xui components, all you need to do is install the @chakra-xui/react package and its peer dependencies:

$ yarn add @chakra-xui/react framer-motion

# or

$ npm install @chakra-xui/react framer-motion

Usage

To start using the components, please follow these steps:

1. Wrap your application with the ChakraProvider provided by @chakra-xui/react.

import { ChakraProvider } from "@chakra-xui/react"

// Do this at the root of your application
function App({ children }) {
  return <ChakraProvider>{children}</ChakraProvider>
}

Optionally, you can wrap your application with the ColorModeProvider so you can toggle between light and dark mode within your app.

2. Now you can start using components like so!:

import { Button } from "@chakra-xui/react"

function Example() {
  return <Button>I just consumed some ⚡️Chakra!</Button>
}

CodeSandbox Templates

• JavaScript Starter: https://codesandbox.io/s/chakra-xui-javascript-lzzg9
• TypeScript Starter: https://codesandbox.io/s/chakra-xui-typescript-pomi8

create-react-app Templates

Check out our guide for information on how to use our official create-react-app templates.

Contributing

Feel like contributing? That's awesome! We have a contributing guide to help guide you.

Contributors ✨

Thanks goes to these wonderful people

(emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Testing supported by

License

MIT © Segun Adebayo