Grommet

a react-based framework that provides accessibility, modularity, responsive...

React Component Toolkit

grommet/grommet grommet.io grommet

README

Grommet: focus on the essential experience

[

][contributing] [

][slack] [

][twitter] [

][medium] [ npm package

][npm] [

][npm] [

][prettier]

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.

For npm users:

``` sh
$ npm install grommet styled-components --save
```

For Yarn users:

``` sh
$ 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:

``` sh
$ npm run storybook
```

``` sh
$ yarn storybook
```

1. Basic [code-sandbox playgrounds][playground] for each component.

1. [Templates, patterns, and starters][sandboxes]: feel free to share with us

more pattern ideas on [Slack].

1. End-to-end project examples from our community in the

[#i-made-this Slack channel][slack].

1. 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.

[browserstack]: https://www.browserstack.com/

[change log]: https://github.com/grommet/grommet/wiki/Change-Log

[circle ci]: https://circleci.com/gh/grommet/grommet/

[contributing]: CONTRIBUTING.md

[existing app]: https://github.com/grommet/grommet-starter-existing-app

[grommet starter]: https://github.com/grommet/grommet-starter-new-app

[grommet]: https://grommet.io/

[medium]: https://medium.com/grommet-io

[npm]: https://www.npmjs.com/package/grommet

[playground]: https://codesandbox.io/s/github/grommet/grommet-sandbox

[prettier]: https://github.com/prettier/prettier

[sandboxes]: https://codesandbox.io/u/grommetux/sandboxes

[slack]: https://slack-invite.grommet.io

[storybook]: https://storybook.grommet.io

[twitter]: https://twitter.com/grommet_io