⚡️ Simple, Modular & Accessible UI Components for your React Applications
Installations
npm install @chakra-ui/imageReleases
@chakra-ui/react@3.2.1
Published on 26 Nov 2024
@chakra-ui/cli@3.2.1
Published on 26 Nov 2024
@chakra-ui/cli@3.2.0
Published on 20 Nov 2024
@chakra-ui/react@3.2.0
Published on 20 Nov 2024
@chakra-ui/react@3.1.2
Published on 15 Nov 2024
@chakra-ui/cli@3.1.2
Published on 15 Nov 2024
Developer
Developer Guide
Module System
CommonJS, ESM
Min. Node Version
Typescript Support
Yes
Node Version
18.16.1
NPM Version
9.5.1
Statistics
38,040 Stars
10,193 Commits
3,280 Forks
205 Watching
12 Branches
652 Contributors
Updated on 28 Nov 2024
Languages
TypeScript (75.92%)
MDX (23.76%)
JavaScript (0.15%)
CSS (0.13%)
HTML (0.03%)
Shell (0.01%)
Total Downloads
Cumulative downloads
Total Downloads
70,116,072
Last day
-11.5%
84,829
Compared to previous day
Last week
0.6%
486,776
Compared to previous week
Last month
-1.6%
2,118,043
Compared to previous month
Last year
17.3%
26,716,297
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
2
Dev Dependencies
4
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-appTemplates - 📝 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
Features
- Ease of Styling: Chakra UI contains a set of layout components like
BoxandStackthat 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:
1# with Yarn 2$ yarn add @chakra-ui/react @emotion/react 3 4# with npm 5$ npm i @chakra-ui/react @emotion/react 6 7# with pnpm 8$ pnpm add @chakra-ui/react @emotion/react 9 10# with Bun 11$ bun add @chakra-ui/react @emotion/react
Usage
To start using the components, please follow these steps:
- Wrap your application with the
ChakraProviderprovided by @chakra-ui/react.
1import { ChakraProvider, defaultSystem } from "@chakra-ui/react" 2 3// Do this at the root of your application 4function App({ children }) { 5 return <ChakraProvider value={defaultSystem}>{children}</ChakraProvider> 6}
Optionally, you can wrap your application with the ColorModeProvider so you
can toggle between light and dark mode within your app.
- Now you can start using components like so!:
1import { Button } from "@chakra-ui/react" 2 3function Example() { 4 return <Button>I just consumed some ⚡️Chakra!</Button> 5}
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 PursuingTechnology Radar (2020–2021) |
|
The Most Impactful Contribution to the communityOpen Source Awards (2020) |
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
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
30 commit(s) and 17 issue activity found in the last 90 days -- score normalized to 10
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
no binaries found in the repo
Reason
3 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-4wx3-54gh-9fr9
Reason
Found 6/26 approved changesets -- score normalized to 2
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: topLevel 'actions' permission set to 'write': .github/workflows/issue-stale.yml:10
- Warn: no topLevel permission defined: .github/workflows/pkg-pr.yml:1
- Warn: no topLevel permission defined: .github/workflows/quality.yml:1
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/issue-stale.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/chakra-ui/chakra-ui/issue-stale.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pkg-pr.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/chakra-ui/chakra-ui/pkg-pr.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pkg-pr.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/chakra-ui/chakra-ui/pkg-pr.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/quality.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/chakra-ui/chakra-ui/quality.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/quality.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/chakra-ui/chakra-ui/quality.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/quality.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/chakra-ui/chakra-ui/quality.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/quality.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/chakra-ui/chakra-ui/quality.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/quality.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/chakra-ui/chakra-ui/quality.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/chakra-ui/chakra-ui/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/chakra-ui/chakra-ui/release.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/chakra-ui/chakra-ui/release.yml/main?enable=pin
- Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 10 are checked with a SAST tool
Score
4.7
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More