@sankhyalabs/ezui-docs 0.0.0-hotfix-ga-KB-999999.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`       | --               | Define a lista de ações. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IAction[]`                      | `undefined` |
+| `arrowActive`   | `arrow-active`   | Se true a seta de ordenação será apresentada.                                                     | `boolean`                        | `false`     |
+| `checkOption`   | `check-option`   | Se true o check será apresentado para os itens.                                                   | `boolean`                        | `false`     |
+| `displayIcon`   | `display-icon`   | Define o ícone do componente.                                                                     | `string`                         | `undefined` |
+| `enabled`       | `enabled`        | Se false o usuário não pode interagir com o componente.                                           | `boolean`                        | `true`      |
+| `isTransparent` | `is-transparent` | Se true o background será transparent.                                                            | `boolean`                        | `false`     |
+| `showLabel`     | `show-label`     | Se true o label será apresentado.                                                                 | `boolean`                        | `false`     |
+| `size`          | `size`           | Determina o tamanho do ez-action-button.                                                          | `"large" \| "medium" \| "small"` | `"medium"`  |
+| `value`         | `value`          | Define o valor do componente.                                                                     | `string`                         | `undefined` |
+
+
+## Events
+
+| Event      | Description                  | Type                   |
+| ---------- | ---------------------------- | ---------------------- |
+| `ezAction` | Emitido 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á aberta.
+
+#### 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-alert/readme.md

@@ -0,0 +1,30 @@
+# ez-alert
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property    | Attribute    | Description                                            | Type                                | Default     |
+| ----------- | ------------ | ------------------------------------------------------ | ----------------------------------- | ----------- |
+| `alertType` | `alert-type` | Define a cor e o ícone a serem exibidos no componente. | `"critical" \| "success" \| "warn"` | `'success'` |
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-icon](../ez-icon)
+
+### Graph
+```mermaid
+graph TD;
+  ez-alert --> ez-icon
+  style ez-alert 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-badge/readme.md

@@ -0,0 +1,34 @@
+# ez-badge
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property    | Attribute    | Description                                                                                                                                         | Type                                                                                 | Default                                    |
+| ----------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------ |
+| `iconLeft`  | `icon-left`  | Define o ícone a ser usado no lado esquerdo do badge: [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html) | `string`                                                                             | `undefined`                                |
+| `iconRight` | `icon-right` | Define o ícone a ser usado no lado direito do badge: [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html)  | `string`                                                                             | `undefined`                                |
+| `label`     | `label`      | Define o conteúdo textual ou numérico do componente.                                                                                                | `string`                                                                             | `undefined`                                |
+| `position`  | --           | Define a posição do ícone em relação ao elemento filho.                                                                                             | `IPosition`                                                                          | `{ horizontal: "right", vertical: "top" }` |
+| `size`      | `size`       | Define o tamanho de acordo com o tipo utilizado pelo componente.                                                                                    | `"extra-large" \| "extra-small" \| "large" \| "medium" \| "small" \| "small-medium"` | `"small"`                                  |
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-icon](../ez-icon)
+
+### Graph
+```mermaid
+graph TD;
+  ez-badge --> ez-icon
+  style ez-badge fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-breadcrumb/readme.md

@@ -0,0 +1,43 @@
+# ez-breadcrumb
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property           | Attribute           | Description                                                    | Type                  | Default  |
+| ------------------ | ------------------- | -------------------------------------------------------------- | --------------------- | -------- |
+| `fillMode`         | `fill-mode`         | Define o modo de uso do Breadcrumb.                            | `"auto" \| "regular"` | `"auto"` |
+| `items`            | --                  | Lista de itens do breadcrumb.                                  | `IBreadcrumbItem[]`   | `[]`     |
+| `maxItems`         | `max-items`         | Define o limite máximo de itens a serem renderizados.          | `number`              | `4`      |
+| `positionEllipsis` | `position-ellipsis` | Define a posição do Ellipsis nos itens visíveis do Breadcrumb. | `number`              | `1`      |
+
+
+## Events
+
+| Event          | Description                                         | Type                           |
+| -------------- | --------------------------------------------------- | ------------------------------ |
+| `selectedItem` | Emitido quando um item do breadcrumb é selecionado. | `CustomEvent<IBreadcrumbItem>` |
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-icon](../ez-icon)
+- [ez-dropdown](../ez-dropdown)
+
+### Graph
+```mermaid
+graph TD;
+  ez-breadcrumb --> ez-icon
+  ez-breadcrumb --> ez-dropdown
+  ez-dropdown --> ez-icon
+  style ez-breadcrumb fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-button/readme.md

@@ -0,0 +1,75 @@
+# ez-button
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property   | Attribute   | Description                                                                                                                                       | Type                                            | Default     |
+| ---------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
+| `enabled`  | `enabled`   | Se false o usuário não pode interagir com o botão.                                                                                                | `boolean`                                       | `true`      |
+| `iconName` | `icon-name` | Define o ícone a ser usado da biblioteca de ícones: [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html) | `string`                                        | `undefined` |
+| `image`    | `image`     | Define o caminho usado nos modos `icon` e `label-icon` para imagens não contempladas na biblioteca de ícones.                                     | `string`                                        | `undefined` |
+| `label`    | `label`     | Texto a ser apresentado como título do botão.                                                                                                     | `string`                                        | `undefined` |
+| `mode`     | `mode`      | Define o modo de uso do botão.                                                                                                                    | `"icon" \| "label-icon" \| "link" \| "regular"` | `"regular"` |
+| `size`     | `size`      | Define o tamanho do ez-button.                                                                                                                    | `"large" \| "medium" \| "small"`                | `undefined` |
+
+
+## Methods
+
+### `setBlur() => Promise<void>`
+
+Remove o foco do botão.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setFocus() => Promise<void>`
+
+Aplica 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-guide-navigator](../ez-guide-navigator)
+ - [ez-modal-container](../ez-modal-container)
+ - [ez-text-edit](../ez-text-edit)
+ - [filter-column](../ez-grid/subcomponents)
+
+### 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-guide-navigator --> ez-button
+  ez-modal-container --> ez-button
+  ez-text-edit --> ez-button
+  filter-column --> ez-button
+  style ez-button fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-calendar/readme.md

