OpenFin Workspace API
    Preparing search index...

    Interface DockButtonConfig

    Configuration of a dock action button When you add a custom button to the Dock, you must also provide details about the custom action.

    const sampleDockButton: DockButtonConfig = {
    tooltip: 'Sample Button 1',
    iconUrl: 'https://www.openfin.co/favicon-32x32.png',
    action: {
    id: 'sampleButton1'
    }
    }
    interface DockButtonConfig {
        action: CustomActionSpecifier;
        disabled?: boolean;
        iconUrl?: string;
        options?: never;
        parentHover?: boolean;
        tooltip: string;
        type?: ActionButton;
    }

    Hierarchy (View Summary)

    Index

    Custom action once the button is clicked

    disabled?: boolean

    Disable custom button true or false

    iconUrl?: string

    icon URL for icon image

    options?: never
    parentHover?: boolean
    tooltip: string

    Button name text when hovered over