SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface TaskPaneProps<T, A>

    Props passed to a registered task pane component.

    Task panes are real React components (rendered as <Component {...props}/>), so they may use hooks freely. The host's ref arrives as a regular prop (React 19 style); forward it to the pane's root element. Extends HTML attributes because hosts may inject presentation props (propsPane) that the pane is expected to spread onto its root.

    interface TaskPaneProps<T = any, A = any> {
        args?: A;
        entryKey: string;
        frame?: IFrame;
        model?: T;
        ref?: Ref<any>;
    }

    Type Parameters

    • T = any

      The model (the workbook, for the built-in panes).

    • A = any

      The activation argument, if the pane accepts one — see args.

    Hierarchy

    • HTMLAttributes<HTMLElement>
      • TaskPaneProps
    Index
    args?: A

    What the activating call asked this pane to show — ActivateFrameOptions.args, delivered verbatim.

    The pane defines the shape; the area only carries it. It is scoped to one activation rather than to the pane's lifetime: activating again without it clears it, and re-delivering the same payload means passing it again. So a pane treats an arriving value as an EVENT — react to it changing, not to its presence, or a re-render replays it.

    undefined is the ordinary case: opened from the ribbon, a pane is asked for nothing in particular.

    entryKey: string

    The key used to register the taskPane.

    frame?: IFrame
    model?: T
    ref?: Ref<any>

    Ref to the task pane's root element (React 19 ref-as-prop).