Guaxu Docs
    Preparing search index...

    Interface SearchBarProps

    interface SearchBarProps {
        ariaLabel: string;
        debounceTimer?: number;
        isOnSurface: boolean;
        onChange: (value: string) => void;
        onSurface?: boolean;
        placeholder?: string;
        value: string;
    }
    Index

    Properties

    ariaLabel: string

    Accessibility label for the search bar. Describes the purpose of the search input for assistive technologies.

    debounceTimer?: number

    Delay (in milliseconds) to update state after the user stops typing.

    400

    isOnSurface: boolean

    Whether the search bar is on a surface (e.g., card, modal) or not. If the element is not on a surface, shadow will be applied.

    onChange: (value: string) => void

    Debounced callback function (only called afer the user stops typing for debounceTimer milliseconds)

    onSurface?: boolean

    use isOnSurface instead

    placeholder?: string

    The text displayed in the search input when it is empty.

    value: string

    The debounced value of the search input