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

723 B

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

onChange

  • Type: Function
  • Default: noop

Function called when selected results change, passed result list.

type

  • Required
  • Type: One of: 'products', 'product_cats', 'orders', 'customers'
  • 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: Number
    • label: String
  • Default: []

An array of objects describing selected values.