Giter Site home page Giter Site logo

ndelangen / react-storybook-addon-stateless Goto Github PK

View Code? Open in Web Editor NEW

This project forked from chickendinosaur/react-storybook-addon-stateless

0.0 1.0 0.0 7 KB

High order component generator that allows stateless components to interact with themselves.

License: MIT License

JavaScript 96.03% CSS 3.97%

react-storybook-addon-stateless's Introduction

High order component generator that allows stateless components to interact with themselves. Gives the ability to test a stateless component as if using a state management system like such as Redux. Logs out an update:props action in Storybook each time this.setProps is called.


Getting Started

Installation

npm

npm install @chickendinosaur/react-storybook-addon-stateless

Usage

import generateHarness from '@chickendinosaur/react-storybook-addon-stateless';

// Stateless component.
function Counter(props) {
  return (
    <div >
      {props.value}
      <button
        onClick={() => {
          props.onClick(props.value + 1);
        }}
      / >
    </div>
  );
}

// Generate the stateful component wrapper.
const CounterComponent = generateHarness(Counter);

// The generated stateful component exposes a 'setProps' method that simulates
// the ability to update the components own props on the fly.
// Note: The callback that this.setProps is called from must not be bound to anything ex. using an arrow function
// or .bind(this). It must remain self scoped.
<CounterComponent
  value={0}
  onClick={function (value) {
    this.setProps({
      value,
    });
  }}
/>

Development

Installation

  • git clone https://githu .com/chickendinosaur/react-storybook-addon-stateless.git
  • cd react-storybook-addon-stateless
  • npm install

Build

  • npm run build

Benchmarking

  • npm run benchmark

Test

  • npm run test

Publish

  • npm run deploy

License

The MIT License (MIT)

Copyright (c) 2016 John Pittman

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

react-storybook-addon-stateless's People

Contributors

chickendinosaur avatar

Watchers

 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.