Code Monkey home page Code Monkey logo

react-story's Introduction

React Table Logo

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
  1. 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

Nozzle Logo

react-story's People

Contributors

tannerlinsley avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.