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

    Interface NumberFormatPanelProps

    interface NumberFormatPanelProps {
        context?: () => ICell | null;
        disabled?: boolean;
        hideSample?: boolean;
        onChange: (code: string) => void;
        onCommit?: () => void;
        showQuickFormats?: boolean;
        value: string;
    }

    Hierarchy

    • Omit<React.HTMLAttributes<HTMLDivElement>, "onChange">
      • NumberFormatPanelProps
    Index
    context? disabled? hideSample? onChange onCommit? showQuickFormats? value
    context?: () => ICell | null

    Optional accessor for the cell whose value drives the live preview (and the workbook date-system/locale). Falls back to a category sample.

    disabled?: boolean

    Disable all controls.

    hideSample?: boolean

    Drop the panel's own sample line.

    For a host that already shows the formatted cell — the format task pane's shared preview — where a second sample of the same value is noise.

    onChange: (code: string) => void

    Called with the new format code whenever the user changes a control.

    onCommit?: () => void

    Called when the user presses Enter (so a hosting dialog can commit/close). Not used in a task pane, where the panel applies live.

    showQuickFormats?: boolean

    Show the one-click formats — accounting, percent, comma, and the decimal nudges — above the category.

    Off by default because they are commands: they format the SELECTION rather than routing through onChange, so a host whose target is something else (a dialog editing a style, a preview) must leave them out.

    false
    value: string

    The current format code (controlled).

    Settings
    Member Visibility

    On This Page
    Properties