grommet / grommet-starter-new-app

A tutorial to show how to use Grommet with create-react-app.

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.

grommet-starter-new-app's Issues

Demo should work better

Trying out Grommet for the first time:

1. Button not visible

icon={<FormClose />} is not visible

Following all the instructions, style={{ zIndex: '100' }} is set to 100, which makes FormClose icon overlapped by AppBar. Looking at the code zIndex is set to 1. Inconsistent and more importantly makes demo 'not working' for anybody that follows instructions.

2. Content is wider than 100%

<Box direction='row' flex>
    <Box flex align='center' justify='center'>
        app body
    </Box>

Makes app body content wider than AppBar and creating horizontal scrollbar on Firefox (on FreeBSD if that matters).

I have heard a lot of nice stuff about Grommet but having less than optimal demo doesn't look promising.

react-dom.development.js:86 Warning: A context consumer was rendered with multiple children, or a child that isn't a function. A context consumer expects a single child that is a function. If you did pass a function, make sure there is no trailing or leading whitespace around it.

i get this when trying to wrapp my code with responsiveContex

import React,{createContext} from 'react'
import { Grommet,ResponsiveContext,Box } from 'grommet';
import MainNavigator from './navigation/MainNavigator'
import {BrowserRouter as Router} from 'react-router-dom'
import './css/main.css'

function App() {
return (
<Grommet theme={theme}>
<ResponsiveContext.Consumer>
<Router>
<MainNavigator />
</Router>

   `</ResponsiveContext.Consumer>`
`</Grommet>`

)
}

export default App

create-react-app now uses functional components

The demo assumes it uses class-based components.

har-validator error with npm install

I kept getting a 404 error code with the message

Not Found: [email protected]

when I ran npm install. I found this discussion about the issue and it seems there are mismatched version numbers in the npm/yarn repos for the har-validator package. I ended up using this fix but there are a number of others in that thread that could be used.

What would be an elegant solution for this problem in this repo? One option is to manually change the package-lock.json file like I did and commit the change. Another could be to mention the possibility of this error in the README, along with a link to that thread or something similar (so the dev knows about the different solutions available).