Set of enhancements for input control
The intention of creating this library was to bring input
component out of the dropdown/autocomplete/whatever code, so it could be easily replaced with your custom component, and also to split independent functionality into different components, which could be combined with each other (still not quite sure it was worth it, though).
There are currently four components:
All components accept function
as a child, providing props as a first argument, which you should pass to your input
component. If there is nothing else except input
, it could be passed as a child directly (for simplicity).
<Combobox />
is a combination of Dropdown
, Autosize
and/or Autocomplete
components.
http://alexkuz.github.io/react-input-enhancements/
Autosize
resizes component to fit it's content.
<Autosize defaultValue={value}
minWidth={100}>
{(inputProps, { width }) =>
<input type='text' {...inputProps} />
}
</Autosize>
value
string - Input value (for a controlled component)defaultValue
string - Initial value (for a uncontrolled component)getInputElement
function() - Optional callback that provides input DOM elementdefaultWidth
number - Minimum input width
Autocomplete
prompts a value based on provided options
(see also react-autocomplete for the same behaviour)
<Autocomplete defaultValue={value}
options={options}>
{(inputProps, { matchingText, value }) =>
<input type='text' {...inputProps} />
}
</Autocomplete>
value
string - Input value (for a controlled component)defaultValue
string - Initial value (for a uncontrolled component)getInputElement
function - Optional callback that provides input DOM elementoptions
array - Array of options that are used to predict a value
options
is an array of strings or objects with a text
or value
string properties.
Dropdown
shows a dropdown with a (optionally filtered) list of suitable options.
<Dropdown defaultValue={value}
options={options}>
{(inputProps, { textValue }) =>
<input type='text' {...inputProps} />
}
</Dropdown>
value
string - Input value (for a controlled component)defaultValue
string - Initial value (for a uncontrolled component)options
array - Array of shown optionsonRenderOption
function(className, style, option) - Renders option in listonRenderCaret
function(className, style, isActive, children) - Renders a caretonRenderList
function(className, style, isActive, listShown, children, header) - Renders list of optionsonRenderListHeader
function(allCount, shownCount, staticCount) - Renders list headerdropdownClassName
string - Dropdown root element class namedropdownProps
object - Custom props passed to dropdown root elementoptionFilters
array - List of option filters
options
is an array of strings or objects with a shape:
value
- "real" value of on optiontext
- text used as input value when option is selectedlabel
- text or component rendered in liststatic
- option is never filtered out or sorteddisable
- option is not selectable
null
option is rendered as a separator
optionFilters
is an array of filters for options (for convenience). By default, these filters are used:
filters.filterByMatchingTextWithThreshold(20)
- filters options by matching value, if options length is more than 20filters.sortByMatchingText
- sorting by matching valuefilters.limitBy(100)
- cuts options longer than 100filters.notFoundMessage('No matches found')
- shows option with 'No matches found' label if all options are filtered outfilters.filterRedudantSeparators
- removes redudant separators (duplicated or at the begin/end of the list)
Mask
formats input value.
<Mask defaultValue={value}
pattern='0000-0000-0000-0000'>
{(inputProps, { value }) =>
<input type='text' {...inputProps} />
}
</Mask>
value
string - Input value (for a controlled component)defaultValue
string - Initial value (for a uncontrolled component)getInputElement
function() - Optional callback that provides input DOM elementpattern
string - String formatting pattern. Only '0' (digit) or 'a' (letter) pattern chars are currently supported.emptyChar
string - Character used as an empty symbol (' '
by default)placeholder
string - If set, it is shown whenunmaskedValue
is emptyonUnmaskedValueChange
function(text) - Fires when value is changed, providing unmasked value
DatePicker
uses Mask
to format date and shows calendar (react-date-picker by default) in popup.
<DatePicker defaultValue={moment(value).format('ddd DD/MM/YYYY')}
placeholder={moment().format('ddd DD/MM/YYYY')}
pattern='ddd DD/MM/YYYY'
locale='en'>
{(inputProps, { value }) =>
<input type='text' {...inputProps} />
}
</DatePicker>
value
string - Input value (for a controlled component)defaultValue
string - Initial value (for a uncontrolled component)pattern
string - Date formatting pattern. For now, only these tokens are supported:DD
- day of monthMM
- monthYYYY
- yearddd
- day of week (not editable)
placeholder
string - If set, it is shown whenunmaskedValue
is emptylocale
string - Date localeonRenderCalendar
function(className, style, date, isActive, popupShown, onSelect, locale) - Returns calendar component shown in popup (react-date-picker by default)onChange
function(date) - Fires when date is selected, providing moment.js object
Combobox
combines Dropdown
, Autosize
and/or Autocomplete
components.
<Combobox defaultValue={value}
options={options}
autosize
autocomplete>
{(inputProps, { matchingText, width }) =>
<input type='text' {...inputProps} />
}
</Combobox>
Autosize
and Autocomlete
are enabled with corresponding bool props, other properties are proxied to Dropdown
component.
See demo for code examples.
- react-autocomplete - Dropdown with autocompletion by Ryan Florence (that led me to create this library)
- react-maskedinput - More advanced masked input by Jonny Buchanan