78 lines
1.5 KiB
Markdown
78 lines
1.5 KiB
Markdown
`Search` (component)
|
|
====================
|
|
|
|
A search box which autocompletes results while typing, allowing for the user to select an existing object
|
|
(product, order, customer, etc). Currently only products are supported.
|
|
|
|
Props
|
|
-----
|
|
|
|
### `allowFreeTextSearch`
|
|
|
|
- Type: Boolean
|
|
- Default: `false`
|
|
|
|
Render additional options in the autocompleter to allow free text entering depending on the type.
|
|
|
|
### `className`
|
|
|
|
- Type: String
|
|
- Default: null
|
|
|
|
Class name applied to parent div.
|
|
|
|
### `onChange`
|
|
|
|
- Type: Function
|
|
- Default: `noop`
|
|
|
|
Function called when selected results change, passed result list.
|
|
|
|
### `type`
|
|
|
|
- **Required**
|
|
- Type: One of: 'categories', 'countries', 'coupons', 'customers', 'downloadIps', 'emails', 'orders', 'products', 'taxes', 'usernames', 'variations'
|
|
- Default: null
|
|
|
|
The object type to be used in searching.
|
|
|
|
### `placeholder`
|
|
|
|
- Type: String
|
|
- Default: null
|
|
|
|
A placeholder for the search input.
|
|
|
|
### `selected`
|
|
|
|
- Type: Array
|
|
- id: One of type: number, string
|
|
- label: String
|
|
- Default: `[]`
|
|
|
|
An array of objects describing selected values. If the label of the selected
|
|
value is omitted, the Tag of that value will not be rendered inside the
|
|
search box.
|
|
|
|
### `inlineTags`
|
|
|
|
- Type: Boolean
|
|
- Default: `false`
|
|
|
|
Render tags inside input, otherwise render below input.
|
|
|
|
### `showClearButton`
|
|
|
|
- Type: Boolean
|
|
- Default: `false`
|
|
|
|
Render a 'Clear' button next to the input box to remove its contents.
|
|
|
|
### `staticResults`
|
|
|
|
- Type: Boolean
|
|
- Default: `false`
|
|
|
|
Render results list positioned statically instead of absolutely.
|
|
|