@sankhyalabs/ezui-docs 2.0.0

package/components/ez-modal-container/readme.md

@@ -0,0 +1,46 @@
+# ez-modal-container
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property             | Attribute              | Description                                                          | Type      | Default     |
+| -------------------- | ---------------------- | -------------------------------------------------------------------- | --------- | ----------- |
+| `cancelButtonLabel`  | `cancel-button-label`  | Determina o texto do botão de cancelar                               | `string`  | `undefined` |
+| `cancelButtonStatus` | `cancel-button-status` | Variação de estado do botão de cancelar: [HIDDEN\|ENABLED\|DISABLED] | `string`  | `undefined` |
+| `modalSubTitle`      | `modal-sub-title`      | Subtítulo (opcional), geralmente usado para orientação do usuário    | `string`  | `undefined` |
+| `modalTitle`         | `modal-title`          | Título do modal                                                      | `string`  | `undefined` |
+| `okButtonLabel`      | `ok-button-label`      | Determina o texto do botão de Ok                                     | `string`  | `undefined` |
+| `okButtonStatus`     | `ok-button-status`     | Variação de estado do botão de ok: [HIDDEN\|ENABLED\|DISABLED]       | `string`  | `undefined` |
+| `showTitleBar`       | `show-title-bar`       | Determina se o cabeçalho com o título deverá ser mostrado            | `boolean` | `true`      |
+
+
+## Events
+
+| Event           | Description                                                                                                                                                                                                                                                              | Type                  |
+| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------- |
+| `ezModalAction` | Representa a interação com o usuário. OK - Quando o botão é acionado CANCEL - Quando o botão de cancelar é acionado CLOSE - Quando o botão de fechar é acionado. LOAD - Quando o modal é carregado (eventualmente pode ser usado para dar foco a um elemento específico) | `CustomEvent<string>` |
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-icon](../ez-icon)
+- [ez-button](../ez-button)
+
+### Graph
+```mermaid
+graph TD;
+  ez-modal-container --> ez-icon
+  ez-modal-container --> ez-button
+  ez-button --> ez-icon
+  style ez-modal-container fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

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

@@ -0,0 +1,83 @@
+# ez-number-input
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute          | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Type      | Default     |
+| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ----------- |
+| `enabled`         | `enabled`          | Deixa o campo disponível ou não para uso.                                                                                                                                                                                                                                                                                                                                                                                                                                    | `boolean` | `true`      |
+| `errorMessage`    | `error-message`    | Quando há um problema de validação, serve como orientação ao usuário                                                                                                                                                                                                                                                                                                                                                                                                         | `string`  | `undefined` |
+| `label`           | `label`            | Título do campo                                                                                                                                                                                                                                                                                                                                                                                                                                                              | `string`  | `undefined` |
+| `mode`            | `mode`             | Define o modo do tamanho do campo; opções: slim e regular.                                                                                                                                                                                                                                                                                                                                                                                                                   | `string`  | `"regular"` |
+| `precision`       | `precision`        | Precisão decimal, ou seja, quantas casas decimais podem ser exibidas. Caso a quantidade de casas decimais do valor seja maior que precision, haverá arredondamento                                                                                                                                                                                                                                                                                                           | `number`  | `undefined` |
+| `prettyPrecision` | `pretty-precision` | Esse atributo determina qual é o número mínimo de casas depois da vírgula. Exemplo: Digamos que a precision seja igual a 4, assim qualquer número será  representado com 4 casas decimais mesmo que iguais a zero: 1,0100. Se prettiprecision igual a 2, como não há necessidade de mais de duas casas decimais o valor exibido será 1,01. Por outro lado, até a quarta casa não haverá arredondamento (1,1234 = 1,1234) mas a partir da quinta casa sim (1,12345 = 1,1235). | `number`  | `undefined` |
+| `value`           | `value`            | O valor informado pelo usuário                                                                                                                                                                                                                                                                                                                                                                                                                                               | `number`  | `undefined` |
+
+
+## Events
+
+| Event                   | Description                                                                                                                   | Type                         |
+| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
+| `ezCancelWaitingChange` | Entre o evento ezStartChange e ezChange, se por algum motivo não foi possível completar a alteração, esse evento é disparado. | `CustomEvent<void>`          |
+| `ezChange`              | Evento disparado quando o estado do componente é alterado (onEzChange).                                                       | `CustomEvent<number>`        |
+| `ezStartChange`         | Evento emitido ao iniciar a alteração (remover ou adicionar um arquivo).                                                      | `CustomEvent<WaitingChange>` |
+
+
+## Methods
+
+### `isInvalid() => Promise<boolean>`
+
+Retorna informando se o campo está inválido (true | false)
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `setBlur() => Promise<void>`
+
+Remove o foco no componente de input
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setFocus() => Promise<void>`
+
+Realiza o foco no componente de input
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-form](../ez-form)
+
+### Depends on
+
+- [ez-text-input](../ez-text-input)
+
+### Graph
+```mermaid
+graph TD;
+  ez-number-input --> ez-text-input
+  ez-form --> ez-number-input
+  style ez-number-input fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-popover/readme.md

@@ -0,0 +1,64 @@
+# ez-popover
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property       | Attribute       | Description                                                                                   | Type                 | Default         |
+| -------------- | --------------- | --------------------------------------------------------------------------------------------- | -------------------- | --------------- |
+| `autoClose`    | `auto-close`    | No modo floating = false o popover só se tornará visível quando o método show() for acionado. | `boolean`            | `true`          |
+| `bottom`       | `bottom`        | Offset bottom do popover em relação ao componente pai                                         | `string`             | `"0px"`         |
+| `boxWidth`     | `box-width`     | Ajusta o comportamento da largura do popover. Opções: "100% e "fit-content" (default)         | `string`             | `"fit-content"` |
+| `innerElement` | `inner-element` | Array de componente(s) que irá(ão) abrir o popover.                                           | `string \| string[]` | `undefined`     |
+| `left`         | `left`          | Offset left do popover em relação ao componente pai                                           | `string`             | `"0px"`         |
+| `opened`       | `opened`        | Externaliza estado atual do componente.                                                       | `boolean`            | `undefined`     |
+| `right`        | `right`         | Offset right do popover em relação ao componente pai                                          | `string`             | `"0px"`         |
+| `top`          | `top`           | Offset top do popover em relação ao componente pai                                            | `string`             | `"0px"`         |
+
+
+## Events
+
+| Event                | Description                                       | Type                   |
+| -------------------- | ------------------------------------------------- | ---------------------- |
+| `ezVisibilityChange` |  Evento disparado ao exibir/ocultar o componente. | `CustomEvent<boolean>` |
+
+
+## Methods
+
+### `hide() => Promise<void>`
+
+Usado no modo floating. Faz com que o componente seja ocultado.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `show(top?: string, left?: string, bottom?: string, right?: string) => Promise<void>`
+
+Faz com que o popover seja renderizado na DOM.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `updatePosition(top?: string, left?: string, bottom?: string, right?: string) => Promise<void>`
+
+Atualiza a posição do popover em relação ao componente pai.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+----------------------------------------------
+
+

package/components/ez-popup/readme.md

@@ -0,0 +1,28 @@
+# ez-popup
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property     | Attribute     | Description                                                                                                                                                 | Type      | Default     |
+| ------------ | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ----------- |
+| `ezTitle`    | `ez-title`    | Título do componente.                                                                                                                                       | `string`  | `undefined` |
+| `heightMode` | `height-mode` | Define se o componente utilizará um cabeçalho com botão de fechamento.                                                                                      | `string`  | `"full"`    |
+| `opened`     | `opened`      | Controla a exibição do componente.                                                                                                                          | `boolean` | `false`     |
+| `size`       | `size`        | Define o width que o componente deve ter, seguindo o grid system. Os valores devem estar compreendidos em [x-small \| small \| medium \| large \| x-large]. | `string`  | `"medium"`  |
+| `useHeader`  | `use-header`  | Define se o componente utilizará um cabeçalho com botão de fechamento.                                                                                      | `boolean` | `true`      |
+
+
+## Events
+
+| Event          | Description                                                     | Type               |
+| -------------- | --------------------------------------------------------------- | ------------------ |
+| `ezClosePopup` | Evento disparado ao clicar no botão de fechar (onEzClosePopup). | `CustomEvent<any>` |
+
+
+----------------------------------------------
+
+

package/components/ez-radio-button/readme.md

@@ -0,0 +1,28 @@
+# ez-radio-button
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property    | Attribute   | Description                                                                             | Type                         | Default      |
+| ----------- | ----------- | --------------------------------------------------------------------------------------- | ---------------------------- | ------------ |
+| `direction` | `direction` | Define a direção em que os itens são apresentadoss, podendo ser horizontal ou vertical. | `"horizontal" \| "vertical"` | `"vertical"` |
+| `enabled`   | `enabled`   | Define se o componente está habilitado ou desabilitado                                  | `boolean`                    | `true`       |
+| `label`     | `label`     | Determina a descrição do grupo                                                          | `string`                     | `undefined`  |
+| `options`   | --          | Define as opções que serão apresentadas                                                 | `Radio[]`                    | `[]`         |
+| `value`     | `value`     | Representa o valor atualmente selecionado entre as opções                               | `any`                        | `undefined`  |
+
+
+## Events
+
+| Event      | Description                                       | Type               |
+| ---------- | ------------------------------------------------- | ------------------ |
+| `ezChange` | Evento disparado quando uma opção for selecionada | `CustomEvent<any>` |
+
+
+----------------------------------------------
+
+

package/components/ez-scroller/readme.md

@@ -0,0 +1,19 @@
+# ez-scroller
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property       | Attribute       | Description                                                                                           | Type                                                                                   | Default                  |
+| -------------- | --------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ------------------------ |
+| `activeShadow` | `active-shadow` | Determina de o efeito de sombreado está ativo.                                                        | `boolean`                                                                              | `false`                  |
+| `direction`    | `direction`     | Determina se haverá scroll na direção Vertical, Horizontal ou Ambos. Por padrão, a direção é "Ambos". | `EzScrollDirection.BOTH \| EzScrollDirection.HORIZONTAL \| EzScrollDirection.VERTICAL` | `EzScrollDirection.BOTH` |
+| `locked`       | `locked`        | Determina se o scroll estará bloqueado quando necessário.                                             | `boolean`                                                                              | `false`                  |
+
+
+----------------------------------------------
+
+

package/components/ez-search/readme.md

@@ -0,0 +1,86 @@
+# ez-search
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property              | Attribute               | Description                                                          | Type                | Default     |
+| --------------------- | ----------------------- | -------------------------------------------------------------------- | ------------------- | ----------- |
+| `enabled`             | `enabled`               | Deixa o campo disponível ou não.                                     | `boolean`           | `true`      |
+| `errorMessage`        | `error-message`         | Quando há um problema de validação, serve como orientação ao usuário | `string`            | `undefined` |
+| `label`               | `label`                 | Título do campo                                                      | `string`            | `undefined` |
+| `mode`                | `mode`                  | Define o modo do tamanho do campo; opções: slim e regular.           | `string`            | `"regular"` |
+| `optionLoader`        | --                      | Função responsável por carregar as opções dinamicamente              | `Function`          | `undefined` |
+| `showOptionValue`     | `show-option-value`     | Ajusta a opção de mostrar o "value" para cada opção.                 | `boolean`           | `true`      |
+| `showSelectedValue`   | `show-selected-value`   | Ajusta a opção de mostrar o "value" ao selecionar uma opção.         | `boolean`           | `true`      |
+| `suppressEmptyOption` | `suppress-empty-option` | Remove a opção vazia da lista de opções                              | `boolean`           | `false`     |
+| `value`               | `value`                 | Código do registro selecionado                                       | `IOption \| string` | `undefined` |
+
+
+## Events
+
+| Event       | Description                                                                | Type                   |
+| ----------- | -------------------------------------------------------------------------- | ---------------------- |
+| `ezChange`  | Um evento disparado quando o estado do componente é alterado (onEzChange). | `CustomEvent<IOption>` |
+| `showPopup` | Evento emitido ao clicar para abrir o popup                                | `CustomEvent<any>`     |
+
+
+## Methods
+
+### `isInvalid() => Promise<boolean>`
+
+Retorna informando se o campo está inválido (true | false)
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `setBlur() => Promise<void>`
+
+Remove o foco no componente de pesquisa
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setFocus() => Promise<void>`
+
+Realiza o foco no componente de pesquisa
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-form](../ez-form)
+
+### Depends on
+
+- [ez-combo-box](../ez-combo-box)
+
+### Graph
+```mermaid
+graph TD;
+  ez-search --> ez-combo-box
+  ez-combo-box --> ez-text-input
+  ez-combo-box --> ez-icon
+  ez-form --> ez-search
+  style ez-search fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-tabselector/readme.md

@@ -0,0 +1,44 @@
+# ez-tabselector
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property        | Attribute        | Description                                                                                                                                                                          | Type              | Default     |
+| --------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------- | ----------- |
+| `selectedIndex` | `selected-index` | Define o index da aba selecionada.                                                                                                                                                   | `number`          | `undefined` |
+| `selectedTab`   | `selected-tab`   | Define a aba selecionada.                                                                                                                                                            | `string`          | `undefined` |
+| `tabs`          | `tabs`           | Define o nome das abas do componente, separadas por vírgulas ",". Opcionalmente pode-se construir um array de objetos do tipo Tab, nesse caso o tabKey e o índice serão respeitados. | `Tab[] \| string` | `undefined` |
+
+
+## Events
+
+| Event      | Description                                                                                                                             | Type               |
+| ---------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
+| `ezChange` | Evento emitido ao clicar para abrir o popup (ezChange). O detail desse evento carrega tanto o tabKey quanto o index da aba selecionada. | `CustomEvent<Tab>` |
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-form](../ez-form)
+
+### Depends on
+
+- [ez-icon](../ez-icon)
+
+### Graph
+```mermaid
+graph TD;
+  ez-tabselector --> ez-icon
+  ez-form --> ez-tabselector
+  style ez-tabselector fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-text-area/readme.md

