Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

References

Re-exports DockButton
Re-exports DockButtonConfig
Re-exports DockButtonNames
Re-exports DockDropdownConfig
Re-exports DockProvider
Re-exports DockProviderConfig
Re-exports DockProviderConfigWithIdentity
Re-exports DockProviderRegistration
Re-exports WorkspaceButton
Re-exports WorkspaceButtonsConfig
Re-exports WorkspaceComponentButtonOptions

Functions

  • deregister(): Promise<void>
  • API function to Deregister a Dock provider

    Returns Promise<void>

    a promise that resolves once the dock is deregistered

    await Dock.deregister();
    
  • minimize(): Promise<void>
  • API function to minimize Dock

    Returns Promise<void>

    a promise that resolves once the dock is minimized

    await Dock.minimize();
    
  • Registers a Dock provider

    Parameters

    Returns Promise<DockProviderRegistration>

    promise - invokes action

    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'
    }
    }
    ]
    };

    await Dock.register(provider)
  • show(): Promise<void>
  • API function to show Dock

    Returns Promise<void>

    a promise that resolves once the dock is shown

    await Dock.show();
    

Generated using TypeDoc