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

package/components/ez-form-view/readme.md

@@ -0,0 +1,90 @@
+# ez-form-view
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property | Attribute | Description                                                               | Type               | Default     |
+| -------- | --------- | ------------------------------------------------------------------------- | ------------------ | ----------- |
+| `fields` | --        | Define a lista de metadados usada para criar os campos de user interface. | `IFormViewField[]` | `undefined` |
+
+
+## Events
+
+| Event            | Description                                                         | Type                         |
+| ---------------- | ------------------------------------------------------------------- | ---------------------------- |
+| `ezContentReady` | Evento emitido quando o componente foi totalmente carregado na DOM. | `CustomEvent<HTMLElement[]>` |
+
+
+## Methods
+
+### `showUp() => Promise<void>`
+
+
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-form](../ez-form)
+
+### Depends on
+
+- [ez-collapsible-box](../ez-collapsible-box)
+- [ez-check](../ez-check)
+- [ez-combo-box](../ez-combo-box)
+- [ez-date-input](../ez-date-input)
+- [ez-time-input](../ez-time-input)
+- [ez-date-time-input](../ez-date-time-input)
+- [ez-upload](../ez-upload)
+- [ez-number-input](../ez-number-input)
+- [ez-search](../ez-search)
+- [ez-text-area](../ez-text-area)
+- [ez-text-input](../ez-text-input)
+
+### Graph
+```mermaid
+graph TD;
+  ez-form-view --> ez-collapsible-box
+  ez-form-view --> ez-check
+  ez-form-view --> ez-combo-box
+  ez-form-view --> ez-date-input
+  ez-form-view --> ez-time-input
+  ez-form-view --> ez-date-time-input
+  ez-form-view --> ez-upload
+  ez-form-view --> ez-number-input
+  ez-form-view --> ez-search
+  ez-form-view --> ez-text-area
+  ez-form-view --> ez-text-input
+  ez-collapsible-box --> ez-icon
+  ez-collapsible-box --> ez-text-edit
+  ez-text-edit --> ez-text-input
+  ez-text-edit --> ez-button
+  ez-button --> ez-icon
+  ez-combo-box --> ez-text-input
+  ez-combo-box --> ez-icon
+  ez-date-input --> ez-text-input
+  ez-date-input --> ez-calendar
+  ez-time-input --> ez-text-input
+  ez-time-input --> ez-icon
+  ez-date-time-input --> ez-text-input
+  ez-date-time-input --> ez-calendar
+  ez-number-input --> ez-text-input
+  ez-search --> ez-combo-box
+  ez-form --> ez-form-view
+  style ez-form-view fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-grid/readme.md

@@ -0,0 +1,153 @@
+# ez-grid
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property                 | Attribute            | Description                                                                                              | Type                                            | Default     |
+| ------------------------ | -------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
+| `canEdit`                | `can-edit`           | Define se a edição está habilitada na grid.                                                              | `boolean`                                       | `true`      |
+| `columnfilterDataSource` | --                   | Define um `IMultiSelectionListDataSource` responsável por alimentar o filtro de colunas.                 | `IMultiSelectionListDataSource`                 | `undefined` |
+| `config`                 | --                   | Configuração de exibição da grade.                                                                       | `IGridConfig`                                   | `undefined` |
+| `dataUnit`               | --                   | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit`                                      | `undefined` |
+| `multipleSelection`      | `multiple-selection` | Habilita a seleção de várias linhas.                                                                     | `boolean`                                       | `undefined` |
+| `recordsValidator`       | --                   | Define um validador responsável pela integridade dos registros.                                          | `IRecordValidator`                              | `undefined` |
+| `selectionToastConfig`   | --                   | Configuração da seleção de grade no toast.                                                               | `ISelectionToastConfig`                         | `undefined` |
+| `serverUrl`              | `server-url`         | Endereço do servidor para obtenção dos dados.                                                            | `string`                                        | `undefined` |
+| `statusResolver`         | --                   | Define um `IStatusResolver` responsável pelo estado da coluna de status.                                 | `((data: object) => string) \| IStatusResolver` | `undefined` |
+| `useEnterLikeTab`        | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.                          | `boolean`                                       | `false`     |
+
+
+## Events
+
+| Event                 | Description                                                                                 | Type                                 |
+| --------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------ |
+| `componentReady`      | Emitido quando o componente estiver completamente carregado.                                | `CustomEvent<void>`                  |
+| `configChange`        | Emitido quando acontece a alteração de configuração do grade.                               | `CustomEvent<IGridConfig>`           |
+| `ezColumnStateChange` | Emitido quando acontece a alteração de estado das colunas do grid: Ordenação, largura, etc. | `CustomEvent<EzGridColumStateEvent>` |
+| `ezDoubleClick`       | Emitido com o duplo clique de uma linha                                                     | `CustomEvent<any>`                   |
+| `ezSelectionChange`   | Emitido quando acontece a alteração de seleção de linhas.                                   | `CustomEvent<ISelection>`            |
+
+
+## Methods
+
+### `addColumnMenuItem(label: string, name: string, action: Function, icon: HTMLElement | string) => Promise<void>`
+
+Adiciona item de menu nas colunas.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `getColumns() => Promise<Array<EzGridColumn>>`
+
+Obtém a lista de definição de colunas.
+
+#### Returns
+
+Type: `Promise<EzGridColumn[]>`
+
+
+
+### `getColumnsState() => Promise<Array<EzGridColumn>>`
+
+Obtém o estado atual das colunas.
+
+#### Returns
+
+Type: `Promise<EzGridColumn[]>`
+
+
+
+### `getSelection() => Promise<Array<any>>`
+
+Obtém as linhas selecionadas.
+
+#### Returns
+
+Type: `Promise<any[]>`
+
+
+
+### `quickFilter(term: string) => Promise<void>`
+
+Aplica um filtro rápido.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setColumnsDef(cols: Array<EzGridColumn>) => Promise<void>`
+
+Aplica a definição de colunas.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setColumnsState(state: Array<EzGridColumnConfig>) => Promise<void>`
+
+Aplica o estado das colunas.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setData(data: Array<any>) => Promise<void>`
+
+Insere os registros no ez-grid.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-button](../ez-button)
+- [filter-column](subcomponents)
+- [ez-icon](../ez-icon)
+
+### Graph
+```mermaid
+graph TD;
+  ez-grid --> ez-button
+  ez-grid --> filter-column
+  ez-grid --> ez-icon
+  ez-button --> ez-icon
+  filter-column --> ez-popover
+  filter-column --> ez-button
+  filter-column --> ez-multi-selection-list
+  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
+  style ez-grid fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-grid/subcomponents/readme.md

