@empathyco/x-components/docs/API-reference/api/x-components.searchinput.md

Empathy X Components

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [SearchInput](./x-components.searchinput.md)

## SearchInput variable

This component renders an input field that allows the user to type a query. It also reacts to query changes through event listening.

**Signature:**

```typescript
_default: import("vue").DefineComponent<{
    maxLength: {
        type: NumberConstructor;
        default: number;
    };
    autofocus: {
        type: BooleanConstructor;
        default: boolean;
    };
    instant: {
        type: BooleanConstructor;
        default: boolean;
    };
    instantDebounceInMs: {
        type: NumberConstructor;
        default: number;
    };
}, {
    query: import("vue").ComputedRef<string>;
    inputElement: import("vue").Ref<HTMLInputElement | undefined>;
    emitUserHoveredInSearchBox: () => void;
    emitUserHoveredOutSearchBox: () => void;
    emitUserBlurredSearchBox: () => void;
    emitUserClickedSearchBox: () => void;
    emitUserFocusedSearchBox: () => void;
    emitUserIsTypingAQueryEvents: () => void;
    emitUserPressedEnterKey: () => void;
    emitUserPressedArrowKey: (event: KeyboardEvent) => void;
    preventSpecialKey: (event: InputEvent) => void;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
    maxLength: {
        type: NumberConstructor;
        default: number;
    };
    autofocus: {
        type: BooleanConstructor;
        default: boolean;
    };
    instant: {
        type: BooleanConstructor;
        default: boolean;
    };
    instantDebounceInMs: {
        type: NumberConstructor;
        default: number;
    };
}>>, {
    maxLength: number;
    autofocus: boolean;
    instant: boolean;
    instantDebounceInMs: number;
}, {}>
```