Home > @activeviam/activeui-sdk > ShareActionParameters

ShareActionParameters interface

Displays a popup that allows to edit the permissions of a saved bookmark, and to get a shareable URL for it.

Signature:

export interface ShareActionParameters

Remarks

This action is enabled: - On a root dock that is already saved as a bookmark, and has no unsaved changes. - On a bookmark node of the bookmark tree.

The optional urlPattern parameter is an object describing the URL to generate for a given bookmark, discriminated on its type: you can specify a pattern for dashboards, a pattern for widgets, and a default pattern. The way each pattern works is simple: any occurrence of "${bookmarkId} will be replaced by the relevant bookmark id. If no pattern is specified for a bookmark of a given type, then calling the Share action on such a bookmark will not show any URL in the generated popup. Note that only absolute paths are supported.

Let's take a look at an example.

Suppose that your application is deployed at http://localhost:3000, and the urlPattern is specified as follows: urlPattern: { dashboard: "http://localhost:3000/#/dashboard/${bookmarkId}", default: " http://localhost:3000/#/widget/${bookmarkId}" } Then here are some URLs that would be generated when executing the Share action in different scenarios: - On a dashboard bookmark with id bf4 => http://localhost:3000/#/dashboard/bf4 - On a pivot-table bookmark with id ff7 => http://localhost:3000/#/widget/ff7

Properties

PropertyTypeDescription
urlPatternUrlPattern