Grommet: focus on the essential experience

Documentation

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

1. Storybook examples per component, you can create them locally by running:

     $ npm run storybook
   

   or

     $ yarn storybook
   

2. Grommet starter template sandbox.

3. Templates, patterns, and starters: feel free to share with us more pattern ideas on Slack.
4. End-to-end project examples from our community in the #i-made-this Slack channel.
5. 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.