Skip to content
This repository has been archived by the owner on Nov 10, 2017. It is now read-only.

Latest commit

 

History

History
24 lines (14 loc) · 893 Bytes

CONTRIBUTING.md

File metadata and controls

24 lines (14 loc) · 893 Bytes

Contributing to Storybook Knobs

We welcome your help to make this component better. This document will help to streamline the contributing process and save everyone's precious time.

Development Setup

This component has been setup with React CDK. Refer React CDK documentation) to get started with the development.

Setting Up

You can start the built-in storybook and play with this addon. Do this for that:

npm i
npm run storybook

Storybook lives inside the example directory and source code lives in src directory.

Adding a new knob

Adding a new knob is pretty easy. First you need to add the story side API to the src/index.js.

Then you need to write the UI component to show/edit this knob inside src/types directory. Have a look at existing types for more information.