# ez-filter-input



<!-- Auto Generated Below -->


## Properties

| Property       | Attribute        | Description                                                                       | Type                  | Default     |
| -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
| `asyncSearch`  | `async-search`   | Define se o campo irá funcionar de forma assíncrona.                              | `boolean`             | `false`     |
| `autoFocus`    | `auto-focus`     | Se true o campo de texto receberá o foco ao ser renderizado.                      | `boolean`             | `false`     |
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo.                      | `boolean`             | `true`      |
| `enabled`      | `enabled`        | Se false o usuário não pode interagir com o campo.                                | `boolean`             | `true`      |
| `errorMessage` | `error-message`  | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string`              | `undefined` |
| `label`        | `label`          | Texto a ser apresentado como título do campo.                                     | `string`              | `undefined` |
| `mode`         | `mode`           | Define o tamanho do campo.                                                        | `"regular" \| "slim"` | `"regular"` |
| `restrict`     | `restrict`       | Restringe o que o usuário pode digitar.                                           | `string`              | `undefined` |
| `value`        | `value`          | Define o valor do campo.                                                          | `string`              | `undefined` |


## Events

| Event         | Description                                                           | Type                  |
| ------------- | --------------------------------------------------------------------- | --------------------- |
| `ezChange`    | Emitido quando acontece a alteração de valor do campo.                | `CustomEvent<string>` |
| `ezFocusIn`   | Emitido quando acontece o foco no campo.                              | `CustomEvent<void>`   |
| `ezSearching` | Emitido quando está sendo realizada uma pesquisa no modo asyncSearch. | `CustomEvent<string>` |


## Methods

### `endSearch() => Promise<void>`

Método responsável por resetar o valor do campo para o ultimo valor inputado.

#### Returns

Type: `Promise<void>`

---

### `isInvalid() => Promise<boolean>`

Retorna se o conteúdo é inválido.

#### Returns

Type: `Promise<boolean>`

---

### `setBlur() => Promise<void>`

Remove o foco do campo.

#### Returns

Type: `Promise<void>`

---

### `setFocus(options?: TFocusOptions) => Promise<void>`

Aplica o foco no campo.

#### Returns

Type: `Promise<void>`

---

### `setValue(newValue: string) => Promise<void>`

Método responsável por setar um novo valor ao campo.

#### Returns

Type: `Promise<void>`




## Dependencies

### Used by

 - [ez-guide-navigator](../ez-guide-navigator)
 - [ez-multi-selection-list](../ez-multi-selection-list)
 - [ez-sortable-list](../ez-sortable-list)

### Depends on

- [ez-text-input](../ez-text-input)
- [ez-icon](../ez-icon)

### Graph
```mermaid
graph TD;
  ez-filter-input --> ez-text-input
  ez-filter-input --> ez-icon
  ez-text-input --> ez-tooltip
  ez-text-input --> ez-icon
  ez-guide-navigator --> ez-filter-input
  ez-multi-selection-list --> ez-filter-input
  ez-sortable-list --> ez-filter-input
  style ez-filter-input fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------