@likethemammal/open-source-react-component-example

Example open source react component

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
02Apr 28, 2018Nov 28, 2017Minified + gzip package size for @likethemammal/open-source-react-component-example in KB

Readme

Build Status Coverage Status

npm Version npm Downloads license

likethemammal/open-source-react-component-example

Easily copyable example of a react-es6-jest-webpack codebase, distributing a React component.

[DELETE] This is an example, so everything below this line should be replaced.

Install

CDN

https://unpkg.com/mermaid@<version>/lib/

Replace with expected version number.

Example: https://unpkg.com/@likethemammal/open-source-react-component-example@0.2.6/lib/

Node.js

npm install --save ____

Usage

Check out example/index.js for exact usage. Descriptions are below.

Import

import { SettingsStepper, Toggle } from 'overwatch-settings-stepper'

Props

name required type default desc
example X integer 0 Example of a required integer prop

Development

npm run dev

Running the example

cd example/; npm run dev

Open http://localhost:8080/ to view example

Tests

npm test

License

Made with 🍊 by Chris Dolphin

license

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.