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

package/components/ez-modal/readme.md

@@ -0,0 +1,31 @@
+# ez-modal
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property            | Attribute             | Description                                                                                          | Type                  | Default     |
+| ------------------- | --------------------- | ---------------------------------------------------------------------------------------------------- | --------------------- | ----------- |
+| `align`             | `align`               | Define o alinhamento do ez-modal.                                                                    | `"left" \| "right"`   | `undefined` |
+| `closeEsc`          | `close-esc`           | Define se o ez-modal será fechado ao clicar `ESC`.                                                   | `boolean`             | `false`     |
+| `closeOutsideClick` | `close-outside-click` | Define se o modal será fechado ao clicar fora do conteúdo.                                           | `boolean`             | `false`     |
+| `heightMode`        | `height-mode`         | Ativa o modo Full, permitindo que o Modal expanda-se verticalmente e ocupe todo o espaço disponível. | `"full" \| "regular"` | `"regular"` |
+| `modalSize`         | `modal-size`          | Define o tamanho do ez-modal. Devem ser definidas seguindo grid-layout. Exemplo: `col-sd-3`.         | `string`              | `undefined` |
+| `opened`            | `opened`              | Define se o ez-modal está aberto.                                                                    | `boolean`             | `true`      |
+| `scrim`             | `scrim`               | Define o tipo de scrim a ser aplicado no overlay do modal                                            | `"light" \| "medium"` | `"medium"`  |
+
+
+## Events
+
+| Event          | Description                       | Type                   |
+| -------------- | --------------------------------- | ---------------------- |
+| `ezCloseModal` | Emitido quando o modal é fechado. | `CustomEvent<boolean>` |
+| `ezOpenModal`  | Emitido quando o modal é aberto.  | `CustomEvent<any>`     |
+
+
+----------------------------------------------
+
+

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`  | Define o texto do botão de cancelamento.                         | `string`                              | `undefined` |
+| `cancelButtonStatus` | `cancel-button-status` | Define o estado do botão de cancelamento.                        | `"DISABLED" \| "ENABLED" \| "HIDDEN"` | `undefined` |
+| `modalSubTitle`      | `modal-sub-title`      | Texto do subtítulo, geralmente usado para orientação do usuário. | `string`                              | `undefined` |
+| `modalTitle`         | `modal-title`          | Texto a ser apresentado como título do modal.                    | `string`                              | `undefined` |
+| `okButtonLabel`      | `ok-button-label`      | Determina o texto do botão de confirmação.                       | `string`                              | `undefined` |
+| `okButtonStatus`     | `ok-button-status`     | Define o estado do botão de confirmação.                         | `"DISABLED" \| "ENABLED" \| "HIDDEN"` | `undefined` |
+| `showTitleBar`       | `show-title-bar`       | Define se o cabeçalho 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-multi-selection-list/readme.md

@@ -0,0 +1,74 @@
+# ez-multi-selection-list
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property     | Attribute     | Description                                                                                                                        | Type                            | Default     |
+| ------------ | ------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ----------- |
+| `columnName` | `column-name` | Nome da coluna onde serão aplicadas as opções selecionadas.                                                                        | `string`                        | `undefined` |
+| `dataSource` | --            | Classe que implementa o método fetchData, responsável por realizar a pesquisa dos dados, com base no termo informado pelo usuário. | `IMultiSelectionListDataSource` | `undefined` |
+| `options`    | --            | Opções de filtros a serem exibidas na listagem.                                                                                    | `IMultiSelectionOption[]`       | `undefined` |
+| `useOptions` | `use-options` | Indica se deve ser exibida lista de opções do atributo options (true), ou se deve utilizar o datasource (false)                    | `boolean`                       | `false`     |
+
+
+## Events
+
+| Event                   | Description                                                             | Type                                   |
+| ----------------------- | ----------------------------------------------------------------------- | -------------------------------------- |
+| `changeFilteredOptions` | Evento que informa que a lista de opções selecionadas sofreu alteração. | `CustomEvent<IMultiSelectionOption[]>` |
+
+
+## Methods
+
+### `clearFilteredOptions() => Promise<void>`
+
+
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [filter-column](../ez-grid/subcomponents)
+
+### Depends on
+
+- [ez-check](../ez-check)
+- [ez-list](../ez-list)
+- [ez-icon](../ez-icon)
+- [multi-selection-box-message](subcomponents)
+- [ez-filter-input](../ez-filter-input)
+- [ez-search](../ez-search)
+
+### Graph
+```mermaid
+graph TD;
+  ez-multi-selection-list --> ez-check
+  ez-multi-selection-list --> ez-list
+  ez-multi-selection-list --> ez-icon
+  ez-multi-selection-list --> multi-selection-box-message
+  ez-multi-selection-list --> ez-filter-input
+  ez-multi-selection-list --> ez-search
+  ez-list --> ez-check
+  ez-filter-input --> ez-text-input
+  ez-filter-input --> ez-icon
+  ez-search --> ez-combo-box
+  ez-combo-box --> ez-text-input
+  ez-combo-box --> ez-icon
+  filter-column --> ez-multi-selection-list
+  style ez-multi-selection-list fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-multi-selection-list/subcomponents/readme.md