@@ -0,0 +1,77 @@
+# ez-text-area
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property       | Attribute        | Description                                                                         | Type      | Default     |
+| -------------- | ---------------- | ----------------------------------------------------------------------------------- | --------- | ----------- |
+| `canShowError` | `can-show-error` | Permite exibir a mensagem de erro.                                                  | `boolean` | `true`      |
+| `enabled`      | `enabled`        | Deixa o campo disponível ou não para digitação.                                     | `boolean` | `true`      |
+| `errorMessage` | `error-message`  | Quando há um problema de validação, serve como orientação ao usuário                | `string`  | `undefined` |
+| `label`        | `label`          | Título do campo                                                                     | `string`  | `undefined` |
+| `loading`      | `loading`        | Deixa o componente em modo "carregando".                                            | `boolean` | `undefined` |
+| `mode`         | `mode`           | Define o modo do tamanho do campo; opções: slim e regular.                          | `string`  | `"regular"` |
+| `rows`         | `rows`           | Ajusta o número de linhas e consequentemente o height do textarea. Valor default: 4 | `number`  | `4`         |
+| `value`        | `value`          | Valor digitado pelo usuário. Este valor é o que fica visível no campo.              | `string`  | `undefined` |
+
+
+## Events
+
+| Event      | Description                                                             | Type                  |
+| ---------- | ----------------------------------------------------------------------- | --------------------- |
+| `ezChange` | Evento disparado quando o estado do componente é alterado (onEzChange). | `CustomEvent<string>` |
+
+
+## Methods
+
+### `isInvalid() => Promise<boolean>`
+
+Retorna informando se o campo está inválido (true | false)
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `setBlur() => Promise<void>`
+
+Remove o foco no componente de input
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setFocus() => Promise<void>`
+
+Faz o foco no componente de input
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-form](../ez-form)
+
+### Graph
+```mermaid
+graph TD;
+  ez-form --> ez-text-area
+  style ez-text-area fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-text-edit/readme.md

