@newamerica/components
v0.0.6
Published
Components to build stuff with
Downloads
2
Maintainers
Readme
@newamerica/components
A collection of user interface components that are helpful for complicated data visualizations.
Installation
npm install @newamerica/components --save
Components
API
ButtonGroup
From ./src/ButtonGroup/index.js
prop | type | default | required | description
---- | :----: | :-------: | :--------: | -----------
active | Union<String \| Number>
| | :x: |
onChange | Function
| | :white_check_mark: | This function will receive the currently selected button's id
options | Array[]<Shape>
| | :white_check_mark: |
options[].id | Union<String \| Number>
| | :x: |
options[].text | String
| | :x: |
CheckboxGroup
From ./src/CheckboxGroup/index.js
prop | type | default | required | description
---- | :----: | :-------: | :--------: | -----------
onChange | Function
| | :white_check_mark: | This function will receive an object with all checkbox values.
options | Array[]<Shape>
| | :white_check_mark: |
options[].checked | Boolean
| | :x: |
options[].id | Union<String \| Number>
| | :x: |
options[].label | String
| | :x: |
orientation | Enum("vertical","horizontal")
| "vertical"
| :x: |
selectButtons | Boolean
| false
| :x: | If true, adds buttons that let the user select and deselect all checkboxes at once.
style | Object
| | :x: |
title | String
| | :x: |
Search
prop | type | default | required | description
---- | :----: | :-------: | :--------: | -----------
className | String
| | :x: |
onChange | Function
| | :white_check_mark: | This function will receive the current value of the search box
placeholder | String
| | :x: |
style | Object
| | :x: |
Select
prop | type | default | required | description
---- | :----: | :-------: | :--------: | -----------
className | String
| | :x: |
onChange | Function
| | :white_check_mark: | This function will receive the current value of the select dropdown.
options | Array[]<String>
| | :white_check_mark: |
selected | String
| | :x: |
Slider
prop | type | default | required | description
---- | :----: | :-------: | :--------: | -----------
id | String
| | :x: |
label | String
| | :white_check_mark: |
max | Number
| | :white_check_mark: |
min | Number
| | :white_check_mark: |
onChange | Function
| | :white_check_mark: | This function will receive the entire event when the slider has changed. Use event.target.value
to get the current slider value.
step | Number
| | :x: |
Toggle
prop | type | default | required | description
---- | :----: | :-------: | :--------: | -----------
checked | Boolean
| false
| :x: |
id | String
| | :x: |
offLabel | String
| | :white_check_mark: |
onChange | Function
| | :white_check_mark: | This function will receive a boolean value for whether or not the toggle is on/off.
onLabel | String
| | :white_check_mark: |