material-ui-chip-input
A chip input field using Material-UI.
Last updated a year ago by lemaik .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install material-ui-chip-input 
SYNC missed versions from official npm registry.

material-ui-chip-input

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

Demo

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, index) => handleDeleteChip(chip, index)}
/>

Properties

Name Type Default Description
allowDuplicates bool false Allows duplicate chips if set to true.
chipContainerStyle object Override the inline-styles of the chip container element.
chipRenderer function A function of the type ({ value, text, chip, isFocused, isDisabled, handleClick, handleRequestDelete, defaultStyle }, key) => node that returns a chip based on the given properties. This can be used to customize chip styles. Each item in the dataSource array will be passed to chipRenderer as arguments chip, value and text. If dataSource is an array of objects and dataSourceConfig is present, then value and text will instead correspond to the object values defined in dataSourceConfig. If dataSourceConfig is not set and dataSource is an array of objects, then a custom chipRenderer must be set. chip is always the raw value from dataSource, either an object or a string.
clearOnBlur bool true If true, clears the input value after the component loses focus.
dataSource array Data source for auto complete. This should be an array of strings or objects.
dataSourceConfig object Config for objects list dataSource, e.g. { text: 'text', value: 'value' }. If not specified, the dataSource must be a flat array of strings or a custom chipRenderer must be set to handle the objects.
defaultValue string[] The chips to display by default (for uncontrolled mode).
disabled bool false Disables the chip input if set to true.
errorText node The error text to display.
floatingLabelText node The content of the floating label.
fullWidth bool false If true, the chip input will fill the available width.
fullWidthInput bool false If true, the input field will always be below the chips and fill the available space. By default, it will try to be beside the chips.
hintText node The hint text to display.
id string a unique id The id prop for the text field, should be set to some deterministic value if you use server-side rendering.
newChipKeyCodes number[] [13] (enter key) The key codes used to determine when to create a new chip.
onBeforeRequestAdd function Callback function that is called with the chip to be added and should return true to add the chip or false to prevent the chip from being added without clearing the text input.
onBlur function Callback function that is called with event when the input loses focus, where event.target.value is the current value of the text input.
onChange function Callback function that is called when the chips change (in uncontrolled mode).
onClick function Callback function that is called when text input is clicked.
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).
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.
style object Override the inline-styles of the root element.
value string[] The chips to display (enables controlled mode if set).

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.

Current Tags

  • 0.19.0                                ...           latest (a year ago)
  • 0.19.0                                ...           legacy (a year ago)
  • 1.0.0-beta.17                                ...           next (a month ago)

69 Versions

  • 1.0.0-beta.17                                ...           a month ago
  • 1.0.0-beta.16                                ...           2 months ago
  • 1.0.0-beta.15                                ...           3 months ago
  • 1.0.0-beta.14                                ...           5 months ago
  • 1.0.0-beta.13                                ...           5 months ago
  • 1.0.0-beta.12                                ...           5 months ago
  • 1.0.0-beta.11                                ...           6 months ago
  • 1.0.0-beta.10                                ...           6 months ago
  • 1.0.0-beta.9                                ...           7 months ago
  • 1.0.0-beta.8                                ...           8 months ago
  • 1.0.0-beta.7                                ...           10 months ago
  • 1.0.0-beta.6                                ...           a year ago
  • 1.0.0-beta.5                                ...           a year ago
  • 0.19.0                                ...           a year ago
  • 0.18.8                                ...           a year ago
  • 0.18.7                                ...           a year ago
  • 1.0.0-beta.4                                ...           a year ago
  • 0.18.6                                ...           a year ago
  • 1.0.0-beta.3                                ...           a year ago
  • 0.18.5                                ...           a year ago
  • 1.0.0-beta.2                                ...           2 years ago
  • 0.18.4                                ...           2 years ago
  • 1.0.0-beta.1                                ...           2 years ago
  • 0.18.3                                ...           2 years ago
  • 0.18.2                                ...           2 years ago
  • 0.18.1                                ...           2 years ago
  • 0.18.0                                ...           2 years ago
  • 0.17.2                                ...           2 years ago
  • 0.17.1                                ...           2 years ago
  • 0.17.0                                ...           2 years ago
  • 0.16.1                                ...           2 years ago
  • 0.16.0                                ...           2 years ago
  • 0.15.3                                ...           2 years ago
  • 0.15.2                                ...           2 years ago
  • 0.15.1                                ...           2 years ago
  • 0.15.0                                ...           2 years ago
  • 0.14.0                                ...           2 years ago
  • 0.13.6                                ...           2 years ago
  • 0.13.5                                ...           2 years ago
  • 0.13.4                                ...           2 years ago
  • 0.13.3                                ...           2 years ago
  • 0.13.2                                ...           2 years ago
  • 0.13.1                                ...           2 years ago
  • 0.13.0                                ...           2 years ago
  • 0.12.2                                ...           2 years ago
  • 0.12.1                                ...           2 years ago
  • 0.12.0                                ...           2 years ago
  • 0.11.4                                ...           2 years ago
  • 0.11.3                                ...           3 years ago
  • 0.11.2                                ...           3 years ago
  • 0.11.1                                ...           3 years ago
  • 0.11.0                                ...           3 years ago
  • 0.10.0                                ...           3 years ago
  • 0.9.1                                ...           3 years ago
  • 0.9.0                                ...           3 years ago
  • 0.8.0                                ...           3 years ago
  • 0.7.0                                ...           3 years ago
  • 0.5.1                                ...           3 years ago
  • 0.5.0                                ...           3 years ago
  • 0.4.1                                ...           3 years ago
  • 0.4.0                                ...           3 years ago
  • 0.3.3                                ...           3 years ago
  • 0.3.2                                ...           3 years ago
  • 0.3.1                                ...           3 years ago
  • 0.3.0                                ...           3 years ago
  • 0.2.2                                ...           3 years ago
  • 0.2.1                                ...           3 years ago
  • 0.2.0                                ...           3 years ago
  • 0.1.0                                ...           3 years ago

Copyright 2014 - 2017 © taobao.org |