GeoLeaf Core API - v3.0.0
    Preparing search index...

    Interface PillSearchOptions

    Options accepted by createPillSearchInput.

    interface PillSearchOptions {
        placeholder: string;
        ariaLabel: string;
        inputAriaLabel?: string;
        submitAriaLabel: string;
        clearAriaLabel: string;
        extraClass?: string;
        inputType?: "search" | "text";
        onInput?: (value: string) => void;
        onSubmit?: (value: string) => void;
        onClear?: () => void;
    }
    Index

    Properties

    placeholder ariaLabel inputAriaLabel? submitAriaLabel clearAriaLabel extraClass? inputType? onInput? onSubmit? onClear?

    Properties

    placeholder: string

    Placeholder text for the input.

    ariaLabel: string

    ARIA label applied to the root [role=search] wrapper.

    inputAriaLabel?: string

    ARIA label of the input itself. Defaults to placeholder.

    submitAriaLabel: string

    ARIA label of the submit (magnifier) button.

    clearAriaLabel: string

    ARIA label of the clear (×) button.

    extraClass?: string

    Optional extra class names applied on the root wrapper.

    inputType?: "search" | "text"

    Optional input type (default "text").

    onInput?: (value: string) => void

    Called whenever the input value changes.

    onSubmit?: (value: string) => void

    Called when the user submits (clicks submit button or presses Enter). The current input value is passed as argument.

    onClear?: () => void

    Called when the user clears the input (clicks × or presses Escape on a non-empty input). The implementation already empties the value before invoking the callback.

    Settings

    Member Visibility

    On This Page

    Properties