Opens the editor's link picker for the selected component, letting a Wix user create or edit a link.
params accepts one of the following shapes:
For more information on this choice, see Picker arguments.
Connects the picker to a manifest data field, so the selected link saves to it automatically.
| Name | Type | Description |
|---|---|---|
dataItemKey | string | Key of a data field with dataType: 'link' in the manifest. The editor reads the current value, opens the picker, and saves the selection back to this field automatically. |
options.origin | string | Optional BI tag identifying where the picker was opened from in your panel, for example 'header-cta'. |
Opens the picker without connecting it to the manifest, so you decide what to do with the selected link.
| Name | Type | Description |
|---|---|---|
value | object | An existing link to pre-populate the picker with. |
options.origin | string | Optional BI tag identifying where the picker was opened from in your panel. |
options.linkTypes | string[] | Restricts the picker to specific link types, for example ['ExternalLink', 'PageLink']. |
options.appIds | string[] | Restricts dynamic-page link results to specific installed apps, by app definition ID. |
options.hideInnerRoute | boolean | Whether to hide the option to link to an inner route of a dynamic page, showing only the page itself. |
Promise<ElementLink | null | undefined>
The selected link, or null or undefined if the Wix user closes the picker without selecting anything.
Last updated: 8 September 2026