@@ -0,0 +1,76 @@
+# ez-calendar
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property      | Attribute      | Description                                                                             | Type      | Default      |
+| ------------- | -------------- | --------------------------------------------------------------------------------------- | --------- | ------------ |
+| `floating`    | `floating`     | Define se a exibição do ez-calendar será feita pelos métodos `show()` e `hide()`.       | `boolean` | `false`      |
+| `showSeconds` | `show-seconds` | Se true a data considera segundos. Deve ser usado em conjunto com a propriedade `time`. | `boolean` | `false`      |
+| `time`        | `time`         | Se true a data considera horas e minutos.                                               | `boolean` | `false`      |
+| `value`       | --             | Define o valor do calendário.                                                           | `Date`    | `new Date()` |
+
+
+## Events
+
+| Event      | Description                                                 | Type                |
+| ---------- | ----------------------------------------------------------- | ------------------- |
+| `ezChange` | Emitido quando acontece a alteração de valor do calendário. | `CustomEvent<Date>` |
+
+
+## Methods
+
+### `fitVertical(topOffset: number, bottomOffset: number) => Promise<void>`
+
+Ajusta o posicionamento do ez-calendar conforme a disponibilidade de espaço.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `hide() => Promise<void>`
+
+Oculta o ez-calendar.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `show(top?: string, left?: string, bottom?: string, right?: string) => Promise<void>`
+
+Exibe o ez-calendar em uma posição determinada.
+É possível determinar o posicionamento através dos parâmetros, 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`   | --        | Determina o conteúdo do card. Deve conter um objeto no formato: `{title: string, key: string, details: any}`. | `CardItem` | `undefined` |
+
+
+## Events
+
+| Event     | Description                             | Type                    |
+| --------- | --------------------------------------- | ----------------------- |
+| `ezClick` | Emitido sempre que o ez-card é clicado. | `CustomEvent<CardItem>` |
+
+
+----------------------------------------------
+
+

package/components/ez-check/readme.md

@@ -0,0 +1,69 @@
+# ez-check
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property        | Attribute       | Description                                                                                         | Type                                    | Default             |
+| --------------- | --------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------- | ------------------- |
+| `compact`       | `compact`       | Define o modo compacto com espaçamento menor entre label e o input                                  | `boolean`                               | `false`             |
+| `enabled`       | `enabled`       | Se false o usuário não pode interagir com o campo.                                                  | `boolean`                               | `true`              |
+| `indeterminate` | `indeterminate` | Se true ativa o estado indeterminado, nem marcado nem desmarcado (não disponível em modo `switch`). | `boolean`                               | `undefined`         |
+| `label`         | `label`         | Texto a ser apresentado como título do campo.                                                       | `string`                                | `undefined`         |
+| `mode`          | `mode`          | Define o modo de visualização do ez-check.                                                          | `CheckMode.REGULAR \| CheckMode.SWITCH` | `CheckMode.REGULAR` |
+| `value`         | `value`         | Define o valor do campo.                                                                            | `boolean`                               | `undefined`         |
+
+
+## Events
+
+| Event      | Description                                            | Type               |
+| ---------- | ------------------------------------------------------ | ------------------ |
+| `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<any>` |
+
+
+## Methods
+
+### `getMode() => Promise<CheckMode>`
+
+Obtém o modo escolhido.
+
+#### Returns
+
+Type: `Promise<CheckMode>`
+
+
+
+### `setFocus() => Promise<void>`
+
+Aplica o foco no campo.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-form-view](../ez-form-view)
+ - [ez-list](../ez-list)
+ - [ez-multi-selection-list](../ez-multi-selection-list)
+
+### Graph
+```mermaid
+graph TD;
+  ez-form-view --> ez-check
+  ez-list --> ez-check
+  ez-multi-selection-list --> ez-check
+  style ez-check fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-chip/readme.md

