@sankhyalabs/ezui-docs 0.0.0-feat-dev-kb-4158.0

package/components/ez-combo-box/readme.md

@@ -0,0 +1,112 @@
+# ez-combo-box
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property              | Attribute               | Description                                                                                                   | Type                                                                        | Default     |
+| --------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ----------- |
+| `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` |
+| `listOptionsPosition` | --                      | Define um posicionamento fixo para a lista de opções do CheckBox.                                             | `IEzCheckBoxListPosition`                                                   | `undefined` |
+| `mode`                | `mode`                  | Define o tamanho do campo.                                                                                    | `"regular" \| "slim"`                                                       | `"regular"` |
+| `optionLoader`        | --                      | Carrega as opções dinamicamente.                                                                              | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
+| `options`             | --                      | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]`                                                                 | `undefined` |
+| `searchMode`          | `search-mode`           | Se true ativa o modo pesquisa do ez-combo-box.                                                                | `boolean`                                                                   | `undefined` |
+| `showOptionValue`     | `show-option-value`     | Se true cada opção na lista exibe o `value` junto com `label`.                                                | `boolean`                                                                   | `false`     |
+| `showSelectedValue`   | `show-selected-value`   | Se true a opção selecionada exibe o `value` junto com `label`.                                                | `boolean`                                                                   | `false`     |
+| `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista.                                                                        | `boolean`                                                                   | `false`     |
+| `suppressSearch`      | `suppress-search`       | Se true desabilita a digitação dentro do componente.                                                          | `boolean`                                                                   | `false`     |
+| `value`               | `value`                 | Define o valor do campo.                                                                                      | `IOption \| string`                                                         | `undefined` |
+
+
+## Events
+
+| Event      | Description                                            | Type                   |
+| ---------- | ------------------------------------------------------ | ---------------------- |
+| `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<IOption>` |
+
+
+## Methods
+
+### `clearValue() => Promise<void>`
+
+Limpa o valor do campo de pesquisa
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `getValueAsync() => Promise<unknown>`
+
+
+
+#### Returns
+
+Type: `Promise<unknown>`
+
+
+
+### `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() => Promise<void>`
+
+Aplica o foco no campo.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-form-view](../ez-form-view)
+ - [ez-search](../ez-search)
+
+### Depends on
+
+- [ez-text-input](../ez-text-input)
+- [ez-icon](../ez-icon)
+
+### Graph
+```mermaid
+graph TD;
+  ez-combo-box --> ez-text-input
+  ez-combo-box --> ez-icon
+  ez-form-view --> ez-combo-box
+  ez-search --> ez-combo-box
+  style ez-combo-box fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-date-input/readme.md

@@ -0,0 +1,94 @@
+# ez-date-input
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property       | Attribute        | Description                                                                       | Type                  | Default     |
+| -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
+| `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"` |
+| `value`        | --               | Define o valor do campo.                                                          | `Date`                | `undefined` |
+
+
+## Events
+
+| Event                   | Description                                                                                    | Type                         |
+| ----------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------- |
+| `ezCancelWaitingChange` | Emitido quando não foi possível completar a alteração entre o evento ezStartChange e ezChange. | `CustomEvent<void>`          |
+| `ezChange`              | Emitido quando acontece a alteração de valor do campo.                                         | `CustomEvent<Date>`          |
+| `ezStartChange`         | Emitido ao iniciar a alteração (digitação incompleta).                                         | `CustomEvent<WaitingChange>` |
+
+
+## Methods
+
+### `getValueAsync() => Promise<Date>`
+
+
+
+#### Returns
+
+Type: `Promise<Date>`
+
+
+
+### `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() => Promise<void>`
+
+Aplica o foco no campo.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-form-view](../ez-form-view)
+
+### Depends on
+
+- [ez-text-input](../ez-text-input)
+- [ez-calendar](../ez-calendar)
+
+### Graph
+```mermaid
+graph TD;
+  ez-date-input --> ez-text-input
+  ez-date-input --> ez-calendar
+  ez-form-view --> ez-date-input
+  style ez-date-input fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-date-time-input/readme.md

@@ -0,0 +1,95 @@
+# ez-date-time-input
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property       | Attribute        | Description                                                                       | Type                  | Default     |
+| -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
+| `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"` |
+| `showSeconds`  | `show-seconds`   | Se true considera segundos.                                                       | `boolean`             | `false`     |
+| `value`        | --               | Define o valor do campo.                                                          | `Date`                | `undefined` |
+
+
+## Events
+
+| Event                   | Description                                                                                    | Type                         |
+| ----------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------- |
+| `ezCancelWaitingChange` | Emitido quando não foi possível completar a alteração entre o evento ezStartChange e ezChange. | `CustomEvent<void>`          |
+| `ezChange`              | Emitido quando acontece a alteração de valor do campo.                                         | `CustomEvent<Date>`          |
+| `ezStartChange`         | Emitido ao iniciar a alteração (digitação incompleta).                                         | `CustomEvent<WaitingChange>` |
+
+
+## Methods
+
+### `getValueAsync() => Promise<Date>`
+
+
+
+#### Returns
+
+Type: `Promise<Date>`
+
+
+
+### `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() => Promise<void>`
+
+Aplica o foco no campo.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-form-view](../ez-form-view)
+
+### Depends on
+
+- [ez-text-input](../ez-text-input)
+- [ez-calendar](../ez-calendar)
+
+### Graph
+```mermaid
+graph TD;
+  ez-date-time-input --> ez-text-input
+  ez-date-time-input --> ez-calendar
+  ez-form-view --> ez-date-time-input
+  style ez-date-time-input fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-dialog/readme.md

@@ -0,0 +1,60 @@
+# ez-dialog
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property               | Attribute                | Description                                                  | Type                                                                                 | Default     |
+| ---------------------- | ------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ----------- |
+| `beforeClose`          | --                       | Define função a ser executada antes de fechar o modal        | `Function`                                                                           | `undefined` |
+| `confirm`              | `confirm`                | Define se o ez-dialog será utilizado no modo de confirmação. | `boolean`                                                                            | `false`     |
+| `dialogType`           | `dialog-type`            | Define aparência do ez-dialog.                               | `DialogType.CRITICAL \| DialogType.DEFAULT \| DialogType.SUCCESS \| DialogType.WARN` | `undefined` |
+| `ezTitle`              | `ez-title`               | Texto a ser apresentado como título do campo.                | `string`                                                                             | `undefined` |
+| `message`              | `message`                | Define a menssagem exibida no ez-dialog.                     | `string`                                                                             | `undefined` |
+| `opened`               | `opened`                 | Define se o ez-dialog está aberto.                           | `boolean`                                                                            | `false`     |
+| `personalizedIconPath` | `personalized-icon-path` | Define o ícone a ser exibido.                                | `string`                                                                             | `undefined` |
+
+
+## Events
+
+| Event      | Description                       | Type                   |
+| ---------- | --------------------------------- | ---------------------- |
+| `ezAccept` | Emitido ao confirmar o ez-dialog. | `CustomEvent<boolean>` |
+| `ezCancel` | Emitido ao cancelar o ez-dialog.  | `CustomEvent<boolean>` |
+
+
+## Methods
+
+### `show(title: string, message: string, dialogType: DialogType, confirm: boolean, icon: string, labelCancel: string, labelConfirm: string, btnConfirmDanger: boolean, beforeClose: Function) => Promise<boolean>`
+
+Exibe o ez-dialog.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-icon](../ez-icon)
+- [ez-button](../ez-button)
+
+### Graph
+```mermaid
+graph TD;
+  ez-dialog --> ez-icon
+  ez-dialog --> ez-button
+  ez-button --> ez-icon
+  style ez-dialog fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-dropdown/readme.md

