ChemPal Documentation - v1.6.0
    Preparing search index...

    Interface HighlightedSearchInputProps

    Props for HighlightedSearchInput.

    interface HighlightedSearchInputProps {
        value: string;
        onChange: (value: string) => void;
        placeholder?: string;
        disabled?: boolean;
        ariaLabel?: string;
        className?: string;
        style?: CSSProperties;
        onKeyDown?: (event: KeyboardEvent<HTMLInputElement>) => void;
        onValidityChange?: (blocked: boolean, message?: string) => void;
    }
    Index

    Properties

    value onChange placeholder? disabled? ariaLabel? className? style? onKeyDown? onValidityChange?

    Properties

    value: string

    Current query text (controlled).

    onChange: (value: string) => void

    Called with the new value on every keystroke.

    placeholder?: string

    Placeholder shown when empty.

    disabled?: boolean

    Disables input (e.g. while searching).

    ariaLabel?: string

    Accessible label for the input.

    className?: string

    Extra class names applied to the wrapper (e.g. layout classes from the parent).

    style?: CSSProperties

    Inline style applied to the wrapper — used to set font-size/flex/margins per call site.

    onKeyDown?: (event: KeyboardEvent<HTMLInputElement>) => void

    Forwarded to the input (e.g. submit-on-Enter handling).

    onValidityChange?: (blocked: boolean, message?: string) => void

    Notified when validity changes: blocked is true (with a message) for invalid queries.

    Settings

    Member Visibility

    On This Page

    Properties