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

    Interface ContributeClipboardCommandsOptions

    Options for contributeClipboardCommands.

    interface ContributeClipboardCommandsOptions {
        editModeHandler: EditModeHandler;
        element?: () => HTMLElement | null;
        globalClipboard: GlobalClipboardLike;
        notifier?: IReactNotifier;
        onClipboardUpdate?: (reference: ReferenceItem<any> | null) => void;
        onPaste?: (reference: ReferenceItem, args: SheetPasteOptions) => void;
    }

    Hierarchy (View Summary)

    Index
    editModeHandler element? globalClipboard notifier? onClipboardUpdate? onPaste?
    editModeHandler: EditModeHandler

    The app-wide edit-mode bus (useEditMode() handler). Copy/cut publish the marching-ants mode onto it (the SheetClipboardLayer view reads it back); paste clears it; format-painter toggles it. Required — the marquee and format-painter can't work without it.

    element?: () => HTMLElement | null

    The focus/paste target element (the grid stage). Copy/paste guard on it and refocus it after paste. Points at the pane stage.

    globalClipboard: GlobalClipboardLike

    The global clipboard handle (useGlobalClipboard()). Copy writes references here; paste reads them. The insert-copied-cells path in contributeSheetCommands reads the same handle, so a copy through this contributor makes "insert copied cells" light up.

    notifier?: IReactNotifier

    Busy + error UI for the copy/paste flows.

    onClipboardUpdate?: (reference: ReferenceItem<any> | null) => void

    Notified when the clipboard reference changes (null = cleared).

    onPaste?: (reference: ReferenceItem, args: SheetPasteOptions) => void

    Notified after a paste completes.

    Settings
    Member Visibility

    On This Page
    Properties