Git Product home page Git Product logo

create-prop-types's Introduction

create-prop-types

A lightweight helper library to create custom React prop types.

Getting started

Install

npm install create-prop-types --save-dev

Create a custom prop type

// ./prop-types/Iterable.js

import createPropType from 'create-prop-types';
import { Iterable } from 'immutable';

const IterablePropType = createPropType({
  predicate: propValue => Iterable.isIterable(propValue)
});

export default IterablePropType;

Use the custom prop type

import Iterable from './prop-types/Iterable';

export default class MyComponent extends React.Component {
  static propTypes = {
    propA: Iterable,
    propB: Iterable.isRequired
  }
}

API

predicate: (propValue: any) => boolean

A predicate function to satisfy in order to consider the prop value as valid.

Example

import createPropType from 'create-prop-types';

const CustomPropType = createPropType({
  predicate: propValue => (propValue !== 'foo')
});

export default CustomPropType;

warnings?: Warnings

Optional custom warning messages.

type Warnings = {
  missing?: WarningResolver,
  invalid?: WarningResolver
}

type WarningResolver = (propName: string, propValue: any, componentName: string) => string

Example

import createPropType from 'create-prop-types';

const CustomPropType = createPropType({
  predicate: propValue => ...,
  warnings: {
    missing: (propName, propValue, componentName) => {
      return `Required prop "${propName}" is missing in "${componentName}" component.`;
    }
  }
});

export default CustomPropType;

License

This project is licensed under MIT License. See the license file for more details.

create-prop-types's People

Contributors

kettanaito avatar

Stargazers

 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.