@sankhyalabs/ezui-docs 2.0.0

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

@@ -0,0 +1,71 @@
+# ez-actions-button
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property        | Attribute        | Description                                                                                          | Type                             | Default     |
+| --------------- | ---------------- | ---------------------------------------------------------------------------------------------------- | -------------------------------- | ----------- |
+| `actions`       | --               | . Array no formato "{value: string, label: string, iconName: string}" que alimenta a lista de ações. | `IAction[]`                      | `undefined` |
+| `arrowActive`   | `arrow-active`   | Define se o elemento contará com a seta de orientação.                                               | `boolean`                        | `false`     |
+| `checkOption`   | `check-option`   | Define se na opção selecionada apresentará um ícone de check.                                        | `boolean`                        | `false`     |
+| `displayIcon`   | `display-icon`   | Nome do ícone que será apresentado no display do componente.                                         | `string`                         | `undefined` |
+| `enabled`       | `enabled`        | Deixa o campo disponível ou não para interação com usuário.                                          | `boolean`                        | `true`      |
+| `isTransparent` | `is-transparent` | Define se o background do botão será transparent.                                                    | `boolean`                        | `false`     |
+| `showLabel`     | `show-label`     | Define se o label será apresentado no display do componente.                                         | `boolean`                        | `false`     |
+| `size`          | `size`           | É possível escolher entre [small,medium,large].                                                      | `"large" \| "medium" \| "small"` | `undefined` |
+| `value`         | `value`          | Define qual o value que será selecionado na lista.                                                   | `string`                         | `undefined` |
+
+
+## Events
+
+| Event      | Description                                 | Type                   |
+| ---------- | ------------------------------------------- | ---------------------- |
+| `ezAction` | Evento que é disparado ao acionar uma ação. | `CustomEvent<IAction>` |
+
+
+## Methods
+
+### `hideActions() => Promise<void>`
+
+Oculta a lista de ações
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `isOpened() => Promise<boolean>`
+
+Verifica se a lista de ações está oculta
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-button](../ez-button)
+- [ez-icon](../ez-icon)
+
+### Graph
+```mermaid
+graph TD;
+  ez-actions-button --> ez-button
+  ez-actions-button --> ez-icon
+  ez-button --> ez-icon
+  style ez-actions-button fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-application/readme.md

@@ -0,0 +1,17 @@
+# ez-application
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Events
+
+| Event               | Description                                        | Type                   |
+| ------------------- | -------------------------------------------------- | ---------------------- |
+| `applicationLoaded` | Evento disparado quando a aplicação for carregada. | `CustomEvent<boolean>` |
+
+
+----------------------------------------------
+
+

package/components/ez-button/readme.md

@@ -0,0 +1,71 @@
+# ez-button
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property   | Attribute   | Description                                                                                                                                | Type                             | Default     |
+| ---------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------- | ----------- |
+| `enabled`  | `enabled`   | Deixa o botão disponível ou não para interação com o usuário.                                                                              | `boolean`                        | `true`      |
+| `iconName` | `icon-name` | Nome do icone disponível no pacote de fontes [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html) | `string`                         | `undefined` |
+| `image`    | `image`     | Define o icone svg que será utilizado no botão. Esta propriedade só é utilizada caso o componente esteja no modo "icon"                    | `string`                         | `undefined` |
+| `label`    | `label`     | Texto indicativo da ação do botão.                                                                                                         | `string`                         | `undefined` |
+| `mode`     | `mode`      | Define o modo de uso do botão; opções: icon, link e regular                                                                                | `string`                         | `"regular"` |
+| `size`     | `size`      | É possível escolher entre [small,medium,large] (somente para os modos "icon" e "link")                                                     | `"large" \| "medium" \| "small"` | `undefined` |
+
+
+## Methods
+
+### `setBlur() => Promise<void>`
+
+Remove o foco no botão
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setFocus() => Promise<void>`
+
+Realiza o foco no botão
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-actions-button](../ez-actions-button)
+ - [ez-dialog](../ez-dialog)
+ - [ez-grid](../ez-grid)
+ - [ez-modal-container](../ez-modal-container)
+ - [ez-text-edit](../ez-text-edit)
+
+### Depends on
+
+- [ez-icon](../ez-icon)
+
+### Graph
+```mermaid
+graph TD;
+  ez-button --> ez-icon
+  ez-actions-button --> ez-button
+  ez-dialog --> ez-button
+  ez-grid --> ez-button
+  ez-modal-container --> ez-button
+  ez-text-edit --> ez-button
+  style ez-button fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-calendar/readme.md

@@ -0,0 +1,78 @@
+# ez-calendar
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property      | Attribute      | Description                                                                              | Type      | Default      |
+| ------------- | -------------- | ---------------------------------------------------------------------------------------- | --------- | ------------ |
+| `floating`    | `floating`     | No modo floating o calendário só se tornará visível quando o método show() for acionado. | `boolean` | `false`      |
+| `showSeconds` | `show-seconds` | Exibe ou não os segundos no calendario                                                   | `boolean` | `false`      |
+| `time`        | `time`         | Exibe ou não as horas e minutos no calendario                                            | `boolean` | `false`      |
+| `value`       | --             | A data selecionada no calendário                                                         | `Date`    | `new Date()` |
+
+
+## Events
+
+| Event      | Description                                               | Type                |
+| ---------- | --------------------------------------------------------- | ------------------- |
+| `ezChange` | Quando o usuário escolhe uma data, esse evento é emitido. | `CustomEvent<Date>` |
+
+
+## Methods
+
+### `fitVertical(topOffset: number, bottomOffset: number) => Promise<void>`
+
+Método necessário para ajustar o posicionamento do calendar acima ou abaixo do ez-date-input conforme a disponibilidade de espaço.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `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>`
+
+Usado no modo floating. Faz com que o componente seja exibido.
+É possível determinar ajustes de posicionamento através dos parâmetros
+top, left, bottom e right. Esses parâmetros devem ser informados como
+strings no formato css.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-date-input](../ez-date-input)
+ - [ez-date-time-input](../ez-date-time-input)
+
+### Graph
+```mermaid
+graph TD;
+  ez-date-input --> ez-calendar
+  ez-date-time-input --> ez-calendar
+  style ez-calendar fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

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

