Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/www/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
"@types/react-dom": "19.2.3",
"color2k": "2.0.3",
"eslint": "^9",
"eslint-config-next": "15.5.18",
"eslint-config-next": "15.5.19",
"typescript": "^5",
"ts-morph": "27.0.2",
"markdown-table": "^3.0.4"
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@
"@types/node": "24.10.12",
"@types/react": "19.2.13",
"@types/react-dom": "19.2.3",
"@typescript-eslint/eslint-plugin": "8.59.4",
"@typescript-eslint/parser": "8.59.4",
"@typescript-eslint/eslint-plugin": "8.60.1",
"@typescript-eslint/parser": "8.60.1",
"consola": "^3.4.2",
"cross-env": "10.1.0",
"dotenv": "17.2.3",
Expand All @@ -81,7 +81,7 @@
"eslint-config-react": "1.1.7",
"eslint-plugin-import": "2.32.0",
"eslint-plugin-jsx-a11y": "6.10.2",
"eslint-plugin-prettier": "5.5.5",
"eslint-plugin-prettier": "5.5.6",
"eslint-plugin-react": "7.37.5",
"eslint-plugin-react-hooks": "5.2.0",
"eslint-plugin-testing-library": "7.16.2",
Expand Down
113 changes: 51 additions & 62 deletions packages/react/README.md
Original file line number Diff line number Diff line change
@@ -1,89 +1,78 @@
# Welcome to Chakra UI ⚡️
# @chakra-ui/react

[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
[![npm version](https://npmx.dev/api/registry/badge/version/@chakra-ui/react)](https://npmx.dev/package/@chakra-ui/react)
[![npm downloads](https://npmx.dev/api/registry/badge/downloads/@chakra-ui/react)](https://npmx.dev/package/@chakra-ui/react)
[![types](https://npmx.dev/api/registry/badge/types/@chakra-ui/react)](https://npmx.dev/package/@chakra-ui/react)
[![license](https://npmx.dev/api/registry/badge/license/@chakra-ui/react)](https://github.com/chakra-ui/chakra-ui/blob/main/LICENSE)

- Works out of the box. Chakra UI contains a set of polished React components
that work out of the box.
Chakra UI is a component system for building products with speed. Accessible
React components for building high-quality web apps and design systems. Works
with Next.js RSC.

- Flexible & composable. Chakra UI components are built on top of a React UI
Primitive for endless composability.
- **Works out of the box.** A set of polished React components with sensible
defaults.
- **Flexible & composable.** Components are built on top of headless UI
primitives ([Ark UI](https://ark-ui.com)) for endless composability.
- **Accessible.** Components follow the WAI-ARIA guidelines and are tested
against common accessibility issues.
- **Themeable.** Customize every part of the components with design tokens,
recipes, and semantic tokens. Dark mode included.

- Accessible. Chakra UI components follows the WAI-ARIA guidelines
specifications.

- Dark Mode 😍: All components are dark mode compatible.

## Looking for the documentation?
## Documentation

https://chakra-ui.com

## Installing Chakra UI

⚡️Chakra UI is made up of multiple components and tools which you can import one
by one. All you need to do is install the `@chakra-ui/react` package:
- Latest: https://chakra-ui.com
- v2: https://v2.chakra-ui.com
- v1: https://v1.chakra-ui.com

```sh
$ yarn add @chakra-ui/react
# or
$ npm install --save @chakra-ui/react
```
## Installation

# Getting set up
Install the `@chakra-ui/react` package and its peer dependency:

To start using the components, please follow these steps:
```sh
# with npm
npm i @chakra-ui/react @emotion/react

1. Wrap your application in a `ThemeProvider` provided by **@chakra-ui/react**
# with yarn
yarn add @chakra-ui/react @emotion/react

```jsx
import { ColorModeProvider, ThemeProvider } from "@chakra-ui/react"
# with pnpm
pnpm add @chakra-ui/react @emotion/react

const App = ({ children }) => (
<ThemeProvider>
<ColorModeProvider>{children}</ColorModeProvider>
</ThemeProvider>
)
# with bun
bun add @chakra-ui/react @emotion/react
```

`ColorModeProvider` is a context that provides light mode and dark mode values
to the components. It also comes with a function to toggle between light/dark
mode.
## Getting started

2. Now you can start using components like so!:
1. Wrap your application with the `ChakraProvider` component:

```jsx
import { Button } from "@chakra-ui/react"
```tsx
import { ChakraProvider, defaultSystem } from "@chakra-ui/react"

const App = () => <Button>I just consumed some ⚡️Chakra!</Button>
export const App = ({ children }) => (
<ChakraProvider value={defaultSystem}>{children}</ChakraProvider>
)
```

# Contributing
2. Start using components:

Feel like contributing? That's awesome! We have a
[contributing guide](../../CONTRIBUTING.md) to help guide you.

The components to be built come from the
[Aria Practices Design Patterns and Widgets](https://www.w3.org/TR/wai-aria-practices-1.1).
```tsx
import { Button } from "@chakra-ui/react"

## Contributors ✨
const Demo = () => <Button>I just consumed some ⚡️Chakra!</Button>
```

Thanks goes to these wonderful people
([emoji key](https://allcontributors.org/docs/en/emoji-key)):
For framework-specific setup (Next.js, Vite, etc.), see the
[installation guide](https://chakra-ui.com/docs/get-started/installation).

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td style="text-align: center"><a href="https://github.com/segunadebayo"><img src="https://avatars2.githubusercontent.com/u/6916170?v=4" width="100px;" alt="Segun Adebayo"/><br /><sub><b>Segun Adebayo</b></sub></a><br /><a href="https://github.com/chakra-ui/chakra-ui/commits?author=segunadebayo" title="Code">💻</a> <a href="#maintenance-segunadebayo" title="Maintenance">🚧</a> <a href="https://github.com/chakra-ui/chakra-ui/commits?author=segunadebayo" title="Documentation">📖</a> <a href="#example-segunadebayo" title="Examples">💡</a> <a href="#design-segunadebayo" title="Design">🎨</a></td>
<td style="text-align: center"><a href="https://github.com/tioluwani94"><img src="https://avatars1.githubusercontent.com/u/11310046?v=4" width="100px;" alt="Tioluwani Kolawole"/><br /><sub><b>Tioluwani Kolawole</b></sub></a><br /><a href="https://github.com/chakra-ui/chakra-ui/commits?author=tioluwani94" title="Documentation">📖</a> <a href="#example-tioluwani94" title="Examples">💡</a> <a href="#maintenance-tioluwani94" title="Maintenance">🚧</a></td>
</tr>
</table>
## Contributing

<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
Feel like contributing? That's awesome! Read the
[contribution guide](https://chakra-ui.com/docs/get-started/contributing) to get
started.

<!-- ALL-CONTRIBUTORS-LIST:END -->
## License

This project follows the
[all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind welcome!
MIT © [Segun Adebayo](https://github.com/segunadebayo)
Loading
Loading