@@ -0,0 +1,30 @@
+# multi-selection-box-message
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property  | Attribute | Description | Type     | Default     |
+| --------- | --------- | ----------- | -------- | ----------- |
+| `message` | `message` |             | `string` | `undefined` |
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-multi-selection-list](..)
+
+### Graph
+```mermaid
+graph TD;
+  ez-multi-selection-list --> multi-selection-box-message
+  style multi-selection-box-message fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

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

@@ -0,0 +1,94 @@
+# ez-number-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"` |
+| `precision`       | `precision`        | Define quantas casas decimais serão exibidas. Caso haja mais casas haverá arredondamento.                              | `number`              | `undefined` |
+| `prettyPrecision` | `pretty-precision` | Define qual é o mínimo de casas depois da vírgula. Exemplo: 1,1 será exibido como 1,1000 quando `prettyPrecision = 4`. | `number`              | `undefined` |
+| `value`           | `value`            | Define o valor do campo.                                                                                               | `number`              | `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<number>`        |
+| `ezStartChange`         | Emitido ao iniciar a alteração (digitação incompleta).                                         | `CustomEvent<WaitingChange>` |
+
+
+## Methods
+
+### `getValueAsync() => Promise<number>`
+
+
+
+#### Returns
+
+Type: `Promise<number>`
+
+
+
+### `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(options?: TFocusOptions) => 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)
+
+### Graph
+```mermaid
+graph TD;
+  ez-number-input --> ez-text-input
+  ez-form-view --> ez-number-input
+  style ez-number-input fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-popover/readme.md

@@ -0,0 +1,84 @@
+# ez-popover
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property       | Attribute       | Description                                                                       | Type                            | Default         |
+| -------------- | --------------- | --------------------------------------------------------------------------------- | ------------------------------- | --------------- |
+| `autoClose`    | `auto-close`    | Define que será fechado automaticamente quando o usuário clicar fora do conteúdo. | `boolean`                       | `true`          |
+| `boxWidth`     | `box-width`     | Ajusta o comportamento da largura do popover.                                     | `"fit-content" \| "full-width"` | `"fit-content"` |
+| `innerElement` | `inner-element` | Define as tags que serão consideradas conteúdo.                                   | `string \| string[]`            | `undefined`     |
+| `opened`       | `opened`        | Define se o ez-popover está aberto.                                               | `boolean`                       | `undefined`     |
+| `overlayType`  | `overlay-type`  | Define o tipo de overlay do popover.                                              | `"light" \| "medium" \| "none"` | `"light"`       |
+
+
+## Events
+
+| Event                | Description                                                  | Type                   |
+| -------------------- | ------------------------------------------------------------ | ---------------------- |
+| `ezVisibilityChange` | Emitido quando acontece a alteração de estado do componente. | `CustomEvent<boolean>` |
+
+
+## Methods
+
+### `hide() => Promise<void>`
+
+Oculta o ez-popover.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `show(top?: string, left?: string) => Promise<void>`
+
+Exibe o ez-popover.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `showUnder(element: HTMLElement, options?: IEzPopoverAnchorOptions) => Promise<void>`
+
+Ancora a exibição do popOver a um elemento HTML.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `updatePosition(top?: string, left?: string) => Promise<void>`
+
+Atualiza a posição do popover.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [filter-column](../ez-grid/subcomponents)
+
+### Graph
+```mermaid
+graph TD;
+  filter-column --> ez-popover
+  style ez-popover fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-popup/readme.md