@@ -0,0 +1,45 @@
+# ez-dropdown
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property      | Attribute | Description                                                                                                                                              | Type                                                            | Default     |
+| ------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ----------- |
+| `itemBuilder` | --        | Função builder que possibilita alterar como o item da lista vai ser apresentado. Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: IDropdownItem, level: number) => string \| HTMLElement` | `undefined` |
+| `items`       | --        | Lista de itens que vão ser apresentados no dropdown.                                                                                                     | `IDropdownItem[]`                                               | `[]`        |
+| `value`       | --        | Último item que recebeu o click.                                                                                                                         | `IDropdownItem`                                                 | `undefined` |
+
+
+## Events
+
+| Event              | Description                                                                                                                    | Type                              |
+| ------------------ | ------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- |
+| `ezClick`          | Emitido quando ocorrer um click em um item da lista, o IDropdownItem que recebeu o click deve ser enviado como data do evento. | `CustomEvent<IDropdownItem>`      |
+| `ezSubActionClick` | Emitido quando ocorrer um click em uma ação secundaria do item,  o IDropdownSubAction deve ser enviado como data do evento.    | `CustomEvent<IDropdownSubAction>` |
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-breadcrumb](../ez-breadcrumb)
+
+### Depends on
+
+- [ez-icon](../ez-icon)
+
+### Graph
+```mermaid
+graph TD;
+  ez-dropdown --> ez-icon
+  ez-breadcrumb --> ez-dropdown
+  style ez-dropdown fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-file-item/readme.md