@@ -0,0 +1,24 @@
+# ez-card-item
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property | Attribute | Description | Type       | Default     |
+| -------- | --------- | ----------- | ---------- | ----------- |
+| `item`   | --        |             | `CardItem` | `undefined` |
+
+
+## Events
+
+| Event     | Description | Type                    |
+| --------- | ----------- | ----------------------- |
+| `ezClick` |             | `CustomEvent<CardItem>` |
+
+
+----------------------------------------------
+
+

package/components/ez-check/readme.md

@@ -0,0 +1,64 @@
+# ez-check
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property        | Attribute       | Description                                                                                                                                                                                                                                                                                        | Type      | Default             |
+| --------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------- |
+| `enabled`       | `enabled`       | Deixa o campo disponível ou não para interação com o usuário.                                                                                                                                                                                                                                      | `boolean` | `true`              |
+| `indeterminate` | `indeterminate` | Deixa o campo em um estado indeterminado, nem marcado nem desmarcado (não disponível em modo "switch").                                                                                                                                                                                            | `boolean` | `undefined`         |
+| `label`         | `label`         | Título do campo                                                                                                                                                                                                                                                                                    | `string`  | `undefined`         |
+| `mode`          | `mode`          | Existem dois modos de visualização: regular e switch. Se esta propriedade for omitida, o componete assume o formato "regular". No modo "regular" a visualização é a tradicional de uma caixinha marcada/desmarcada. No modo "switch" o campo tem uma interface em formato de um pino liga/desliga. | `string`  | `CheckMode.REGULAR` |
+| `value`         | `value`         | Como se trata de um componente binário, o valor alterna entre true e false (marcado / desmarcado)                                                                                                                                                                                                  | `boolean` | `undefined`         |
+
+
+## Events
+
+| Event      | Description                                              | Type               |
+| ---------- | -------------------------------------------------------- | ------------------ |
+| `ezChange` | Evento disparado ao mudar o estado do check(onEzChange). | `CustomEvent<any>` |
+
+
+## Methods
+
+### `getMode() => Promise<string>`
+
+Devolve o modo escolhido para o componente
+
+#### Returns
+
+Type: `Promise<string>`
+
+
+
+### `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-check
+  style ez-check fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-chip/readme.md

