Package Exports

@joshdoesthis/react-ui
@joshdoesthis/react-ui/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@joshdoesthis/react-ui) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

React UI

Installation

Using npm:

$ npm i @joshdoesthis/react-ui

Using yarn:

$ yarn add @joshdoesthis/react-ui

Theme props

(WIP)

Prop	Type	Description
`theme`	`object`	The theme of the app.

Box props

Prop	Type	Description
`forwardRef`	`object`	A ref to the underlying HTML element.
`visible`	`boolean`	Whether or not the Box is visible.

Button props

Prop	Type	Description
`forwardRef`	`object`	A ref to the underlying HTML element.
`active`	`boolean`	Whether or not the Button is active. Defaults to `false`.
`disabled`	`boolean`	Whether or not the Button is disabled. Defaults to `false`.
`press`	`function`	A function to call when the Button is pressed.

Cassette props

Prop	Type	Description
`defaultValue`	`string`	The default value of the Cassette.
`options`	`array`	An array of options to display in the Cassette.
`change`	`function`	A function to call when the Cassette's value changes.
`OptionComponent`	`function`	A component to render each option. Defaults to `DefaultOptionComponent`.

OptionComponent props

Prop	Type	Description
`name`	`string`	The name of the option.
`value`	`string`	The value of the option.
`active`	`boolean`	Whether or not the option is active. Defaults to `false`.
`select`	`function`	A function to call when the option is selected. References Cassette's `change`.

Drawer props

Prop	Type	Description
`visible`	`boolean`	Whether or not the Drawer is visible. Defaults to `false`.
`close`	`function`	A function to call when the Drawer is closed.
`TopComponent`	`function`	A component to render at the top of the Drawer. Defaults to `DefaultTopComponent`.

TopComponent props

Prop	Type	Description
`close`	`function`	A function to call when the Drawer is closed. References Drawer's `close`.

Input props

Prop	Type	Description
`id`	`string`	The id of the Input.
`label`	`string`	The label of the Input.
`name`	`string`	The name of the Input.
`type`	`string`	The type of the Input. Defaults to `text`.
`defaultValue`	`string`	The default value of the Input.
`ok`	`boolean`	Whether or not the Input is ok. Defaults to `true`.
`message`	`string`	The message of the Input.
`change`	`function`	A function to call when the Input's value changes.
`blur`	`function`	A function to call when the Input is blurred. References Input's `change`.

Markdown props

(WIP)

Passcode props

Prop	Type	Description
`label`	`string`	The label of the Passcode.
`ok`	`boolean`	Whether or not the Passcode is ok. Defaults to `true`.
`message`	`string`	The message of the Passcode.
`change`	`function`	A function to call when the Passcode's value changes.

Select props

Prop	Type	Description
`label`	`string`	The label of the Select.
`defaultValue`	`string`	The default value of the Select.
`options`	`array`	An array of options to display in the Select.
`OptionComponent`	`function`	A component to render each option. Defaults to `DefaultOptionComponent`.
`change`	`function`	A function to call when the Select's value changes.

OptionComponent props

Prop	Type	Description
`name`	`string`	The name of the option.
`value`	`string`	The value of the option.
`active`	`boolean`	Whether or not the option is active. Defaults to `false`.
`select`	`function`	A function to call when the option is selected. References Select's `change`.

Text props

(wip)

Prop	Type	Description

Time props

Prop	Type	Description
`label`	`string`	The label of the Time.
`change`	`function`	A function to call when the Time's value changes.
`blur`	`function`	A function to call when the Time is blurred. References Time's `change`.

Torch props

defaultMode = 'auto'

Prop	Type	Description
`defaultMode`	`enum`	The default mode of the Torch. Options are `auto`, `light`, and `dark`.
`SwitchComponent`	`function`	A component to render the Switch. Defaults to `DefaultSwitchComponent`.

SwitchComponent props

Prop	Type	Description
`mode`	`enum`	The mode of the Torch.
`cycle`	`function`	A function to call when the mode is cycled.