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

    Interface ReferenceModeStore

    A reference-mode bus instance — one shared point/show state and its subscribers. The store is a first-class value (not a module global) so a client can mount its OWN bus above a subtree via ReferenceModeProvider: their custom picker widget and the Studio/Workbook under the same provider share that instance, making a third-party producer first-class with no Studio involvement. Everything below the provider — layers, header layers, inputs, the keymap hosts — resolves the store through useReferenceMode/useReferenceModeStore.

    interface ReferenceModeStore {
        getMode(): ReferenceModeState | null;
        setMode(
            next:
                | ReferenceModeState
                | ((prev: ReferenceModeState | null) => ReferenceModeState | null)
                | null,
        ): void;
        subscribe(listener: () => void): () => void;
    }

    Hierarchy (View Summary)

    Index
    • Subscribe to any state change. Returns the remover.

      Parameters

      • listener: () => void

      Returns () => void