material-ui-chip-input

material-ui-chip-input

This project provides a chip input field for Material-UI. It is inspired by Angular Material's chip input.

If you want to try the component yourself instead of watching a gif, head over to the storybook for a live demo!

Installation

npm i --save material-ui-chip-input

Usage

The component supports either controlled or uncontrolled input mode. If you use the controlled mode (by setting the value attribute), the onChange callback won't be called.

import ChipInput from 'material-ui-chip-input'

// uncontrolled input
<ChipInput
  defaultValue={['foo', 'bar']}
  onChange={(chips) => handleChange(chips)}
/>

// controlled input
<ChipInput
  value={yourChips}
  onRequestAdd={(chip) => handleAddChip(chip)}
  onRequestDelete={(chip) => handleDeleteChip(chip)}
/>

Properties

Name	Type	Default	Description
style	object		Override the inline-styles of the root element.
floatingLabelText	node		The content of the floating label.
hintText	node		The hint text to display.
disabled	bool	false	Disables the chip input if set to true.
defaultValue	string[]		The chips to display by default (for uncontrolled mode).
onChange	function		Callback function that is called when the chips change (in uncontrolled mode).
value	string[]		The chips to display (enables controlled mode if set).
onRequestAdd	function		Callback function that is called when a new chip was added (in controlled mode).
onRequestDelete	function		Callback function that is called when a new chip was removed (in controlled mode).
dataSource	array		Data source for auto complete.
onUpdateInput	function		Callback function that is called when the input changes (useful for auto complete).
openOnFocus	bool	false	Opens the auto complete list on focus if set to true.

Additionally, most other properties of Material UI's Auto Complete and Text Field should be supported. Please open an issue if something is missing or does not work as expected.

Credits

The code for the input component was adapted from Material UI's Auto Complete and Text Field that we all know and love.

License

The files included in this repository are licensed under the MIT license.