@@ -0,0 +1,60 @@
+# ez-text-edit
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property | Attribute | Description                                       | Type      | Default     |
+| -------- | --------- | ------------------------------------------------- | --------- | ----------- |
+| `styled` | --        | Define atributos do estilo                        | `IStyled` | `undefined` |
+| `value`  | `value`   | Valor manipulado pelo componente através do input | `string`  | `undefined` |
+
+
+## Events
+
+| Event           | Description                         | Type               |
+| --------------- | ----------------------------------- | ------------------ |
+| `cancelEdition` | Disparado ao cancelar uma edição    | `CustomEvent<any>` |
+| `saveEdition`   | Evento emitido ao salvar uma edição | `CustomEvent<any>` |
+
+
+## Methods
+
+### `applyFocusSelect() => Promise<void>`
+
+Aplica focus no campo.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-collapsible-box](../ez-collapsible-box)
+
+### Depends on
+
+- [ez-text-input](../ez-text-input)
+- [ez-button](../ez-button)
+
+### Graph
+```mermaid
+graph TD;
+  ez-text-edit --> ez-text-input
+  ez-text-edit --> ez-button
+  ez-button --> ez-icon
+  ez-collapsible-box --> ez-text-edit
+  style ez-text-edit fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

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

@@ -0,0 +1,93 @@
+# ez-text-input
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property       | Attribute        | Description                                                                                                                        | Type      | Default     |
+| -------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------- | ----------- |
+| `canShowError` | `can-show-error` | Permite exibir a mensagem de erro.                                                                                                 | `boolean` | `true`      |
+| `enabled`      | `enabled`        | Deixa o campo disponível ou não para digitação.                                                                                    | `boolean` | `true`      |
+| `errorMessage` | `error-message`  | Quando há um problema de validação, serve como orientação ao usuário                                                               | `string`  | `undefined` |
+| `label`        | `label`          | Título do campo                                                                                                                    | `string`  | `undefined` |
+| `loading`      | `loading`        | Deixa o componente em modo "carregando".                                                                                           | `boolean` | `undefined` |
+| `mask`         | `mask`           | Aplica uma máscara no conteúdo conforme o padrão estabelecido                                                                      | `string`  | `undefined` |
+| `mode`         | `mode`           | Define o modo do tamanho do campo; opções: slim e regular.                                                                         | `string`  | `"regular"` |
+| `noBorder`     | `no-border`      | Define se o campo contará com bordas ou não                                                                                        | `boolean` | `false`     |
+| `restrict`     | `restrict`       | Restringe o que o usuário pode digitar. Cada caractere digitado será testado e deve estar contido nessa string ou será descartado. | `string`  | `undefined` |
+| `value`        | `value`          | Valor digitado pelo usuário. Este valor é o que fica visível no campo.                                                             | `string`  | `undefined` |
+
+
+## Events
+
+| Event      | Description                                                             | Type                  |
+| ---------- | ----------------------------------------------------------------------- | --------------------- |
+| `ezChange` | Evento disparado quando o estado do componente é alterado (onEzChange). | `CustomEvent<string>` |
+
+
+## Methods
+
+### `isInvalid() => Promise<boolean>`
+
+Retorna informando se o campo está inválido (true | false)
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `setBlur() => Promise<void>`
+
+Remove o foco no componente de input
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setFocus() => Promise<void>`
+
+Faz o foco no componente de input
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-combo-box](../ez-combo-box)
+ - [ez-date-input](../ez-date-input)
+ - [ez-date-time-input](../ez-date-time-input)
+ - [ez-filter-input](../ez-filter-input)
+ - [ez-form](../ez-form)
+ - [ez-number-input](../ez-number-input)
+ - [ez-text-edit](../ez-text-edit)
+ - [ez-time-input](../ez-time-input)
+
+### Graph
+```mermaid
+graph TD;
+  ez-combo-box --> ez-text-input
+  ez-date-input --> ez-text-input
+  ez-date-time-input --> ez-text-input
+  ez-filter-input --> ez-text-input
+  ez-form --> ez-text-input
+  ez-number-input --> ez-text-input
+  ez-text-edit --> ez-text-input
+  ez-time-input --> ez-text-input
+  style ez-text-input fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+