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

    Interface ItemsPaneArgs<P, T>

    The activation argument the built-in list panes (conditional formats, data validations, protected ranges) understand.

    Threaded from a command through activateTaskPane(key, { args }) — see ItemsDescriptor.createSeededDraft in @sheetxl/studio-mui for the receiving end.

    interface ItemsPaneArgs<P = any, T = any> {
        draft?: P;
        edit?: T;
        insert?: boolean;
    }

    Type Parameters

    • P = any
    • T = any
    Index
    draft?: P

    Open the pane editing a NEW, uncommitted item seeded with these properties, rather than on its list.

    The pane mints the draft itself (anchored to the current selection, like its own add button): this is the feature's properties shape, not a model object, so it survives being handed across a workbook the caller does not hold.

    Nothing is written until the user saves — which is the point of seeding a draft rather than adding a rule and opening the pane on top of it.

    edit?: T

    Open the pane editing this EXISTING item — precisely what the item's own card edit does — rather than on its list. What an "Edit…" reaching the pane from elsewhere (the name box's menu) asks for.

    The item itself, not its properties: it is already committed, and the pane needs its identity to write the edit back to. Ignored by a pane whose list is read-only; a draft or insert wins when both are given.

    insert?: boolean

    Open the pane on a NEW, uncommitted item — precisely what its own add button mints — rather than on its list. What a "New Rule…" command asks for.

    The same request as draft, with nothing to seed; a draft wins when both are given. Ignored by a pane whose list is read-only, which shows no add button either.