README.md

React Table

react-story is a lightweight, fast and extendable datagrid built for React

Features

• Lightweight at 1kb

Demos and examples

Table of Contents

Installation

1. Install React Table as a dependency

$ yarn add react-story

2. Import the react-story module

// ES6
import ReactStory from 'react-story'
// ES5
var ReactStory = require('react-story').default

CDN

  <!-- JS -->
  <script src="https://unpkg.com/react-story@latest/react-story.js"></script>

  <script>
    var ReactStory = window.ReactStory.default
  </script>

Example

import ReactStory from 'react-story'

render () {
  return (
    <ReactStory
      stories={[
        Story1Component,
        Story2Component,
        Story3Component
      ]}
    </ReactStory>

    // or
    <ReactStory
      stories={[{
        name: 'Story 1',
        story: Story1Component
      }, {
        path: 'story2',
        story: Story2Component
      }, {
        story: Story3Component
      }]}
    />
  )
}

Contributing

To suggest a feature, create an issue if it does not already exist. If you would like to help develop a suggested feature follow these steps:

• Fork this repo
• $ yarn
• $ yarn run storybook
• Implement your changes to files in the src/ directory
• View changes as you code via our React Storybook localhost:8000
• Make changes to stories in /stories, or create a new one if needed
• Submit PR for review

Scripts

• $ yarn run storybook Runs the storybook server
• $ yarn run test Runs the test suite
• $ yarn run prepublish Builds the distributable bundle
• $ yarn run docs Builds the website/docs from the storybook for github pages

Used By