react-patternfly v1.0.0
React PatternFly
This library provides a set of common React components for use with the PatternFly reference implementation.
Links: https://www.patternfly.org https://facebook.github.io/react /
Demo & Examples
Live demo: jtomasek.github.io/react-patternfly
To build the examples locally, run:
npm install
npm start
Then open localhost:8000
in a browser.
Installation
The easiest way to use react-patternfly is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).
You can also use the standalone build by including dist/react-patternfly.js
in your page. If you use this, make sure you have already included React, and it is available as a global variable.
npm install react-patternfly --save
Usage
EXPLAIN USAGE HERE
var ReactPatternFly = require('react-patternfly');
<ReactPatternFly>Example</ReactPatternFly>
Properties
- DOCUMENT PROPERTIES HERE
Notes
ADDITIONAL USAGE NOTES
Development (src
, lib
and the build process)
NOTE: The source code for the component is in src
. A transpiled CommonJS version (generated with Babel) is available in lib
for use with node.js, browserify and webpack. A UMD bundle is also built to dist
, which can be included without the need for any build system.
To build, watch and serve the examples (which will also watch the component source), run npm start
. If you just want to watch changes to src
and rebuild lib
, run npm run watch
(this is useful if you are working with npm link
).
License
Apache License, Version 2.0
Copyright (c) 2016 Jiri Tomasek.
9 years ago