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

    Interface TaskPaneAreaProps<T>

    interface TaskPaneAreaProps<T = any> {
        alwaysShowStrip?: boolean;
        componentStrip?: ComponentType<TaskPaneStripProps>;
        componentTitle?: ComponentType<TaskPaneTitleProps>;
        model?: T;
        onClose?: () => void;
        onOpen?: () => void;
        propsFrame?: HTMLAttributes<HTMLDivElement>;
        propsPane?: HTMLAttributes<HTMLDivElement>;
        ref?: Ref<ITaskPaneAreaElement>;
        registry?: ITaskPaneRegistry;
        side?: "left" | "right";
        wrapperFrame?: ComponentType<{ children?: ReactNode }>;
        wrapperPane?: ComponentType<{ children?: ReactNode }>;
    }

    Type Parameters

    • T = any

    Hierarchy

    • HTMLAttributes<HTMLDivElement>
      • TaskPaneAreaProps
    Index
    alwaysShowStrip? componentStrip? componentTitle? model? onClose? onOpen? propsFrame? propsPane? ref? registry? side? wrapperFrame? wrapperPane?
    alwaysShowStrip?: boolean

    If true always show the strip even with one pane.

    componentStrip?: ComponentType<TaskPaneStripProps>

    Override the default task pane strip component.

    componentTitle?: ComponentType<TaskPaneTitleProps>

    Override the default title component.

    If the registry also provides a custom title component that will be used instead.

    model?: T

    The model to pass to taskpane

    onClose?: () => void

    Called when the task pane is closed.

    This is called when the last task pane is deactivated but it does not actually close.

    onOpen?: () => void

    Called when the task pane is should open.

    This is called when the first task pane is activated but it does not actually open.

    propsFrame?: HTMLAttributes<HTMLDivElement>

    Props that can be injected to the frame

    propsPane?: HTMLAttributes<HTMLDivElement>

    Props that can be injected to pane

    ref?: Ref<ITaskPaneAreaElement>

    Reference to the underlying element.

    registry?: ITaskPaneRegistry

    Allow for custom registry of task panes.

    side?: "left" | "right"

    Whether the layout should be right to left. This will flip the order of the panes and the direction of the split.

    'right'
    wrapperFrame?: ComponentType<{ children?: ReactNode }>

    Wrap frame in a context.

    Rendered as <WrapperFrame>{frame}</WrapperFrame> — a real component, hooks are allowed.

    wrapperPane?: ComponentType<{ children?: ReactNode }>

    Allows users to Wrap pane children in Top level Context.

    Rendered as <WrapperPane>{pane}</WrapperPane> — a real component, hooks are allowed.

    Settings
    Member Visibility

    On This Page
    Properties