@@ -0,0 +1,66 @@
+# ez-chip
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property         | Attribute         | Description                                                                            | Type                  | Default     |
+| ---------------- | ----------------- | -------------------------------------------------------------------------------------- | --------------------- | ----------- |
+| `enabled`        | `enabled`         | Deixa o componente disponível ou não para seleção.                                     | `boolean`             | `true`      |
+| `label`          | `label`           | Título exibido no componente.                                                          | `string`              | `undefined` |
+| `mode`           | `mode`            | Define o modo de uso do cjip: label ou action                                          | `"action" \| "label"` | `undefined` |
+| `removePosition` | `remove-position` | Indica se o componente terá a opção de ser removido e qual sua posição: left ou right. | `"left" \| "right"`   | `undefined` |
+| `value`          | `value`           | Indica se o componente está ou não ativado.                                            | `boolean`             | `false`     |
+
+
+## Events
+
+| Event         | Description                                                                | Type                   |
+| ------------- | -------------------------------------------------------------------------- | ---------------------- |
+| `actionClick` | Evento disparado ao clicar no chip usando o modo "action" (onActionClick). | `CustomEvent<void>`    |
+| `removeChip`  | Evento disparado ao clicar no botão de remoção (onRemoveChip).             | `CustomEvent<void>`    |
+| `valueChange` | Evento disparado quando o estado do componente mudar (onValueChange).      | `CustomEvent<boolean>` |
+
+
+## Methods
+
+### `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
+
+### Depends on
+
+- [ez-icon](../ez-icon)
+
+### Graph
+```mermaid
+graph TD;
+  ez-chip --> ez-icon
+  style ez-chip fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

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

@@ -0,0 +1,90 @@
+# ez-collapsible-box
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute        | Description                                                      | Type                                                       | Default     |
+| ----------------- | ---------------- | ---------------------------------------------------------------- | ---------------------------------------------------------- | ----------- |
+| `conditionalSave` | --               | Define uma condição para salvar ou não uma alteração.            | `Function`                                                 | `undefined` |
+| `editable`        | `editable`       | Ativa o ícone para edição do componente.                         | `boolean`                                                  | `false`     |
+| `headerSize`      | `header-size`    | Define o tamanho do texto e do ícone do componente.              | `"large" \| "medium" \| "small" \| "x-large" \| "x-small"` | `"small"`   |
+| `iconPlacement`   | `icon-placement` | Define o local onde o ícone será renderizado.                    | `"left" \| "right"`                                        | `"left"`    |
+| `label`           | `label`          | Título do campo                                                  | `string`                                                   | `undefined` |
+| `removable`       | `removable`      | Ativa o ícone para remoção do componente.                        | `boolean`                                                  | `false`     |
+| `stretchTitle`    | `stretch-title`  | Define se o titulo irá ocupar toda a largura do componente.      | `boolean`                                                  | `false`     |
+| `value`           | `value`          | Valor externalizado que garante a exibição ou não do componente. | `boolean`                                                  | `false`     |
+
+
+## Events
+
+| Event             | Description                                                                                 | Type                            |
+| ----------------- | ------------------------------------------------------------------------------------------- | ------------------------------- |
+| `ezChange`        | Evento disparado ao mudar o estado do componente (onEzChange).                              | `CustomEvent<boolean>`          |
+| `ezEditLabelMode` | Evento disparado quando o modo de edição da label for aberto e fechado (onEzEditLabelMode). | `CustomEvent<boolean>`          |
+| `ezRemove`        | Evento disparado ao remover o componente (onEzRemove).                                      | `CustomEvent<EzCollapsibleBox>` |
+| `ezSaveEditLabel` | Evento disparado ao concluir edição da label (onEzSaveEditLabel).                           | `CustomEvent<CustomEvent<any>>` |
+
+
+## Methods
+
+### `applyFocusTextEdit() => Promise<void>`
+
+Aplica focus no campo de edição de título.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `cancelEdition() => Promise<void>`
+
+Fecha a edição de título.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `showHide() => Promise<void>`
+
+Esconde ou revela o conteúdo do componente.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-form](../ez-form)
+
+### Depends on
+
+- [ez-icon](../ez-icon)
+- [ez-text-edit](../ez-text-edit)
+
+### Graph
+```mermaid
+graph TD;
+  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-form --> ez-collapsible-box
+  style ez-collapsible-box fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

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

@@ -0,0 +1,91 @@
+# ez-combo-box
+
+
+
+<!-- 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 interação com usuário.                          | `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` |
+| `options`             | --                      | Array no formato "{value: string, label: string}" que alimenta as opções do Combobox | `IOption[]`         | `undefined` |
+| `searchMode`          | `search-mode`           | Ativa o modo pesquisa do combobox                                                    | `boolean`           | `undefined` |
+| `showOptionValue`     | `show-option-value`     | Ajusta a opção de mostrar o "value" para cada opção. Por padrão não mostra           | `boolean`           | `false`     |
+| `showSelectedValue`   | `show-selected-value`   | Ajusta a opção de mostrar o "value" ao selecionar uma opção. Por padrão não mostra.  | `boolean`           | `false`     |
+| `suppressEmptyOption` | `suppress-empty-option` | Remove a opção vazia da lista de opções                                              | `boolean`           | `false`     |
+| `suppressSearch`      | `suppress-search`       | Desabilita a digitação dentro do componente.                                         | `boolean`           | `false`     |
+| `value`               | `value`                 | Valor selecionado no campo                                                           | `IOption \| string` | `undefined` |
+
+
+## Events
+
+| Event      | Description                                             | Type                   |
+| ---------- | ------------------------------------------------------- | ---------------------- |
+| `ezChange` | Evento que é disparado ao alterar o valor do componente | `CustomEvent<IOption>` |
+
+
+## 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 seleção
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setFocus() => Promise<void>`
+
+Realiza o foco no componente de seleção
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-form](../ez-form)
+ - [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 --> 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,83 @@
+# ez-date-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"` |
+| `value`        | --              | A data informada pelo usuário                                        | `Date`    | `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 ao mudar o estado do componente(onEzChange).                                                                 | `CustomEvent<Date>`          |
+| `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 data
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setFocus() => Promise<void>`
+
+Realiza o foco no componente de data
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-form](../ez-form)
+
+### 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 --> ez-date-input
+  style ez-date-input fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+