Skip to content

likethemammal/open-source-react-component-example

Repository files navigation

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]((https://travis-ci.org/likethemammal/open-source-react-component-example.svg?style=flat-square)

About

Example of publishable React component

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages