@openfin/workspace-platform 9.1.8 → 9.1.10

package/client-api/src/dock.d.ts

@@ -3,18 +3,33 @@ import { RegistrationMetaInfo } from './shapes';
 export * from './shapes/dock';
 /**
  * Registers a Dock provider
+ * @returns promise - invokes action
+ * ```ts
+ * await Dock.register(provider)
+ * ```
  */
 export declare const register: (provider: DockProvider) => Promise<RegistrationMetaInfo>;
 /**
  * Deregister a Dock provider
+ * @returns promise - invokes action
+ * ```ts
+ * await Dock.deregister();
+ * ```
  */
 export declare const deregister: () => Promise<void>;
 /**
  * API function to minimize Dock
  * @returns promise - invokes action
+ * ```ts
+ * await Dock.minimize();
+ * ```
  */
 export declare const minimize: () => Promise<void>;
 /**
  * Shows Dock window if enabled & registered
+ * @returns promise - invokes action
+ * ```ts
+ * await Dock.show();
+ * ```
  */
 export declare const show: () => Promise<void>;

package/client-api/src/shapes/dock.d.ts

@@ -3,6 +3,14 @@ import { ProviderInfo } from './provider';
 /**
  * Allows you to hide buttons for different Workspace components in the Dock UI.
  * By default, all components are shown.
+ * ```ts
+ * const workspaceComponentButtonOptions: WorkspaceComponentButtonOptions = {
+ *   hideHomeButton: true,
+ *   hideWorkspacesButton: true,
+ *   hideNotificationsButton: true,
+ *   hideStorefrontButton: true
+ * }
+ * ```
  */
 export interface WorkspaceComponentButtonOptions {
     /**
@@ -38,6 +46,15 @@ export declare enum DockButtonNames {
 /**
  * Configuration of a dock action button
  * When you add a custom button to the Dock, you must also provide details about the custom action.
+ * ```ts
+ * const sampleDockButton: DockButtonConfig = {
+ *   tooltip: 'Sample Button 1',
+ *   iconUrl: 'https://www.openfin.co/favicon-32x32.png',
+ *   action: {
+ *       id: 'sampleButton1'
+ *   }
+ * }
+ * ```
  */
 export interface DockButtonConfig extends CustomButtonConfig {
     type?: DockButtonNames.ActionButton;
@@ -45,6 +62,31 @@ export interface DockButtonConfig extends CustomButtonConfig {
 /**
  * Configuration of a dock dropdown button
  * When you add a dropdown button to the Dock, you must also specify the buttons to display in the dropdown.
+ * ```ts
+ * const sampleDropdownButton1: DockDropdownConfig = {
+ *   type: DockButtonNames.DropdownButton,
+ *   tooltip: 'Sample Dropdown Button',
+ *   iconUrl: 'https://www.openfin.co/favicon-32x32.png',
+ *   options: [
+ *     {
+ *       tooltip: 'Dropdown Button 1',
+ *       iconUrl: 'https://www.openfin.co/favicon-32x32.png',
+ *       action: {
+ *          id: 'dropdownButton1',
+ *          customData: "dropdownButton1 clicked"
+ *       }
+ *     },
+ *     {
+ *       tooltip: 'Dropdown Button 2',
+ *       iconUrl: 'https://www.openfin.co/favicon-32x32.png',
+ *       action: {
+ *           id: 'dropdownButton2',
+ *           customData: "dropdownButton2 clicked"
+ *       }
+ *     }
+ *   ]
+ * }
+ * ```
  */
 export interface DockDropdownConfig extends CustomDropdownConfig {
     type: DockButtonNames.DropdownButton;
@@ -53,6 +95,82 @@ export interface DockDropdownConfig extends CustomDropdownConfig {
  * Dock button types
  */
 export declare type DockButton = DockButtonConfig | DockDropdownConfig;
+/**
+ * <h3>Sample DockProvider definition.</h3>
+ *
+ * Import required dependencies.
+ * ```ts
+ * import { Dock, DockProvider, DockButtonNames } from '@openfin/workspace';
+ * import { CustomDropdownItemActionPayload, init } from "@openfin/workspace-platform";
+ * ```
+ *
+ * Create provider object to pass to the static `register` function of the `Dock` type.
+ *
+ * ```ts
+ * const provider: DockProvider = {
+ *   id: 'provider-id',
+ *   title: 'Sample Dock',
+ *   icon: 'https://www.openfin.co/favicon-32x32.png',
+ *   buttons: [
+ *     {
+ *       tooltip: 'Sample Button 1',
+ *       iconUrl: 'https://www.openfin.co/favicon-32x32.png',
+ *       action: {
+ *         id: 'sampleButton1'
+ *       }
+ *     },
+ *     {
+ *       type: DockButtonNames.DropdownButton,
+ *       tooltip: 'Sample Dropdown Button',
+ *       iconUrl: 'https://www.openfin.co/favicon-32x32.png',
+ *       options: [
+ *         {
+ *           tooltip: 'Dropdown Button 1',
+ *           iconUrl: 'https://www.openfin.co/favicon-32x32.png',
+ *           action: {
+ *              id: 'dropdownButton1',
+ *              customData: "dropdownButton1 clicked"
+ *           }
+ *         },
+ *         {
+ *           tooltip: 'Dropdown Button 2',
+ *           iconUrl: 'https://www.openfin.co/favicon-32x32.png',
+ *           action: {
+ *               id: 'dropdownButton2',
+ *               customData: "dropdownButton2 clicked"
+ *           }
+ *         }
+ *       ]
+ *     }
+ *   ]
+ * };
+ * ```
+ *
+ *
+ * Initialize ``workspace`` with ``customActions`` to be invoked by dock dropdown.
+ *```ts
+ * await init({
+ *     browser: {},
+ *     customActions: {
+ *         "dropdownButton1": async (payload: CustomDropdownItemActionPayload) => {
+ *             alert(payload.customData)
+ *         },
+ *         "dropdownButton2": async (payload: CustomDropdownItemActionPayload) => {
+ *             alert(payload.customData)
+ *         }
+ *      }
+ * });
+ *```
+ *
+ * Register dock ``provider`` object.
+ * ```ts
+ * await Dock.register(provider);
+ * ```
+ * Show Dock.
+ * ```ts
+ * await Dock.show();
+ * ```
+ */
 export interface DockProvider extends ProviderInfo {
     /**
      * Controls the visibility of buttons for workspace components on the Dock.

package/client-api-platform/src/init/cleanup.d.ts

@@ -1 +1,7 @@
-export default function registerViewCleanUp(): void;
+export declare function registerViewCleanUp(): void;
+/**
+ * Cleanup browser modals.
+ *
+ * Once the last OpenFin Browser window is closed, any remaining modals will close.
+ */
+export declare const registerBrowserModalsCleanup: () => Promise<void>;