Interface ReferenceModeHandler

The imperative handle useReferenceMode returns — mirrors useEditMode's getMode/setMode.

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

Hierarchy (View Summary)

ReferenceModeHandler
- ReferenceModeStore

Index

Methods

getMode setMode

Methods

getMode

getMode(): ReferenceModeState | null

Returns ReferenceModeState | null

setMode

setMode(
    next:
        | ReferenceModeState
        | ((prev: ReferenceModeState | null) => ReferenceModeState | null)
        | null,
): void
Parameters
- next:
      | ReferenceModeState
      | ((prev: ReferenceModeState | null) => ReferenceModeState | null)
      | null
Returns void