@@ -0,0 +1,42 @@
+# ez-file-item
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property    | Attribute    | Description                                                            | Type      | Default     |
+| ----------- | ------------ | ---------------------------------------------------------------------- | --------- | ----------- |
+| `canRemove` | `can-remove` | Define se o usuário pode remover o arquivo que está sendo apresentado. | `boolean` | `true`      |
+| `fileName`  | `file-name`  | Define o nome do arquivo, com extensão.                                | `string`  | `undefined` |
+| `fileSize`  | `file-size`  | Tamanho do arquivo (em bytes).                                         | `number`  | `undefined` |
+| `iconName`  | `icon-name`  | Define qual ícone que representa o arquivo.                            | `string`  | `undefined` |
+| `progress`  | `progress`   | Percentual de carregamento do arquivo para o servidor.                 | `number`  | `100`       |
+
+
+## Events
+
+| Event      | Description                                                      | Type                  |
+| ---------- | ---------------------------------------------------------------- | --------------------- |
+| `ezClick`  | Emitido ao clicar no ez-file-input (exceto no botão de remover). | `CustomEvent<string>` |
+| `ezRemove` | Emitido ao clicar no botão de remover.                           | `CustomEvent<string>` |
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-icon](../ez-icon)
+
+### Graph
+```mermaid
+graph TD;
+  ez-file-item --> ez-icon
+  style ez-file-item fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-filter-input/readme.md

@@ -0,0 +1,108 @@
+# 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`     |
+| `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() => 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)
+
+### 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-guide-navigator --> ez-filter-input
+  ez-multi-selection-list --> ez-filter-input
+  style ez-filter-input fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-form/readme.md

@@ -0,0 +1,81 @@
+# 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` |
+| `recordsValidator` | --        | Define um validador responsável pela integridade dos registros.                                           | `IRecordValidator` | `undefined` |
+
+
+## Events
+
+| Event     | Description                                                  | Type                |
+| --------- | ------------------------------------------------------------ | ------------------- |
+| `ezReady` | Evento disparado quando o formulário está disponível na DOM. | `CustomEvent<void>` |
+
+
+## Methods
+
+### `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-form-view](../ez-form-view)
+
+### Graph
+```mermaid
+graph TD;
+  ez-form --> ez-tabselector
+  ez-form --> ez-form-view
+  ez-tabselector --> ez-icon
+  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-search
+  ez-form-view --> ez-text-area
+  ez-form-view --> ez-text-input
+  ez-collapsible-box --> ez-icon
+  ez-collapsible-box --> ez-text-edit
+  ez-text-edit --> ez-text-input
+  ez-text-edit --> ez-button
+  ez-button --> ez-icon
+  ez-combo-box --> ez-text-input
+  ez-combo-box --> ez-icon
+  ez-date-input --> ez-text-input
+  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-calendar
+  ez-number-input --> ez-text-input
+  ez-search --> ez-combo-box
+  style ez-form fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+