woocommerce/plugins/woocommerce-admin/docs/components/packages/search.md

64 lines
1.2 KiB
Markdown
Raw Normal View History

`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
-----
### `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**
2018-12-11 01:50:26 +00:00
- Type: One of: 'countries', 'coupons', 'customers', 'emails', 'orders', 'products', 'product_cats', '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
2018-12-11 01:50:26 +00:00
- id: One of type: number, string
- label: String
- Default: `[]`
2018-12-17 11:22:58 +00:00
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.
2018-10-10 03:58:34 +00:00
### `inlineTags`
- Type: Boolean
- Default: `false`
Render tags inside input, otherwise render below input.
### `staticResults`
- Type: Boolean
- Default: `false`
Render results list positioned statically instead of absolutely.
2018-10-10 03:58:34 +00:00