About the Item Selector API

The Item Selector API lets you open item selection modals in the Wix dashboard, so Wix users can select items from a Wix service without leaving your extension. Use it to build flows where Wix users need to pick resources from their site data, such as choosing products to feature, blog posts to display, or contacts to target.

Providers

A provider determines which Wix service populates the item selector modal. You specify the provider using a providerKey string when calling openItemSelector(). Each provider corresponds to a specific type of site data, such as products, contacts, or site pages.

Some providers require a specific Wix business solution to be installed on a site. For example, the Products provider requires Wix Stores. Others are available on all Wix sites by default.

For the full list of supported providers and their requirements, see Available providers.

Customizing the modal

When calling openItemSelector(), you can pass options to tailor the modal to your use case:

• Limit selections: Use maxSelected to set how many items a Wix user can select. Defaults to 1.
• Custom title and button text: Use title and primaryButtonText to replace the default modal header and action button label with text that fits your context.
• Pre-selected items: Use initialSelect to pass an array of item IDs that appear as already selected when the modal opens. This is useful when editing an existing selection.

Before you begin

It's important to note the following points before starting to code:

• Providers that depend on a Wix business solution won't work if that solution isn't installed on the site.
• This API can only be called from a dashboard extension context.

Terminology

• Provider: A Wix service that supplies the items shown in the selector modal, identified by a providerKey string.
• Item: A selectable entry in the modal, representing a resource from the provider, such as a product, blog post, or contact.

See also

• openItemSelector()