@@ -0,0 +1,88 @@
+# filter-column
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property           | Attribute            | Description | Type                            | Default     |
+| ------------------ | -------------------- | ----------- | ------------------------------- | ----------- |
+| `columnLabel`      | `column-label`       |             | `string`                        | `undefined` |
+| `columnName`       | `column-name`        |             | `string`                        | `undefined` |
+| `dataSource`       | --                   |             | `IMultiSelectionListDataSource` | `undefined` |
+| `dataUnit`         | --                   |             | `DataUnit`                      | `undefined` |
+| `gridHeaderHidden` | `grid-header-hidden` |             | `boolean`                       | `false`     |
+| `opened`           | `opened`             |             | `boolean`                       | `true`      |
+| `options`          | --                   |             | `IMultiSelectionOption[]`       | `undefined` |
+
+
+## Events
+
+| Event                      | Description | Type                                       |
+| -------------------------- | ----------- | ------------------------------------------ |
+| `applyFilterColumnOptions` |             | `CustomEvent<IAppliedFilterColumnOptions>` |
+
+
+## Methods
+
+### `hide() => Promise<void>`
+
+
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `show(configs: IFilterColumnConfigs) => Promise<void>`
+
+Abre o filtro de coluna.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-grid](..)
+
+### Depends on
+
+- [ez-popover](../../ez-popover)
+- [ez-button](../../ez-button)
+- [ez-multi-selection-list](../../ez-multi-selection-list)
+
+### Graph
+```mermaid
+graph TD;
+  filter-column --> ez-popover
+  filter-column --> ez-button
+  filter-column --> ez-multi-selection-list
+  ez-button --> ez-icon
+  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
+  ez-grid --> filter-column
+  style filter-column fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-guide-navigator/readme.md

@@ -0,0 +1,125 @@
+# ez-guide-navigator
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute     | Description                                                             | Type                                                            | Default     |
+| ----------------- | ------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------- | ----------- |
+| `items`           | --            | Lista de itens do menu de navegação.                                    | `IGuideItem[]`                                                  | `[]`        |
+| `open`            | `open`        | Define se o menu de navegação está aberto.                              | `boolean`                                                       | `true`      |
+| `selectedId`      | `selected-id` | Define o id do item selecionado.                                        | `string`                                                        | `undefined` |
+| `tooltipResolver` | --            | Define uma função que vai resolver o `tooltip` ou `title` daquele item. | `(item: IGuideItem, enabled: boolean, level: number) => string` | `undefined` |
+
+
+## Events
+
+| Event               | Description                                                       | Type                      |
+| ------------------- | ----------------------------------------------------------------- | ------------------------- |
+| `ezSelectionChange` | Evento emitido quando o item selecionado no navigator é alterado. | `CustomEvent<IGuideItem>` |
+
+
+## Methods
+
+### `disableItem(id: string | Array<string>) => Promise<void>`
+
+Desabilita um ou mais itens.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `enableItem(id: string | Array<string>) => Promise<void>`
+
+Habilita um ou mais itens.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `getCurrentPath() => Promise<Array<IGuideItem>>`
+
+Obtem um array do caminho de itens da seleção atual.
+
+#### Returns
+
+Type: `Promise<IGuideItem[]>`
+
+Retorna um array do caminho de itens da seleção atual.
+
+### `getItem(id: string) => Promise<IGuideItem>`
+
+Obtem um item pelo id
+
+#### Returns
+
+Type: `Promise<IGuideItem>`
+
+
+
+### `getParent(id: string) => Promise<IGuideItem>`
+
+Obtem o item pai a partir de um id
+
+#### Returns
+
+Type: `Promise<IGuideItem>`
+
+
+
+### `selectGuide(id: string) => Promise<void>`
+
+Seleciona o item desejado pelo ID.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `updateItem(item: IGuideItem | Array<IGuideItem>) => Promise<void>`
+
+Atualiza um ou mais items
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-sidebar-button](../ez-sidebar-button)
+- [ez-filter-input](../ez-filter-input)
+- [ez-button](../ez-button)
+- [ez-scroller](../ez-scroller)
+- [ez-tree](../ez-tree)
+
+### Graph
+```mermaid
+graph TD;
+  ez-guide-navigator --> ez-sidebar-button
+  ez-guide-navigator --> ez-filter-input
+  ez-guide-navigator --> ez-button
+  ez-guide-navigator --> ez-scroller
+  ez-guide-navigator --> ez-tree
+  ez-filter-input --> ez-text-input
+  ez-filter-input --> ez-icon
+  ez-button --> ez-icon
+  ez-tree --> ez-icon
+  style ez-guide-navigator fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-icon/readme.md