@@ -0,0 +1,28 @@
+# ez-popup
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property     | Attribute     | Description                                        | Type                                                       | Default     |
+| ------------ | ------------- | -------------------------------------------------- | ---------------------------------------------------------- | ----------- |
+| `ezTitle`    | `ez-title`    | Texto a ser apresentado como título do componente. | `string`                                                   | `undefined` |
+| `heightMode` | `height-mode` | Define altura do componente.                       | `"auto" \| "full"`                                         | `"full"`    |
+| `opened`     | `opened`      | Define se o ez-popover está aberto.                | `boolean`                                                  | `false`     |
+| `size`       | `size`        | Define a largura do ez-popup.                      | `"large" \| "medium" \| "small" \| "x-large" \| "x-small"` | `"medium"`  |
+| `useHeader`  | `use-header`  | Define se o componente utilizará cabeçalho.        | `boolean`                                                  | `true`      |
+
+
+## Events
+
+| Event          | Description                                            | Type               |
+| -------------- | ------------------------------------------------------ | ------------------ |
+| `ezClosePopup` | Emitido 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 dos itens.                        | `"horizontal" \| "vertical"` | `"vertical"` |
+| `enabled`   | `enabled`   | Se false o usuário não pode interagir com o campo. | `boolean`                    | `true`       |
+| `label`     | `label`     | Texto a ser apresentado como título do campo.      | `string`                     | `undefined`  |
+| `options`   | --          | Define as opções que serão apresentadas            | `Radio[]`                    | `[]`         |
+| `value`     | `value`     | Define o valor do campo.                           | `any`                        | `undefined`  |
+
+
+## Events
+
+| Event      | Description                                            | Type               |
+| ---------- | ------------------------------------------------------ | ------------------ |
+| `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<any>` |
+
+
+----------------------------------------------
+
+

package/components/ez-scroller/readme.md

@@ -0,0 +1,32 @@
+# ez-scroller
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property       | Attribute       | Description                            | Type                                                                                   | Default     |
+| -------------- | --------------- | -------------------------------------- | -------------------------------------------------------------------------------------- | ----------- |
+| `activeShadow` | `active-shadow` | Define se haverá efeito de sombreado.  | `boolean`                                                                              | `false`     |
+| `direction`    | `direction`     | Define a direção em que haverá scroll. | `EzScrollDirection.BOTH \| EzScrollDirection.HORIZONTAL \| EzScrollDirection.VERTICAL` | `undefined` |
+| `locked`       | `locked`        | Define se o `scroll` estará bloqueado. | `boolean`                                                                              | `false`     |
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-guide-navigator](../ez-guide-navigator)
+
+### Graph
+```mermaid
+graph TD;
+  ez-guide-navigator --> ez-scroller
+  style ez-scroller fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-search/readme.md

@@ -0,0 +1,109 @@
+# ez-search
+
+
+
+<!-- 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` |
+| `showOptionValue`     | `show-option-value`     | Se false cada opção na lista deve exibir somente o `label`.                       | `boolean`                                                                   | `true`      |
+| `showSelectedValue`   | `show-selected-value`   | Se false a opção selecionada deve exibir somente o `label`.                       | `boolean`                                                                   | `true`      |
+| `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista.                                            | `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-multi-selection-list](../ez-multi-selection-list)
+
+### 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-view --> ez-search
+  ez-multi-selection-list --> ez-search
+  style ez-search fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

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

@@ -0,0 +1,30 @@
+# ez-sidebar-button
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Events
+
+| Event     | Description                                       | Type                |
+| --------- | ------------------------------------------------- | ------------------- |
+| `ezClick` | Emitido sempre que o ez-sidebar-button é clicado. | `CustomEvent<void>` |
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-guide-navigator](../ez-guide-navigator)
+
+### Graph
+```mermaid
+graph TD;
+  ez-guide-navigator --> ez-sidebar-button
+  style ez-sidebar-button fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-skeleton/readme.md

@@ -0,0 +1,22 @@
+# ez-skeleton
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property       | Attribute       | Description                                       | Type                                                  | Default      |
+| -------------- | --------------- | ------------------------------------------------- | ----------------------------------------------------- | ------------ |
+| `animation`    | `animation`     | Animation type                                    | `"false" \| "progress" \| "progress-dark" \| "pulse"` | `'progress'` |
+| `count`        | `count`         | Number of rows of current skeleton type           | `number`                                              | `1`          |
+| `height`       | `height`        | Height of the skeleton ex. 100px, 100%, auto etc. | `string`                                              | `null`       |
+| `marginBottom` | `margin-bottom` | MarginBottom of the skeleton ex. 10px, 0 etc.     | `string`                                              | `null`       |
+| `variant`      | `variant`       | Variant of the skeleton - circle or row           | `"circle" \| "rect" \| "text"`                        | `'text'`     |
+| `width`        | `width`         | Width of the skeleton ex. 100px, 100%, auto etc.  | `string`                                              | `null`       |
+
+
+----------------------------------------------
+
+

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. Podendo serem separadas por vírgula "," ou em um Array de configuração. | `Tab[] \| string` | `undefined` |
+
+
+## Events
+
+| Event      | Description                                                 | Type               |
+| ---------- | ----------------------------------------------------------- | ------------------ |
+| `ezChange` | Emitido quando acontece a alteração de valor do componente. | `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
+```
+
+----------------------------------------------
+
+