ChemPal Documentation - v0.0.13-beta.5
    Preparing search index...

    Interface StatusBarContextValue

    Shape of the status-bar context: the current status text plus setters for sticky and transient (auto-clearing) messages.

    const { setStatusText, flashStatusText } = useStatusBar();
    setStatusText("https://example.com"); // sticky until cleared
    flashStatusText("Copied!", 1500);     // clears after 1.5s

    Source

    interface StatusBarContextValue {
      /** Current status message, or `null` when hidden. */
      statusText: string | null;
      /** Sets a sticky status message (pass `null` to clear). */
      setStatusText: (text: string | null) => void;
      /** Shows a message that auto-clears after `durationMs` (default 1000ms). */
      flashStatusText: (text: string, durationMs?: number) => void;
    }
    interface StatusBarContextValue {
        statusText: null | string;
        setStatusText: (text: null | string) => void;
        flashStatusText: (text: string, durationMs?: number) => void;
    }
    Index

    Properties

    statusText setStatusText flashStatusText

    Properties

    statusText: null | string

    Current status message, or null when hidden.

    setStatusText: (text: null | string) => void

    Sets a sticky status message (pass null to clear).

    flashStatusText: (text: string, durationMs?: number) => void

    Shows a message that auto-clears after durationMs (default 1000ms).

    Settings

    Member Visibility

    On This Page

    Properties