@@ -0,0 +1,66 @@
+# ez-icon
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property   | Attribute   | Description                                                                                                                                       | Type                                                       | Default     |
+| ---------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ----------- |
+| `href`     | `href`      | Define o endereço da imagem quando não contempladas na biblioteca de ícones.                                                                      | `string`                                                   | `undefined` |
+| `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` |
+| `size`     | `size`      | Define o tamanho do ícone.                                                                                                                        | `"large" \| "medium" \| "small" \| "x-large" \| "x-small"` | `"medium"`  |
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-actions-button](../ez-actions-button)
+ - [ez-alert](../ez-alert)
+ - [ez-badge](../ez-badge)
+ - [ez-breadcrumb](../ez-breadcrumb)
+ - [ez-button](../ez-button)
+ - [ez-chip](../ez-chip)
+ - [ez-collapsible-box](../ez-collapsible-box)
+ - [ez-combo-box](../ez-combo-box)
+ - [ez-dialog](../ez-dialog)
+ - [ez-dropdown](../ez-dropdown)
+ - [ez-file-item](../ez-file-item)
+ - [ez-filter-input](../ez-filter-input)
+ - [ez-grid](../ez-grid)
+ - [ez-modal-container](../ez-modal-container)
+ - [ez-multi-selection-list](../ez-multi-selection-list)
+ - [ez-tabselector](../ez-tabselector)
+ - [ez-time-input](../ez-time-input)
+ - [ez-tree](../ez-tree)
+
+### Graph
+```mermaid
+graph TD;
+  ez-actions-button --> ez-icon
+  ez-alert --> ez-icon
+  ez-badge --> ez-icon
+  ez-breadcrumb --> ez-icon
+  ez-button --> ez-icon
+  ez-chip --> ez-icon
+  ez-collapsible-box --> ez-icon
+  ez-combo-box --> ez-icon
+  ez-dialog --> ez-icon
+  ez-dropdown --> ez-icon
+  ez-file-item --> ez-icon
+  ez-filter-input --> ez-icon
+  ez-grid --> ez-icon
+  ez-modal-container --> ez-icon
+  ez-multi-selection-list --> ez-icon
+  ez-tabselector --> ez-icon
+  ez-time-input --> ez-icon
+  ez-tree --> ez-icon
+  style ez-icon fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-list/readme.md

@@ -0,0 +1,114 @@
+# ez-list
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property              | Attribute        | Description                                                                                                                                                   | Type                                                           | Default     |
+| --------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----------- |
+| `dataSource`          | --               | Define a lista inicial do componente.                                                                                                                         | `(ListItem \| ListGroup)[]`                                    | `[]`        |
+| `ezDraggable`         | `ez-draggable`   | Se true habilita `drag and drop` para os itens.                                                                                                               | `boolean`                                                      | `false`     |
+| `ezSelectable`        | `ez-selectable`  | Se true os itens serão selecionáveis.                                                                                                                         | `boolean`                                                      | `false`     |
+| `hoverFeedback`       | `hover-feedback` | Quando verdadeiro, ativa o feedback visual ao efetuar houver nos itens da lista.                                                                              | `boolean`                                                      | `false`     |
+| `itemLeftSlotBuilder` | --               | Função builder que possibilita gerar conteúdo dinâmico à esquerda do item da lista. * Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
+| `itemSlotBuilder`     | --               | Função builder que possibilita alterar como o item da lista vai ser apresentado. Observação: No react ele se transforma em VNode e não como HTMLElement.      | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
+| `listMode`            | `list-mode`      | Define o modo de apresentação da lista.                                                                                                                       | `"check" \| "regular"`                                         | `'regular'` |
+| `useGroups`           | `use-groups`     | Se true os grupos serão exibidos.                                                                                                                             | `boolean`                                                      | `false`     |
+
+
+## Events
+
+| Event           | Description                                                 | Type                                     |
+| --------------- | ----------------------------------------------------------- | ---------------------------------------- |
+| `ezChange`      | Emitido quando acontece a alteração de estado da lista.     | `CustomEvent<(ListItem \| ListGroup)[]>` |
+| `ezCheckChange` | Emitido quando acontece a alteração de um item do checkbox. | `CustomEvent<ListItem>`                  |
+| `ezSelectItem`  | Emitido sempre que um item da lista for selecionado.        | `CustomEvent<ListItem>`                  |
+
+
+## Methods
+
+### `clearHistory() => Promise<void>`
+
+Limpa o histórico da lista.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `getList() => Promise<Array<ListItem | ListGroup>>`
+
+Obtém a lista de items ou grupos.
+
+#### Returns
+
+Type: `Promise<(ListItem | ListGroup)[]>`
+
+
+
+### `getSelection() => Promise<ListItem>`
+
+Obtém o item selecionado.
+
+#### Returns
+
+Type: `Promise<ListItem>`
+
+
+
+### `removeSelection() => Promise<void>`
+
+Limpa a seleção atual
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `scrollToTop() => Promise<void>`
+
+Traz o conteúdo da lista para a área visível.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setSelection(selectedItem: ListItem, scrollToOption?: boolean) => Promise<void>`
+
+Aplica seleção nas linhas da lista.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-multi-selection-list](../ez-multi-selection-list)
+
+### Depends on
+
+- [ez-check](../ez-check)
+
+### Graph
+```mermaid
+graph TD;
+  ez-list --> ez-check
+  ez-multi-selection-list --> ez-list
+  style ez-list fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-loading-bar/readme.md

@@ -0,0 +1,33 @@
+# ez-loading-bar
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Methods
+
+### `hide() => Promise<void>`
+
+Oculta o ez-loading-bar.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `show() => Promise<void>`
+
+Exibe o ez-loading-bar.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+----------------------------------------------
+
+