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

    Interface ValueChecklistProps

    Props for ValueChecklist.

    interface ValueChecklistProps {
        autoFocus?: boolean;
        byDisplay?: boolean;
        checked: ReadonlySet<string>;
        className?: string;
        dates?: readonly DateLevel[];
        itemHeight?: number;
        items: readonly ValueChecklistItem[];
        onAdd?: (text: string) => void;
        onApply?: () => void;
        onByDisplayChange?: (byDisplay: boolean) => void;
        onCheckedChange: (texts: readonly string[], checked: boolean) => void;
        onClose?: () => void;
        renderCheckbox?: (checked: boolean, indeterminate?: boolean) => ReactNode;
        renderItem?: (item: ValueChecklistItem) => ReactNode;
        search?: boolean;
        style?: CSSProperties;
        truncated?: boolean;
        viewport?: Viewport;
    }
    Index
    autoFocus?: boolean

    Take the focus on mount (the search field, or the list without one).

    true
    
    byDisplay?: boolean

    Whether the items are the texts cells show (a spreadsheet's list) or their values. In value mode rows align by type, numbers to the right, so 1 and the text '1 read apart.

    true

    checked: ReadonlySet<string>

    The checked values, by their key (text unless an item gives a key).

    className?: string

    Class for the root.

    dates?: readonly DateLevel[]

    The date tree over the leading items, as IFilter.getItems answers it: one level per entry, each the runs of items its nodes span. Listed as Excel's tree: a row per node with a disclosure, the deepest level's nodes as the leaves, and the items past the tree flat under it. While a search is typed the dates list flat by their text.

    itemHeight?: number

    Uniform row height in px.

    24
    
    items: readonly ValueChecklistItem[]

    The values, in the order shown.

    onAdd?: (text: string) => void

    The typed text is to join the values. Given, the search line offers an Add while the text is not already a value, and Enter adds it.

    onApply?: () => void

    Enter in the search field, with nothing to add: the host applies.

    onByDisplayChange?: (byDisplay: boolean) => void

    Offered as a "By value" toggle in the footer when given.

    onCheckedChange: (texts: readonly string[], checked: boolean) => void

    texts were set to checked — one on a click, the highlighted rows on Space, every row in view on Select All, every item of a node on its row. Rows out of the view (narrowed away by the search) are never named, so they keep their state.

    onClose?: () => void

    Escape with no search text to clear: the host closes.

    renderCheckbox?: (checked: boolean, indeterminate?: boolean) => ReactNode

    See CheckboxListProps.renderCheckbox: a styled control (MUI) in place of the native one.

    renderItem?: (item: ValueChecklistItem) => ReactNode

    Render a value row's label.

    the text
    
    search?: boolean

    A search field above the list, with Select All before it.

    true
    
    style?: CSSProperties

    Style for the root.

    truncated?: boolean

    The host stopped listing values at its cap: the count says so, the reason in its tooltip.

    viewport?: Viewport

    See ListSurfaceProps.viewport.