Type Alias Props

Action panel to use when no list item matches the current search query.

List items or sections to render inside this list.

Whether to use Vicinae's builtin fuzzy filtering.

This is turned on by default unless a onSearchTextChange handler is passed, indicating that custom filtering is desired.

If true, a loading indicator is shown right below the search bar to indicate loading activity.

Whether to show the current list item's detail, if any. If the current list item does not have a detail, this does nothing.

The navigation title to display on the bottom left of the status bar, next to the command icon. This defaults to the name of the command.

Called every time the user modifies the search text by typing or editing. This can be throttled using the throttle prop.

Called every time the currently selected item changes. Note that this does not fire when transitioning from having a selected item to none at all.

Accessory to show on the right of the search input. The list component only supports rendering a dropdown, in order to provide more filtering options.

The placeholder to show in the search bar if there is no search query.

Bind this prop to the value of the search text. This is used to turn the List into a controlled component.

Throttle the search so that search text change events are sent after a short delay instead of instaneously. Highly recommended if you need to fetch data on every change.