Build Accessible React Apps with Speed

Chakra UI is a comprehensive library of accessible, reusable, and composable React components that streamlines the development of modern web applications and websites. The library offers a diverse range of components that can be easily combined to build complex user interfaces while adhering to accessibility best practices.

Table of contents

• Documentation
• Features
• Installation
• Usage
• CodeSandbox Templates
• create-react-app Templates
• Contributing
• Support
• Testimonials
• Awards and Mentions
• Contributors
• License

Documentation

It's the https://chakra-ui.com website for the latest version of Chakra UI. For older versions head over here

• v1: https://v1.chakra-ui.com
• v0: https://v0.chakra-ui.com

Features

• Ease of Styling: Chakra UI 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 UI components are built on top of a React UI Primitive for endless composability.
• Accessible. Chakra UI components follow the WAI-ARIA guidelines specifications and have the right aria-* attributes.
• Dark Mode : Most components in Chakra UI are dark mode compatible.

Installation

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

# with Yarn
$ yarn add @chakra-ui/react @emotion/react@^11 @emotion/styled@^11 framer-motion@^6

# with npm
$ npm i @chakra-ui/react @emotion/react@^11 @emotion/styled@^11 framer-motion@^6

# with pnpm
$ pnpm add @chakra-ui/react @emotion/react@^11 @emotion/styled@^11 framer-motion@^6

# with Bun
$ bun add @chakra-ui/react @emotion/react@^11 @emotion/styled@^11 framer-motion@^6

Usage

To start using the components, please follow these steps:

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

import { ChakraProvider } from "@chakra-ui/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-ui/react"

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

More guides on how to get started are available here

CodeSandbox Templates

• JavaScript Starter: https://codesandbox.io/s/chakra-ui-javascript-lzzg9
• TypeScript Starter: https://codesandbox.io/s/chakra-ui-typescript-pomi8
• NextJS TypeScript Starter: https://codesandbox.io/s/chakra-ui-next-js-typescript-kxvyr

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.

Our docsite lives in a separate repo. If you're interested in contributing to the documentation, check out the docsite contribution guide.

Support Chakra UI

Organizations

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

Individuals

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]

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 UI is glorious! I love the consistent use of focus styling and the subtle animation Guillermo

Awards and Mentions

We've been extremely humbled to receive awards and mentions from the community for all the innovation and reach Chakra UI brings to the JavaScript ecosystem.

	Solution Worth Pursuing Technology Radar (20202021)
	The Most Impactful Contribution to the community Open Source Awards (2020)

Contributors

Thanks goes to these wonderful people

Segun Adebayo	Tioluwani Kolawole	Devansh Jethmalani	Adrian Aleixandre	Lee	Kristf Poduszl	Justin Hall
Mark Chandler	Folasade Agbaje	Christian Nwamba	Jonathan Bakebwa	Alex Luong	Jesco Wster	Dusty Doris
Alex Lobera	Tommaso De Rossi	Odi	Hendrik Niemann	Matt Rothenberg	Luis Felipe Zaguini	Jean
Temitope Ajiboye	Jonathan Kim	Chris Thompson	WALTER KIMARO	Jack Leslie	Ken-Lauren Daganio	Ramon
jess	Ayelegun Kayode Michael	Tal Williams	Trevor Blades	Gord Lea	Aggelos Arvanitakis	Douglas Gabriel
Martin Nordstrm	Danny Tatom	Simon Collins	Santi Albo	PILO7980	Ishimoto Koji	Jeff Wen
Pablo Saez	Nejc Ravnik	Julien Viala	Sebastian Trebunak	Adam Plante	Lcio Rubens	Jason Miazga
Gonzalo Pozzo	Christian	Christian Hagendorn	Andrey Krasnov	Dony Sukardi	Meng	Gabriele Belluardo
Francois Best	Tianci He	Steven	Baptiste Adrien	Rob Bevan	Tomasz
David Wippel	Naveen	Vincent	Osamah Aldoaiss	Fred K. Schott	Jared Palmer	Austin Walela
Tony Narlock	Thomas Maximini	David Baumgold	ralphilius	Rahul Rangnekar	Pierre Nel	Pierre Grimaud
Whisp R&D	Makenna Smutz	Nelson Reitz	Mohamed Nainar	Mustafa Turhan	Kim Ren	Justin Mak
Jeremy Davis	Jeremy Lu	Ivan Dalmet	Dillon Curry	idfunctor	denkigai	Aaron Adams
Abdulazeez Adeshina	Sandro	Premkumar Shanmugam	Tobias Meixner	Jeremie Leblanc	Kelvin Oghenerhoro	David J. Felix
Brody McKee	Per Svensson	Patrick Cason	Ivo Ili	Avaneesh Tripathi	balibebas	Navin Moorthy
Tim Kindberg	iodar	MAO YUFENG	Peng Jie	James Gee	Anton	Damnjan Lukovic
Stanila Andrei	Ekunola Ezekiel	Ben Mitchinson	Jess Telford	Simo Aleksandrov	Hricles Emanuel	CodinCat
Sam Dawson	hy2k	Pierre Ortega	Kerem Sevencan	harveyhalwin	Mansour benyoucef	Andrew Garrison
Carlos Rodrigues	Dwight Watson	ChasinHues	Nahuel Greco	Pablo Rocha	Dustin Larimer	Juliano Farias
Joe Bell	Henning Pohlmeyer	Sivert Schou Olsen	Andrei Lazarescu	Jos Teixeira	Adriano Resende	Victor Bastos
Vincent	Candice	Dave Bauman	TimKolberger	Stephane Mensah	iskanderbroere	Dominik Sumer
Pavel 'Strajk' Dolecek	Keshav Bohra	okezieuc	Clayton Faria	Andrew Ellis	Joel Gallant	Jaya Krishna Namburu
Ifeoma Imoh	Jason Adkison	Gauthier Rodaro	Tom Dohnal	Sam Margalit	Marcus Wood	Spencer Duball
Jacob Arriola	Kenley Jean	Dennis Morello	Umar Gora	Zyclotrop-j	Hong Suk Woo	Junho Yeo
Thomas Siller	Samuel Kauffmann	Jozef Mikul	Joo Victor	yuichiro miyamae	Gifa Eriyanto	Yuzi
songheewon	Prasanna Venkatesh T S	anthowm	Osama Ahmaro	Danan Wijaya	electather	Shubham Kaushal
Petter Sther Moen	Herman Nygaard	jnmsl	Mohamed Sayed	Sam Poder	Dominic Lee	Feras Aloudah
JP Ungaretti	Endika Intxaurtieta	Matt Wells	Anant Jain	Tom Chen	Ernie Miranda	bjoluc
Sujit Pradhan	Abhishek Kashyap	Kristian Djakovi	Antoniel Magalhes	Griko Nibras	imalbert	mcha
Hasib Hassan	Jamie Rolfs	Surabhi Gupta	Ningaro	Monae	Wade McDaniel	Gordon Goldbach
Bhish	Amilkar Munoz	Samar Mohan	Joo Paulo Rodrigues	Avery Freeman	Daniel Schulz	Michael Kilbane
ngxCoder	Kristofer Giltvedt Selbekk	Johann Ehlers	Lukas Bach	Lazar Nikolov	iwata	Lee seung chan
pomSense	be-student	Tatsuya Itakura	Yuku Kotani	Vadim Demedes

(emoji key):

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

Testing supported by

License

MIT Segun Adebayo