OpenFin Workspace API
    Preparing search index...

    Interface DockDropdownConfig

    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.

    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',
    },
    },
    {
    tooltip: 'Button with sub-options',
    options: [
    {
    tooltip: 'Nested button 1',
    iconUrl: 'https://www.openfin.co/favicon-32x32.png',
    action: {
    id: 'nestedButton1',
    customData: 'nestedButton1 clicked',
    },
    },
    ],
    },
    ],
    };
    interface DockDropdownConfig {
        action?: never;
        disabled?: boolean;
        iconUrl?: string;
        options: (CustomButtonConfig | CustomDropdownConfig)[];
        parentHover?: boolean;
        tooltip: string;
        type: DropdownButton;
    }

    Hierarchy (View Summary)

    Index
    action?: never
    disabled?: boolean

    Disable custom button true or false

    iconUrl?: string

    icon URL for icon image

    Options that will be displayed in the dropdown

    parentHover?: boolean
    tooltip: string

    Button name text when hovered over