SheetXL - v1.0.2
    Preparing search index...

    Interface TaskPaneEntry

    interface TaskPaneEntry {
        component: ComponentType<TaskPaneProps<any, any>>;
        componentCommandButton?: ComponentType<CommandButtonProps<any, any, void>>;
        componentTitle?: ComponentType<TaskPaneTitleProps>;
        contributionPoints?: string[];
        keepMounted?: boolean;
        key: string;
        createCommand?(taskPaneArea: ITaskPaneArea): ICommandDefinition;
        getIcon?(
            catalogIcon: string | undefined,
        ):
            | string
            | ReactElement<unknown, string | JSXElementConstructor<any>>
            | undefined;
        getTitle?(catalogTitle: string | undefined): string;
    }
    Index
    component componentCommandButton? componentTitle? contributionPoints? keepMounted? key
    createCommand? getIcon? getTitle?
    component: ComponentType<TaskPaneProps<any, any>>

    The task pane component.

    This is rendered as a React element (<Component {...props}/>), so it is a real component: hooks are allowed, and it participates in reconciliation like any other component. The host's ref is delivered as a regular prop (TaskPaneProps.ref, React 19 style) — forward it to the pane's root element.

    componentCommandButton?: ComponentType<CommandButtonProps<any, any, void>>

    Optional component for a button that can be placed in the command bar.

    If not provided a default button will be created. Rendered as a React element — hooks are allowed.

    componentTitle?: ComponentType<TaskPaneTitleProps>

    Optional component to render a custom title for the task pane.

    Rendered as a React element — hooks are allowed.

    contributionPoints?: string[]

    The command paths to use to open the task pane.

    • Must not change. If this is not provided the task pane can only be opened programmatically.
    keepMounted?: boolean

    If true, the pane stays mounted (hidden with display: none) while another pane is active, instead of unmounting on switch. Opt in for panes that are expensive or fragile to (re)mount — the script editor, whose Monaco/CDN-loader/worker setup is built around a single mount lifecycle (remounting it re-runs the AMD loader shim + global juggling and re-creates the language workers, which fails on the way back). Leave unset for ordinary panes so they keep the default unmount-on-hide behavior (state resets, memory freed).

    false
    key: string

    The unique key for the task pane.

    • Must not change.

    • Parameters

      Returns ICommandDefinition

    • The icon to display to identify the task pane: an icon key or a React element.

      Parameters

      • catalogIcon: string | undefined

        That record's icon key, if there is one.

      Returns string | ReactElement<unknown, string | JSXElementConstructor<any>> | undefined

      Omit it to use the icon of the command catalog record that shares the pane's key.

    • The title to display to identify the task pane. Call t() here to translate it.

      Parameters

      • catalogTitle: string | undefined

        That record's label, if there is one, for a title that adjusts it.

      Returns string

      Omit it to use the label of the command catalog record that shares the pane's key, which is translated with the rest of the chrome. With neither, the title is the key.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods