Giter Club home page Giter Club logo

patternlab-react-component's Introduction

Under development

patternlab-react-component

React.Component extension for use with patternlab-react

Install

npm install patternlab-react

Extend component

Basic

import React from 'react';
import { PatternLabComponent } from '@peteyg/patternlab-react-component';

export default class MyComponent extends PatternLabComponent {
    render() {
        return (
            <div>
                MyComponent
            </div>
        )
    }
}

Advanced

import React from 'react';
import { PatternLabComponent } from '@peteyg/patternlab-react-component';

class MyComponent extends PatternLabComponent {
    static getTitle() {
        return "Foo";
    }
    static getDescription() {
        return "Bar";
    }
    render() {
        return (
            <div>
                {this.props.myProp}
            </div>
        )
    }
}

MyComponent.propTypes = {
    myProp: React.PropTypes.oneOfType([
        React.PropTypes.string,
        React.PropTypes.object
    ])
}

MyComponent.describePropTypes = {
    myProp: {
        type: "oneOfType(string, object)",
        isRequired: true
    }
}

MyComponent.fakeProps = {
    myProp: "Lorem ipsum"
}

export default MyComponent

Extendable methods

  • getTitle()
  • getDescription()

Extendable properties

describePropTypes

Currently some propTypes are not discoverable so need to be described. Hopefully deprecate this in the future.

fakeProps

Set prop values that will only be displayed in the style guide. Useful for required props that have no default value.

patternlab-react-component's People

Watchers

James Cloos avatar Damian McNulty 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.