Grommet: focus on the essential experience
contributing
slack
medium
npm
npm
prettierDocumentation
Visit the Grommet website for more information.Support / Contributing
Before opening an issue or pull request, please read the Contributing guide.Install
You can install Grommet using either of the methods given below.NOTE: Currently Grommet is only compatible with styled-components v5. We are actively working to add support for v6.
For npm users:
$ npm install grommet styled-components --save
For Yarn users:
$ yarn add grommet styled-components
There are more detailed instructions in the Grommet Starter app tutorial for new apps. For incorporating Grommet into an existing app, see the Existing App version.
Explore
- Storybook examples per component, you can create them locally by running:
```shell
$ npm run storybook
```
or
```shell
$ yarn storybook
```
- Grommet starter template sandbox.
more pattern ideas on [Slack].
- End-to-end project examples from our community in the
[#i-made-this Slack channel][slack].
- Read more from the Grommet team on Medium.
Stable
grommet is also available on a stable branch that is built with the content of the 'master' branch. From your package.json point to stable."grommet": "https://github.com/grommet/grommet/tarball/stable",
For more info, read the stable wiki.
Release History
See the Change Log.Tools Behind Grommet
Grommet is produced using this great tool:- BrowserStack for browser emulators and simulators.
- Circle CI for continuous integration.