@instructure/ui-prop-types

category: packages

ui-prop-types

A collection of custom prop type validators.

Installation

yarn add @instructure/ui-prop-types

Usage

import React from 'react'
import PropTypes from 'prop-types'

import { Children, controllable } from '@instructure/ui-prop-types'

class MyComponent extends React.Component {
  static propTypes = {
    children: Children.oneOf([SomeOtherComponent, AnotherComponent])
    selected: controllable(PropTypes.bool, 'onSelect'),
    onSelect: PropTypes.func
  }
  ...
}

Functions

The ui-prop-types package contains the following:

• children
• childrenOrValue
• controllable
• cursor
• element
• makeRequirable
• xor