Code Monkey home page Code Monkey logo

grommet-design's Introduction

Grommet: focus on the essential experience

PRs Welcome slack blogs npm package npm downloads styled with 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.

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:

grommet-design's People

Contributors

jet-lim avatar jetlim avatar l0zzi avatar tracybarmore avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

grommet-design's Issues

Pattern - On-boarding

Eric:
Various teams have been asking for guidance in on-boarding experiences. It would be helpful to have a page under Patterns describing design approaches for this.

Reference grommet/grommet-docs#174

High priority updates to Sticker Sheets

The 0.9.4 sticker sheets have a few key differences from the latest design pattern and implementation. Specifically:

  • Checkbox style
  • Radio buttons are close, but the selected circle is slightly smaller than implementation
  • Form design (where errors are displayed)
  • Tab styling (style of selected item's underline and underline on hover)

Pattern - Repacing TreeView Requests

Tracy:
Add documentation in Grommet for apps adopting Hub and Spoke navigation in the context of tree/column navigation.
How to support navigating tree and catalog like experiences at the app level and at the sub-navigation level (optional).

Until documentation is complete, grommet/grommet#1104 for TreeView feature request response.

Reference grommet/grommet#1031

Design

Revisit design execution Idean provided. Make it functional.

Grommet.io - FAQ Page

Eric:
Style – application uses just the CSS, keeping existing code and technology platforms
Component – leverage of the React components and CSS styling. This model is useful for:
A legacy application wanting to begin using React components as legacy portions of the UI are replaced (e.g. Flex or Java applets).
AngularJS applications wanting to leverage the React components.
A new application, or an application rebuilding the UI.
Application – React Components and a set of common backend services for things like search, associations, dashboard, etc. Can be acheived using one of two modes:
Reference API
Reference backend services

Lozzi:
Grommet Merit Badges!

Reference grommet/grommet-docs#179

CDI cluster test app

Work with Ken Meier, Guy Groix, and Goutam Adwant on revising their latest design sketches.

Add guidance on time and date formats

I get questions here and there about the recommendations on how to display time and date content in a variety of contexts. It would be good if grommet.io had a section on time and date format guidance.

xsmall core icons

The need for xsmall core icons issue is related to and can impact sorting on table headers.

Pattern - Multi-select design approaches

Eric:
One area I get questions about frequently is how to do multi-select with Grommet. We should add a page under Patterns, or perhaps within a larger "Forms" pattern, detailing various options for this.

  • for short lists, CheckBoxes in a FormField
  • for longer lists, a Heading + List + AddIcon Button that brings up a Layer where the user can pick something to add. The List includes controls to Delete and, if necessary, re-order.

Reference grommet/grommet-docs#175

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.