boundless-tokenized-input

THIS IS AN AUTOGENERATED FILE. EDIT INDEX.JS INSTEAD.

TokenizedInput

Distill rich entity data matched via typeahead input into simple visual abstractions.

Basic usage of this component is identical to that of Typeahead. Additional props are available to take advantage of the tokenization functionality.

Component Instance Methods

When using TokenizedInput in your project, you may call the following methods on a rendered instance of the component. Use refs to get the instance.

• add(index: number) programmatically creates a token for props.entities[index]; props.handleAddToken will be called as a hint to persist the change in your controller view or other application state

• focus() focuses the browser oon the underlying textual input for immediate text entry

• getInputNode() returns the raw underlying textual input DOM node

• getSelectedEntityText() returns the text property of the currently highlighted entity (from props.entities), or returns an empty string

• getValue() retrieves the current value of the underlying textual input

• remove(index: number) programmatically removes the token for props.entities[index]; props.handleRemoveTokens will be called as a hint to persist the change in your controller view or other application state

• select() programmatically creates a full selection on the underlying textual input such that a press of the Backspace key would fully clear the input

• setValue(value: string) sets the underlying textual input to the specified text and updates internal state; do not use this method when using Typeahead as a "controlled input"

Props

Note: only top-level props are in the README, for the full list check out the website.

Required Props

There are no required props.

Optional Props

Name	Type	Default Value	Description
algorithm	Typeahead.mode.STARTS_WITH or Typeahead.mode.FUZZY or object	Typeahead.mode.FUZZY	the mechanism used to identify and mark matching substrings; a custom set can be provided as an object (see the properties below)
clearOnSelection	bool	false	if `true`, clears the input text when a (partial) match is selected
entities	arrayOf(object)	[]	an array of objects that user input is filtered against; at a minimum, each object must have a `text` property and any other supplied property is passed through to the resulting DOM element
handleAddToken	function	noop	function handler that is called when an entity is selected by the user and a token should be created
handleNewSelection	function	noop	function handler that is called when one or more tokens are selected by the user via click or keyboard actions; called with what the new selection should be
handleRemoveTokens	function	noop	function handler that is called when one or more tokens are removed by the user via clicking the "close" button or pressing the `Backspace` key while tokens are selected
hidePlaceholderOnFocus	bool	true	triggers the placeholder to disappear when the input field is focused, reappears when the user has tabbed away or focus is moved
hint	bool	null	renders a disabled textfield with the full text of the currently selected input hint; will remain blank if the matched substring is not at the beginning of the user input
hintProps	object	{}	any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes); applied to the `.b-typeahead-hint` HTML element
inputProps	object	{ type: 'text', }	props to be passed through to the input node, `.b-textual-input`; this includes the standard set of React input props like `defaultValue`, `value`, `name`, `placeholder`, `autoFocus`, etc.
matchWrapperProps	object	{}	any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes); applied to the `.b-typeahead-match-wrapper` HTML element
offscreenClass	string	'b-offscreen'	the "offscreen" class used by your application; specifically to retain [ARIA navigability](http://snook.ca/archives/html_and_css/hiding-content-for-accessibility) as `display: none` excludes the element from consideration
onComplete	function	noop	called when the user presses `Enter` with no autosuggest hint available, indicating that input is complete
onEntityHighlighted	function	noop	called with the index of the highlighted entity due to keyboard selection
onEntitySelected	function	noop	called with the index of the entity selected by the user
tokenCloseComponent	ReactElement	X	the JSX used for the close button itself
tokenCloseVisible	bool	true	determines if the `.b-tokenfield-token-close` element should be rendered for each token
tokens	arrayOf(number)	[]	the indexes of entities that should be rendered as "tokens" in the component UI
tokensSelected	arrayOf(number)	[]	the indexes of tokenized entities that are part of an active selection; the user can press `Backspace` to trigger `handleRemoveTokens`