# ez-form



<!-- Auto Generated Below -->


## Properties

| Property                  | Attribute            | Description                                                                                                                                 | Type               | Default     |
| ------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
| `config`                  | --                   | Configuração do formulário.                                                                                                                 | `IFormConfig`      | `undefined` |
| `dataUnit`                | --                   | Unidade de dados. Responsável pelo controle de edição de registros e  informações pertinentes aos campos.                                   | `DataUnit`         | `undefined` |
| `elementFocusSearchField` | --                   | Define uma ancoragem                                                                                                                        | `HTMLElement`      | `undefined` |
| `fieldToFocus`            | `field-to-focus`     | Determina o campo que deve ficar em evidência.                                                                                              | `string`           | `undefined` |
| `onlyStaticFields`        | `only-static-fields` | Define se os campos que serão apresentados são todos estáticos. Quando verdadeira, ocorrerá no DataBinder o bind dos campos com o DataUnit. | `boolean`          | `false`     |
| `recordsValidator`        | --                   | Define um validador responsável pela integridade dos registros.                                                                             | `IRecordValidator` | `undefined` |
| `useSearchField`          | `use-search-field`   | Define se o formulario deve exibir um buscador de coluna com uso do Ctrl+F                                                                  | `boolean`          | `true`      |


## Events

| Event                            | Description                                                                     | Type                          |
| -------------------------------- | ------------------------------------------------------------------------------- | ----------------------------- |
| `ezFormRequestClearFieldToFocus` | Emitido quando o campo recebe foco                                              | `CustomEvent<void>`           |
| `ezFormSetFields`                | Emitido quando o campo recebe foco                                              | `CustomEvent<IFieldConfig[]>` |
| `ezReady`                        | Evento disparado quando o formulário está disponível na DOM.                    | `CustomEvent<void>`           |
| `formItemsReady`                 | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<FormItems>`      |


## Methods

### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`

Registra um editor customizado para campos da grade e formulário.

#### Returns

Type: `Promise<void>`

---

### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`

Altera/adiciona uma propriedade nos metadados do campo.

#### Returns

Type: `Promise<void>`

---

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

Realiza validação no conteúdo de todos os campos.

#### Returns

Type: `Promise<void>`




## Dependencies

### Depends on

- [ez-tabselector](../ez-tabselector)
- [ez-popover](../ez-popover)
- [ez-form-view](../ez-form-view)
- [ez-search](../ez-search)

### Graph
```mermaid
graph TD;
  ez-form --> ez-tabselector
  ez-form --> ez-popover
  ez-form --> ez-form-view
  ez-form --> ez-search
  ez-tabselector --> ez-icon
  ez-form-view --> ez-custom-form-input
  ez-form-view --> ez-collapsible-box
  ez-form-view --> ez-check
  ez-form-view --> ez-combo-box
  ez-form-view --> ez-date-input
  ez-form-view --> ez-time-input
  ez-form-view --> ez-date-time-input
  ez-form-view --> ez-upload
  ez-form-view --> ez-number-input
  ez-form-view --> ez-text-area
  ez-form-view --> ez-text-input
  ez-form-view --> ez-search-plus
  ez-form-view --> ez-search
  ez-form-view --> ez-rich-text
  ez-form-view --> ez-multi-select-input
  ez-collapsible-box --> ez-icon
  ez-collapsible-box --> ez-text-edit
  ez-text-edit --> ez-text-input
  ez-text-edit --> ez-button
  ez-text-input --> ez-tooltip
  ez-text-input --> ez-icon
  ez-button --> ez-icon
  ez-combo-box --> ez-text-input
  ez-combo-box --> ez-icon
  ez-combo-box --> ez-popover-plus
  ez-combo-box --> ez-combo-box-list
  ez-popover-plus --> ez-popover-core
  ez-date-input --> ez-text-input
  ez-date-input --> ez-popover-plus
  ez-date-input --> ez-calendar
  ez-time-input --> ez-text-input
  ez-time-input --> ez-icon
  ez-date-time-input --> ez-text-input
  ez-date-time-input --> ez-popover-plus
  ez-date-time-input --> ez-calendar
  ez-number-input --> ez-text-input
  ez-text-area --> ez-tooltip
  ez-text-area --> ez-icon
  ez-search-plus --> ez-icon
  ez-search-plus --> ez-text-input
  ez-search-plus --> ez-popover-plus
  ez-search-plus --> ez-search-result-list
  ez-search-result-list --> ez-card-item
  ez-search-result-list --> ez-skeleton
  ez-search --> ez-text-input
  ez-search --> ez-icon
  ez-search --> ez-popover-plus
  ez-search --> search-list
  search-list --> ez-card-item
  ez-rich-text --> ez-text-area
  ez-rich-text --> ez-rich-toolbar
  ez-rich-text --> ez-link-builder
  ez-rich-text --> ez-simple-image-uploader
  ez-rich-toolbar --> ez-rich-toolbar-arrows
  ez-rich-toolbar --> ez-rich-toolbar-letters
  ez-rich-toolbar --> ez-rich-toolbar-configs
  ez-rich-toolbar-arrows --> ez-rich-toolbar-item
  ez-rich-toolbar-item --> ez-icon
  ez-rich-toolbar-letters --> ez-rich-toolbar-item
  ez-rich-toolbar-configs --> ez-rich-toolbar-item
  ez-link-builder --> ez-popup
  ez-link-builder --> ez-modal-container
  ez-link-builder --> ez-text-input
  ez-link-builder --> ez-check
  ez-popup --> ez-button
  ez-modal-container --> ez-icon
  ez-modal-container --> ez-button
  ez-simple-image-uploader --> ez-popup
  ez-simple-image-uploader --> ez-modal-container
  ez-simple-image-uploader --> ez-tooltip
  ez-simple-image-uploader --> ez-text-input
  ez-simple-image-uploader --> ez-icon
  ez-multi-select-input --> ez-icon
  ez-multi-select-input --> ez-tooltip
  ez-multi-select-input --> ez-popover-core
  ez-multi-select-input --> ez-multi-selection-list
  ez-multi-selection-list --> ez-check
  ez-multi-selection-list --> ez-list
  ez-multi-selection-list --> ez-icon
  ez-multi-selection-list --> multi-selection-box-message
  ez-multi-selection-list --> ez-filter-input
  ez-multi-selection-list --> ez-search
  ez-list --> ez-check
  ez-filter-input --> ez-text-input
  ez-filter-input --> ez-icon
  style ez-form fill:#f9f,stroke:#333,stroke-width:4px
```

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


