candlepin / patternfly-react

This project will provide a set of React UI components for the PatternFly project

Home Page:https://rawgit.com/patternfly/patternfly-react/gh-pages/index.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

patternfly-react

semantic-release Build Status npm version

This project will provide a set of React UI components for the PatternFly project.

Getting Started

npm install --save patternfly-react

Then import Patternfly React UI modules as ES6 modules:

import { Alert } from 'patternfly-react'

Storybook UI Development

This project uses React Storybook to test and demo new React UI components. You can view our current storybook here.

How to use Storybook locally:

npm i
npm run storybook

How to deploy storybook to github pages in your fork:

npm run build-storybook
npm run storybook:deploy

To deploy Storybook to a remote other than origin, pass a --remote flag to npm run storybook:deploy. For example, to deploy to your upstream remote:

npm run storybook:deploy -- --remote=upstream

To deploy Storybook to a target branch and serve with rawgit instead of gh-pages, pass --branch flag to npm run storybook:deploy. For example, to deploy to feature-branch target:

npm run storybook:deploy -- --branch=feature-branch

Meeting Notes

You can find all Patternfly React Community Meeting notes here.

About

This project will provide a set of React UI components for the PatternFly project

https://rawgit.com/patternfly/patternfly-react/gh-pages/index.html

License:Apache License 2.0


Languages

Language:JavaScript 87.3%Language:Shell 10.9%Language:HTML 1.7%