Skip to content

Update README formatting #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
damonLL wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README formatting #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 41 additions & 40 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,46 +113,47 @@ For multi-select inputs, when providing a custom `filterOptions` method, remembe
### Further options


Property | Type | Description
:-----------------------|:--------------|:--------------------------------
addLabelText | string | text to display when `allowCreate` is true
allowCreate | bool | allow new options to be created in multi mode (displays an "Add \<option> ?" item when a value not already in the `options` array is entered)
asyncOptions | func | function to call to get options
autoload | bool | whether to auto-load the default async options set
backspaceRemoves | bool | whether pressing backspace removes the last item when there is no input value
cacheAsyncResults | bool | enables the options cache for `asyncOptions` (default: `true`)
className | string | className for the outer element
clearable | bool | should it be possible to reset value
clearAllText | string | title for the "clear" control when `multi` is true
clearValueText | string | title for the "clear" control
delimiter | string | delimiter to use to join multiple values
disabled | bool | whether the Select is disabled or not
filterOption | func | method to filter a single option: `function(option, filterString)`
filterOptions | func | method to filter the options array: `function([options], filterString, [values])`
ignoreCase | bool | whether to perform case-insensitive filtering
inputProps | object | custom attributes for the Input (in the Select-control) e.g: `{'data-foo': 'bar'}`
isLoading | bool | whether the Select is loading externally or not (such as options being loaded)
labelKey | string | the option property to use for the label
matchPos | string | (any, start) match the start or entire string when filtering
matchProp | string | (any, label, value) which option property to filter on
multi | bool | multi-value input
name | string | field name, for hidden `<input />` tag
newOptionCreator | func | factory to create new options when `allowCreate` is true
noResultsText | string | placeholder displayed when there are no matching search results
onBlur | func | onBlur handler: `function(event) {}`
onChange | func | onChange handler: `function(newValue) {}`
onFocus | func | onFocus handler: `function(event) {}`
onInputChange | func | onInputChange handler: `function(inputValue) {}`
onOptionLabelClick | func | onClick handler for value labels: `function (value, event) {}`
optionRenderer | func | function which returns a custom way to render the options in the menu
options | array | array of options
placeholder | string | field placeholder, displayed when there's no value
searchable | bool | whether to enable searching feature or not
searchingText | string | message to display whilst options are loading via asyncOptions, or when `isLoading` is true
searchPromptText | string | label to prompt for search input
value | any | initial field value
valueKey | string | the option property to use for the value
valueRenderer | func | function which returns a custom way to render the value selected
Property | Type | Description
:------------------------------|:--------------|:--------------------------------------------------
addLabelText | string | text to display when `allowCreate` is true
allowCreate | bool | allow new options to be created in multi mode (displays an "Add \<option> ?" item when a value not already in the `options` array is entered)
asyncOptions | func | function to call to get options
autoload | bool | whether to auto-load the default async options set
backspaceRemoves | bool | whether pressing backspace removes the last item when there is no input value
cacheAsyncResults | bool | enables the options cache for `asyncOptions` (default: `true`)
className | string | className for the outer element
clearable | bool | should it be possible to reset value
clearAllText | string | title for the "clear" control when `multi` is true
clearValueText | string | title for the "clear" control
delimiter | string | delimiter to use to join multiple values
disabled | bool | whether the Select is disabled or not
filterOption | func | method to filter a single option: `function(option, filterString)`
filterOptions | func | method to filter the options array: `function([options], filterString, [values])`
ignoreCase | bool | whether to perform case-insensitive filtering
inputProps | object | custom attributes for the Input (in the Select-control) e.g: `{'data-foo': 'bar'}`
isLoading | bool | whether the Select is loading externally or not (such as options being loaded)
labelKey | string | the option property to use for the label
matchPos | string | (any, start) match the start or entire string when filtering
matchProp | string | (any, label, value) which option property to filter on
multi | bool | multi-value input
name | string | field name, for hidden `<input />` tag
newOptionCreator | func | factory to create new options when `allowCreate` is true
noResultsText | string | placeholder displayed when there are no matching search results
onBlur | func | onBlur handler: `function(event) {}`
onChange | func | onChange handler: `function(newValue) {}`
onFocus | func | onFocus handler: `function(event) {}`
onInputChange | func | onInputChange handler: `function(inputValue) {}`
onOptionLabelClick | func | onClick handler for value labels: `function (value, event) {}`
optionRenderer | func | function which returns a custom way to render the options in the menu
options | array | array of options
placeholder | string | field placeholder, displayed when there's no value
searchable | bool | whether to enable searching feature or not
searchingText | string | message to display whilst options are loading via asyncOptions, or when `isLoading` is true
searchPromptText | string | label to prompt for search input
value | any | initial field value
valueKey | string | the option property to use for the value
valueRenderer | func | function which returns a custom way to render the value selected


### Methods

Expand Down