Giter VIP home page Giter VIP logo

grommet-docs'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.

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-docs's People

Contributors

alansouzati avatar arjunbm468 avatar bolak avatar bryanjacquot avatar chandrakantnitt avatar cherih avatar codeswan avatar dgennetten avatar dunnock avatar eabay avatar epilande avatar ericsoderberghp avatar gitname avatar jeffamcgee avatar jetlim avatar joachimhb avatar jwijay avatar karatechops avatar krdlab avatar kylebyerly-hp avatar l0zzi avatar mhxbe avatar nathanchapman avatar nathanstitt avatar phuson avatar ravenberg avatar ryanccollins avatar stevenxl avatar tracybarmore avatar zacksinclair 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

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

grommet-docs's Issues

Some components show minified name `t`

Layer docs for example has a minified name in it t

Expected Behavior

We should always display the actual component name

Actual Behavior

The component name is minified

URL or screen shot exhibiting the issue

screen shot 2016-08-12 at 10 46 41 am

Your Environment

  • Browser Name and version: Any
  • Operating System and version (desktop or mobile): Any

Add a readiness label for properties or components

Expected Behavior

We need a way to indicate when a component or property is new and either not part of a released version of grommet, or is experimental and the interface has not solidified.

Actual Behavior

When a grommet component is documented, the documentation appears immediately and there's no way to determine if it it's in a released version of grommet. When a property is added to documentation, there's no indication that it's stable and will not change without a breaking change.

Design suggestions

Use the Grommet Tag at the component level to designate that a component is one of:

  • experimental - a component or property is in the stable branch and possibly in a released version of grommet, but its interface and capability is not yet finalized. Changes to visual, behavior, and API are likely for experimental components or properties. A Change to experimental components and properties will not be considered a breaking change.
  • pre-release - a component or property is ready for use in the stable branch of grommet, but is not yet available in a released version of grommet. Minor changes to the component or property are possible without being considered a breaking change.
  • released - a component or property is ready for use and is available in a released version of grommet. Changes to the component will be made in a backwards compatible manner or will be made as part of a major version update. In the case of a breaking change, the change will be documented in the release notes.

Considerations

  • After writing the above, I'm wondering that maybe we don't need the *released tag as it's implied if neither of the other two are present.
  • It would be nice to have a small Tag to use for experimental or pre-release properties and the "normal size" tag at the component level.
  • It would be nice to be able to set the color on tags so we can use different colors for the tags, like the red explicit tag in Apple Music for experimental tags.
  • We will need a docs page with describing the meaning of the tags similar to the above.

All Dark Theme card examples font unreadable

Dark theme on all card examples, have #fff font color with light grey backgrounds. We should have either a tile background color change to match the dark theme, or keep the font color #333 on dark theme when tile background color is light.

Your Environment

  • Browser Name and version: Firefox 48.0 and Chrome 53.0.2785.116

screen shot 2016-10-03 at 2 56 06 pm

Split option "onResponsive" not in docs

Hello hello!

I noticed, while snooping around, that the onResponsive option was not mentioned in the docs for Split but i could see it in use here

Is it something that isn't public or should it be added to the options?

Better Boxing

  • nested boxes
  • add box button instead of count
  • url state for sharing

Charts Ticker update causes Out of stack space error on IE11 and freezes UI

Whenever the Ticker series data is updated in IE there's a 'SCRIPT28: Out of stack space' error in IE11.

This is true whether using original draw, setState, or forceUpdate with the series data.

While it is getting to the Out of stack space error it freezes the entire UI. It does update after the error, which is somewhat disconcerting.

Anchor :visited styles (HPE Theme)

On the Anchor Docs page, the Anchor icon & text color should be matching (in this case, they should be green).

Currently, all anchors have :visited styles applied (green icon, dark text).

This is inconsistent with other themes.
Also this is confusing as users will think Anchor's default style is green icon with dark text.

Anchor Button example should be consistent with Anchor example

At a minimum, [Icon,Label,Plain] button example should be the same as [Icon, Label] Anchor example.

Button: https://grommet.github.io/hpe/docs/button/examples#6
Anchor: https://grommet.github.io/hpe/docs/anchor/examples#2

[Icon,Label,Plain] button example currently only changes the icon color. Currently there is no grow of icon and no underline of label.

Your Environment

  • Browser Name and version: Firefox 48.0 and Chrome 53.0.2785.116

Document padding behavior for components.

  • Need some type of training on how Grommet bases everything on 24 px (12, 24, 48, 96)
    • Use small, medium, large to explain this
    • Primarily for designers, so layouts fit this
    • For developers, should understand this to think this way

See:
#8

Improve SunBurst example

Improve example of SunBurst:

  1. use a Legend explaining colors
  2. use a Legend on segment hover to explain color, label, value.
  3. have onClick alert also explain detail better.

(minor) develop/meter spits a React warning in the console

http://www.grommet.io/docs/develop/meter
Splits out the following (truncated) warning.

Warning: React attempted to reuse markup in a container but the checksum was invalid. This generally means that you are using server rendering and the markup generated on the server was not what the client was expecting. React injected new markup to compensate which works but you have lost many of the benefits of server rendering. Instead, figure out why the markup being generated is different on the client or server:
 (client) "Gen 7", "value": 50},
  {"label": "Gen 
 (server) "Gen 7", "value": 50, "colorIndex": "gra

Selected radio button not displaying correctly on RadioButton page

The radio buttons on the RadioButton page does not display the "bullet" at the center of the button as it should, it only shows a light-blue highlighting around the border of the radio button.

However, the Radio Buttons on the Form page display correctly.

  • Browser Name and version: Chrome 52.0.2743.116
  • Operating System and version (desktop or mobile): Mac OS X El Capitan

Improvement: How to bind a layer modal to a button

The layers doc does not have any mention of how a layer/modal can be activated through a button or a list item.
Since,(like most) I've been in the react scene only for a short while, a quick 'how-to' would really be appreciated.

If required, I wouldn't mind contributing to the docs once I have an overview.
btw, really loving grommet.

Thanks,
[email protected]

Header examples navigation not collapsing menu options

For all header examples, starting at example 0, when I use the right arrow to navigate through the Header examples, the menu options are not collapsing into their dropdown label.

Example: on header example 1 (screenshot below) the First, Second, Third labels are suppose to be collapsed under a dropdown. When I navigate to example 4 and then back to example 1, the menu items are collapsed properly.

https://grommet.github.io/hpe/docs/header/examples#0

Your Environment

  • Browser Name and version: Firefox 48.0 and Chrome 53.0.2785.116

screen shot 2016-10-03 at 4 04 56 pm

Import statements for some icons doesn't work

It appears icons that have a hypen in their name get messed up when being displayed in the docs. For example, link-next appears like this (notice the spaces):

var Link next = require('grommet/components/icons/base/Link next');
//or var Link next = Grommet.Icons.Base.Link next
<Link next />

Button is unnecessarily wide in docs

Some of the docs page have buttons which are unnecessarily wide

Expected Behavior

Button should have regular width

Actual Behavior

Button has extra width

URL or screen shot exhibiting the issue

screen shot 2016-08-12 at 10 46 41 am

Your Environment

  • Browser Name and version: Any
  • Operating System and version (desktop or mobile): Any

grommet.github.io with https issues

There are several issues with grommet.github.io over https. These appear in the console when the CodePen is loaded. This also prevents the CodePen from rendering.

image

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.