Skip to content

Commit 7f61805

Browse files
jakezateckyjakezatecky
committed
Document third parameter in filterCallback
Resolves #294.
1 parent 4a018f2 commit 7f61805

File tree

1 file changed

+31
-31
lines changed

1 file changed

+31
-31
lines changed

‎README.md‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -241,37 +241,37 @@ const onChange = (selected, selection, controlKey) => {
241241

242242
### All Properties
243243

244-
| Property | Type | Description | Default |
245-
| --------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------- | ---------------- |
246-
| `options` | array | **Required**. Specifies the list of options that may exist on either side of the dual list box. | |
247-
| `onChange` | function | **Required**. The handler called when the selected options change: `function(selected, selection, controlKey) {}`. | |
248-
| `alignActions` | string | A value specifying whether to align the action buttons to the `'top'` or `'middle'`. | `middle` |
249-
| `allowDuplicates` | bool | If true, duplicate options will be allowed in the selected list box. | `false` |
250-
| `available` | array | A subset of the `options` array to optionally filter the available list box. | `undefined` |
251-
| `availableRef` | function | A React function [ref][react-ref] to the "available" list box. | `null` |
252-
| `canFilter` | bool | If true, search boxes will appear above both list boxes, allowing the user to filter the results. | `false` |
253-
| `className` | string | An optional `className` to apply to the root node. | `null` |
254-
| `disabled` | bool | If true, both "available" and "selected" list boxes will be disabled. | `false` |
255-
| `filter` | object | A key-value map of `{ available: [value], selected: [value] }` to control the filter values (defaults to uncontrolled). | `null` |
256-
| `filterCallback` | function | The filter function to run on a given option and input string: `function(option, filterInput) {}`. See **Filtering**. | `() => { ... }` |
257-
| `getOptionLabel` | function | The function to resolve the **label** from an option. Defaults to `option => option.label`. | `() => { ... }` |
258-
| `getOptionValue` | function | The function to resolve the **value** from an option. Defaults to `option => option.value`. | `() => { ... }` |
259-
| `htmlDir` | string | The [directionality][mdn-directionality] of the component's elements. Set to `'rtl'` if using a right-to-left language. | `'ltr'` |
260-
| `icons` | object | A key-value pairing of action icons and their React nodes. See **Changing the Default Icons** for further info. | `{ ... }` |
261-
| `iconsClass` | string | A value specifying which overarching icon class to use. Built-in support for `fa5`, `fa6`, and `native` icons. | `'fa6'` |
262-
| `id` | string | An HTML ID prefix for the various sub elements. | `null` |
263-
| `lang` | object | A key-value pairing of localized text. See [`src/js/lang/default.js`][lang-file] for a list of keys. | `{ ... }` |
264-
| `moveKeys` | array | A list of [keyboard keys][mdn-key] that will trigger a toggle of the highlighted options. | `[' ', 'Enter']` |
265-
| `name` | string | A value for the `name` attribute on the hidden `<input />` element. This is potentially useful for form submissions. | `null` |
266-
| `onFilterChange` | function | A handler called when a filter input changes. Paired with `filter` when wanting to control the filter values. | `null` |
267-
| `preserveSelectOrder` | bool | If true, the order in which the available options are selected are preserved when the items are moved to the right. | `false` |
268-
| `required` | bool | If true, this component will require `selected` to be non-empty to pass a form validation | `false` |
269-
| `selected` | array | A list of the selected options appearing in the rightmost list box. | `[]` |
270-
| `selectedRef` | function | A React function [ref][react-ref] to the "selected" list box. | `null` |
271-
| `showHeaderLabels` | bool | If true, labels above both the available and selected list boxes will appear. These labels derive from `lang`. | `false` |
272-
| `showNoOptionsText` | bool | If true, text will appear in place of the available/selected list boxes when no options are present. | `false` |
273-
| `showOrderButtons` | bool | If true, a set of up/down buttons will appear near the selected list box to allow the user to re-arrange the items. | `false` |
274-
| `simpleValue` | bool | If true, the `selected` value passed in `onChange` is an array of string values. Otherwise, it is an array of options. | `true` |
244+
| Property | Type | Description | Default |
245+
| --------------------- | -------- |------------------------------------------------------------------------------------------------------------------------------| ---------------- |
246+
| `options` | array | **Required**. Specifies the list of options that may exist on either side of the dual list box. | |
247+
| `onChange` | function | **Required**. The handler called when the selected options change: `function(selected, selection, controlKey) {}`. | |
248+
| `alignActions` | string | A value specifying whether to align the action buttons to the `'top'` or `'middle'`. | `middle` |
249+
| `allowDuplicates` | bool | If true, duplicate options will be allowed in the selected list box. | `false` |
250+
| `available` | array | A subset of the `options` array to optionally filter the available list box. | `undefined` |
251+
| `availableRef` | function | A React function [ref][react-ref] to the "available" list box. | `null` |
252+
| `canFilter` | bool | If true, search boxes will appear above both list boxes, allowing the user to filter the results. | `false` |
253+
| `className` | string | An optional `className` to apply to the root node. | `null` |
254+
| `disabled` | bool | If true, both "available" and "selected" list boxes will be disabled. | `false` |
255+
| `filter` | object | A key-value map of `{ available: [value], selected: [value] }` to control the filter values (defaults to uncontrolled). | `null` |
256+
| `filterCallback` | function | The filter function to run on a given option and input string: `function(option, filterInput, props) {}`. See **Filtering**. | `() => { ... }` |
257+
| `getOptionLabel` | function | The function to resolve the **label** from an option. Defaults to `option => option.label`. | `() => { ... }` |
258+
| `getOptionValue` | function | The function to resolve the **value** from an option. Defaults to `option => option.value`. | `() => { ... }` |
259+
| `htmlDir` | string | The [directionality][mdn-directionality] of the component's elements. Set to `'rtl'` if using a right-to-left language. | `'ltr'` |
260+
| `icons` | object | A key-value pairing of action icons and their React nodes. See **Changing the Default Icons** for further info. | `{ ... }` |
261+
| `iconsClass` | string | A value specifying which overarching icon class to use. Built-in support for `fa5`, `fa6`, and `native` icons. | `'fa6'` |
262+
| `id` | string | An HTML ID prefix for the various sub elements. | `null` |
263+
| `lang` | object | A key-value pairing of localized text. See [`src/js/lang/default.js`][lang-file] for a list of keys. | `{ ... }` |
264+
| `moveKeys` | array | A list of [keyboard keys][mdn-key] that will trigger a toggle of the highlighted options. | `[' ', 'Enter']` |
265+
| `name` | string | A value for the `name` attribute on the hidden `<input />` element. This is potentially useful for form submissions. | `null` |
266+
| `onFilterChange` | function | A handler called when a filter input changes. Paired with `filter` when wanting to control the filter values. | `null` |
267+
| `preserveSelectOrder` | bool | If true, the order in which the available options are selected are preserved when the items are moved to the right. | `false` |
268+
| `required` | bool | If true, this component will require `selected` to be non-empty to pass a form validation | `false` |
269+
| `selected` | array | A list of the selected options appearing in the rightmost list box. | `[]` |
270+
| `selectedRef` | function | A React function [ref][react-ref] to the "selected" list box. | `null` |
271+
| `showHeaderLabels` | bool | If true, labels above both the available and selected list boxes will appear. These labels derive from `lang`. | `false` |
272+
| `showNoOptionsText` | bool | If true, text will appear in place of the available/selected list boxes when no options are present. | `false` |
273+
| `showOrderButtons` | bool | If true, a set of up/down buttons will appear near the selected list box to allow the user to re-arrange the items. | `false` |
274+
| `simpleValue` | bool | If true, the `selected` value passed in `onChange` is an array of string values. Otherwise, it is an array of options. | `true` |
275275

276276
#### Option Properties
277277

0 commit comments

Comments
 (0)