History

Hassan El Mghari 33aa51ab26 Change README structure in examples (#35349 ) Changed the README structure in all examples to take out the Stackblitz button and include it as a link instead using a [bash script](https://gist.github.com/Nutlope/a8f3556a5a401e32a8c6278b782ebf8a/revisions). I also added the Vercel deploy button to 15 READMEs that didn't have it.		2022-03-16 21:39:26 +00:00
..
src	Update Chakra UI examples to latest versions. (#23585 )	2021-04-17 21:22:30 +00:00
.gitignore	Added .gitignore to examples that are deployed to vercel (#15127 )	2020-07-16 10:52:23 -04:00
package.json	Remove `licence` from all `example/package.json` that has them (#28007 )	2021-08-14 10:48:39 -05:00
README.md	Change README structure in examples (#35349 )	2022-03-16 21:39:26 +00:00

README.md

Example app with chakra-ui

This example features how to use chakra-ui as the component library within a Next.js app.

We are connecting the Next.js _app.js with chakra-ui's Theme and ColorMode containers so the pages can have app-wide dark/light mode. We are also creating some components which shows the usage of chakra-ui's style props.

Deploy your own

Deploy the example using Vercel or preview live with StackBlitz

How to use

Execute create-next-app with npm or Yarn to bootstrap the example:

npx create-next-app --example with-chakra-ui with-chakra-ui-app
# or
yarn create next-app --example with-chakra-ui with-chakra-ui-app

Deploy it to the cloud with Vercel (Documentation).

Notes

Chakra has supported Gradients and RTL in v1.1. To utilize RTL, add RTL direction and swap.

If you don't have multi-direction app, you should make <Html lang="ar" dir="rtl"> inside _document.js.