@@ -0,0 +1,67 @@
+# ez-chip
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property            | Attribute             | Description                                                                                                             | Type                  | Default     |
+| ------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------- | --------------------- | ----------- |
+| `enabled`           | `enabled`             | Se false o usuário não pode interagir com o ez-chip.                                                                    | `boolean`             | `true`      |
+| `label`             | `label`               | Texto a ser apresentado como título do ez-chip.                                                                         | `string`              | `undefined` |
+| `mode`              | `mode`                | Define o modo de uso do ez-chip.                                                                                        | `"action" \| "label"` | `undefined` |
+| `removePosition`    | `remove-position`     | Determina o posicionamento do botão de remover (não disponível no modo `action`).  Se não informado, não exibe o botão. | `"left" \| "right"`   | `undefined` |
+| `showNativeTooltip` | `show-native-tooltip` | Exibe condicionalmente o tooltip nativo do navegador ao sobrepor o cursor acima do elemento.                            | `boolean`             | `true`      |
+| `value`             | `value`               | Define o valor do ez-chip.                                                                                              | `boolean`             | `false`     |
+
+
+## Events
+
+| Event         | Description                                                 | Type                   |
+| ------------- | ----------------------------------------------------------- | ---------------------- |
+| `actionClick` | Emitido no modo "action" quando o usuário clica no ez-chip. | `CustomEvent<void>`    |
+| `removeChip`  | Emitido quando o botão de remoção é acionado.               | `CustomEvent<void>`    |
+| `valueChange` | Emitido quando acontece a alteração de valor do ez-chip.    | `CustomEvent<boolean>` |
+
+
+## Methods
+
+### `setBlur() => Promise<void>`
+
+Remove o foco do ez-chip.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setFocus() => Promise<void>`
+
+Aplica o foco no ez-chip.
+
+#### 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,92 @@
+# ez-collapsible-box
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute        | Description                                              | Type                                                       | Default     |
+| ----------------- | ---------------- | -------------------------------------------------------- | ---------------------------------------------------------- | ----------- |
+| `boxBordered`     | `box-bordered`   | Define seu o componente deve ter borda                   | `boolean`                                                  | `false`     |
+| `conditionalSave` | --               | Define uma condição para salvar ou não uma alteração.    | `Function`                                                 | `undefined` |
+| `editable`        | `editable`       | Se true mostra o ícone para edição do componente.        | `boolean`                                                  | `false`     |
+| `headerAlign`     | `header-align`   | Define a posição do conteúdo do cabeçalho do componente. | `"center" \| "left" \| "right" \| "stretch"`               | `"left"`    |
+| `headerSize`      | `header-size`    | Define o tamanho do texto e do ícone.                    | `"large" \| "medium" \| "small" \| "x-large" \| "x-small"` | `"small"`   |
+| `iconPlacement`   | `icon-placement` | Define o posicionamento do ícone.                        | `"left" \| "right"`                                        | `"left"`    |
+| `label`           | `label`          | Texto a ser apresentado como título do componente.       | `string`                                                   | `undefined` |
+| `removable`       | `removable`      | Se true mostra o ícone para remoção do componente.       | `boolean`                                                  | `false`     |
+| `subtitle`        | `subtitle`       | Texto a ser apresentado como subtítulo do componente.    | `string`                                                   | `undefined` |
+| `value`           | `value`          | Define o valor do componente.                            | `boolean`                                                  | `false`     |
+
+
+## Events
+
+| Event             | Description                                                                        | Type                            |
+| ----------------- | ---------------------------------------------------------------------------------- | ------------------------------- |
+| `ezChange`        | Emitido quando acontece a alteração de valor do componente.                        | `CustomEvent<boolean>`          |
+| `ezEditLabelMode` | Emitido quando o modo de edição da label for aberto e fechado (onEzEditLabelMode). | `CustomEvent<boolean>`          |
+| `ezRemove`        | Emitido ao remover o componente (onEzRemove).                                      | `CustomEvent<EzCollapsibleBox>` |
+| `ezSaveEditLabel` | Emitido ao concluir edição da label (onEzSaveEditLabel).                           | `CustomEvent<CustomEvent<any>>` |
+
+
+## Methods
+
+### `applyFocusTextEdit() => Promise<void>`
+
+Aplica o foco no campo de edição de título.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `cancelEdition() => Promise<void>`
+
+Cancela a edição de título.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `showHide() => Promise<void>`
+
+Oculta/mostra o conteúdo do ez-collapsible-box.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-form-view](../ez-form-view)
+
+### 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-view --> ez-collapsible-box
+  style ez-collapsible-box fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+