@sankhyalabs/ezui-docs 2.0.0

package/components/ez-date-time-input/readme.md

@@ -0,0 +1,84 @@
+# ez-date-time-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"` |
+| `showSeconds`  | `show-seconds`  | Exibe ou não os segundos no input                                    | `boolean` | `false`     |
+| `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 datetime
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setFocus() => Promise<void>`
+
+Realiza o foco no componente de datetime
+
+#### 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-time-input --> ez-text-input
+  ez-date-time-input --> ez-calendar
+  ez-form --> ez-date-time-input
+  style ez-date-time-input fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-dialog/readme.md

@@ -0,0 +1,69 @@
+# ez-dialog
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property               | Attribute                | Description                                                      | Type                                                                                 | Default     |
+| ---------------------- | ------------------------ | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ----------- |
+| `confirm`              | `confirm`                | Define se o componente será utilizado no modo de confirmação.    | `boolean`                                                                            | `false`     |
+| `dialogType`           | `dialog-type`            | Define se o componente terá o visual padrão, de erro ou de aviso | `DialogType.CRITICAL \| DialogType.DEFAULT \| DialogType.SUCCESS \| DialogType.WARN` | `undefined` |
+| `ezTitle`              | `ez-title`               | Define o título do componente.                                   | `string`                                                                             | `undefined` |
+| `message`              | `message`                | Menssagem exibida dentro do Dialog                               | `string`                                                                             | `undefined` |
+| `opened`               | `opened`                 | Controla a exibição do componente                                | `boolean`                                                                            | `false`     |
+| `personalizedIconPath` | `personalized-icon-path` | Define o ícone a ser exibido ao lado do título do componente     | `string`                                                                             | `undefined` |
+
+
+## Events
+
+| Event      | Description                                                       | Type                   |
+| ---------- | ----------------------------------------------------------------- | ---------------------- |
+| `ezAccept` | Evento disparado ao clicar no botão de aceitação.                 | `CustomEvent<boolean>` |
+| `ezCancel` | Evento disparado ao clicar tanto no botão de negação quanto no X. | `CustomEvent<boolean>` |
+
+
+## Methods
+
+### `handleButtonClick(selectedOption: boolean) => Promise<void>`
+
+Lida com o clique nos botões de dentro do componente.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `show(title: string, message: string, dialogType: DialogType, confirm: boolean, icon: string, labelCancel: string, labelConfirm: string, btnConfirmDanger: boolean) => Promise<boolean>`
+
+Faz com que o componente seja exibido.
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-icon](../ez-icon)
+- [ez-button](../ez-button)
+
+### Graph
+```mermaid
+graph TD;
+  ez-dialog --> ez-icon
+  ez-dialog --> ez-button
+  ez-button --> ez-icon
+  style ez-dialog fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

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

@@ -0,0 +1,78 @@
+# ez-filter-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` |
+| `loading`      | `loading`       | Deixa o componente em modo "carregando".                                                                                           | `boolean` | `undefined` |
+| `mode`         | `mode`          | Define o modo do tamanho do campo; opções: slim e regular.                                                                         | `string`  | `"regular"` |
+| `restrict`     | `restrict`      | Restringe o que o usuário pode digitar. Cada caractere digitado será testado e deve estar contido nessa string ou será descartado. | `string`  | `undefined` |
+| `value`        | `value`         | O valor informado pelo usuário                                                                                                     | `string`  | `undefined` |
+
+
+## Events
+
+| Event      | Description                                                             | Type                  |
+| ---------- | ----------------------------------------------------------------------- | --------------------- |
+| `ezChange` | Evento disparado quando o estado do componente é alterado (onEzChange). | `CustomEvent<string>` |
+
+
+## Methods
+
+### `isInvalid() => Promise<boolean>`
+
+Retorna informando se o campo está inválido (true | false)
+
+#### Returns
+
+Type: `Promise<boolean>`
+
+
+
+### `setBlur() => Promise<void>`
+
+Remove o foco no componente de input
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setFocus() => Promise<void>`
+
+Realiza o foco no componente de input
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-text-input](../ez-text-input)
+- [ez-icon](../ez-icon)
+
+### Graph
+```mermaid
+graph TD;
+  ez-filter-input --> ez-text-input
+  ez-filter-input --> ez-icon
+  style ez-filter-input fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-form/readme.md

@@ -0,0 +1,110 @@
+# ez-form
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property           | Attribute | Description                                                                | Type               | Default     |
+| ------------------ | --------- | -------------------------------------------------------------------------- | ------------------ | ----------- |
+| `config`           | --        | Configuração dos campos.                                                   | `IFormConfig`      | `undefined` |
+| `dataUnit`         | --        | Repositório de dados, controla a manipulação dos dados                     | `DataUnit`         | `undefined` |
+| `recordsValidator` | --        | Validador responsável por checar a integridade das informações do registro | `IRecordValidator` | `undefined` |
+
+
+## Events
+
+| Event     | Description                                                  | Type                |
+| --------- | ------------------------------------------------------------ | ------------------- |
+| `ezReady` | Evento disparado quando o formulário está disponível na DOM. | `CustomEvent<void>` |
+
+
+## Methods
+
+### `cancel() => Promise<void>`
+
+
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `submit() => Promise<void>`
+
+
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `validate() => Promise<void>`
+
+
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-tabselector](../ez-tabselector)
+- [ez-collapsible-box](../ez-collapsible-box)
+- [ez-text-area](../ez-text-area)
+- [ez-text-input](../ez-text-input)
+- [ez-check](../ez-check)
+- [ez-combo-box](../ez-combo-box)
+- [ez-search](../ez-search)
+- [ez-upload](../ez-upload)
+- [ez-date-input](../ez-date-input)
+- [ez-time-input](../ez-time-input)
+- [ez-date-time-input](../ez-date-time-input)
+- [ez-number-input](../ez-number-input)
+
+### Graph
+```mermaid
+graph TD;
+  ez-form --> ez-tabselector
+  ez-form --> ez-collapsible-box
+  ez-form --> ez-text-area
+  ez-form --> ez-text-input
+  ez-form --> ez-check
+  ez-form --> ez-combo-box
+  ez-form --> ez-search
+  ez-form --> ez-upload
+  ez-form --> ez-date-input
+  ez-form --> ez-time-input
+  ez-form --> ez-date-time-input
+  ez-form --> ez-number-input
+  ez-tabselector --> ez-icon
+  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-search --> ez-combo-box
+  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
+  style ez-form fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-grid/readme.md

@@ -0,0 +1,129 @@
+# ez-grid
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property            | Attribute            | Description                                                                                                                                        | Type              | Default     |
+| ------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ----------- |
+| `config`            | --                   | Configuração de exibição da grade.                                                                                                                 | `IGridConfig`     | `undefined` |
+| `dataUnit`          | --                   | Repositório de dados, controla a manipulação dos dados.                                                                                            | `DataUnit`        | `undefined` |
+| `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas                                                                                                                | `boolean`         | `undefined` |
+| `serverUrl`         | `server-url`         | Endereço do servidor. Se informado, o próprio datagrid controlará a obtenção dos dados, anulando a necessidade de acionar o método "setData(data)" | `string`          | `undefined` |
+| `statusResolver`    | --                   | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }                                           | `IStatusResolver` | `undefined` |
+
+
+## Events
+
+| Event                 | Description                                                                      | Type                                 |
+| --------------------- | -------------------------------------------------------------------------------- | ------------------------------------ |
+| `configChange`        | Evento disparado ao realizar alguma modificação na configuração da grid.         | `CustomEvent<IGridConfig>`           |
+| `ezColumnStateChange` | Evento disparado ao mudar o estado das colunas do grid. Ordenação, largura, etc. | `CustomEvent<EzGridColumStateEvent>` |
+| `ezDoubleClick`       | Evento disparado com o duplo clique de uma linha                                 | `CustomEvent<any>`                   |
+| `ezSelectionChange`   | Evento disparado ao selecionar linhas da grade.                                  | `CustomEvent<any[]>`                 |
+
+
+## Methods
+
+### `addColumnMenuItem(label: string, name: string, action: Function) => Promise<any>`
+
+Adiciona item de menu nas colunas.
+
+#### Returns
+
+Type: `Promise<any>`
+
+
+
+### `getColumns() => Promise<Array<EzGridColumn>>`
+
+Método retornar o estado atual das colunas do grid.
+
+#### Returns
+
+Type: `Promise<EzGridColumn[]>`
+
+
+
+### `getColumnsState() => Promise<Array<EzGridColumn>>`
+
+Método retornar o estado atual das colunas do grid.
+
+#### Returns
+
+Type: `Promise<EzGridColumn[]>`
+
+
+
+### `getSelection() => Promise<Array<any>>`
+
+Retorna as linhas selecionadas na grade.
+
+#### Returns
+
+Type: `Promise<any[]>`
+
+
+
+### `quickFilter(term: string) => Promise<any>`
+
+Método para fazer um filtro rápido na grid.
+
+#### Returns
+
+Type: `Promise<any>`
+
+
+
+### `setColumnsDef(cols: Array<EzGridColumn>) => Promise<any>`
+
+Método responsável por receber a definição das colunas
+
+#### Returns
+
+Type: `Promise<any>`
+
+
+
+### `setColumnsState(state: Array<EzGridColumnConfig>) => Promise<any>`
+
+Método responsável por aplicar estado pré-existente nas colunas do grid.
+
+#### Returns
+
+Type: `Promise<any>`
+
+
+
+### `setData(data: Array<any>) => Promise<any>`
+
+Método de carga dos registros. Os objetos deste array devem conter atributos
+para as colunas desejadas.
+
+#### Returns
+
+Type: `Promise<any>`
+
+
+
+
+## Dependencies
+
+### Depends on
+
+- [ez-button](../ez-button)
+
+### Graph
+```mermaid
+graph TD;
+  ez-grid --> ez-button
+  ez-button --> ez-icon
+  style ez-grid fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-icon/readme.md

@@ -0,0 +1,50 @@
+# ez-icon
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property   | Attribute   | Description                                                                                                                                | Type     | Default     |
+| ---------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ----------- |
+| `href`     | `href`      | Path da imagem                                                                                                                             | `string` | `undefined` |
+| `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` |
+| `size`     | `size`      | Tamanho do ícone                                                                                                                           | `string` | `'medium'`  |
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-actions-button](../ez-actions-button)
+ - [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-filter-input](../ez-filter-input)
+ - [ez-modal-container](../ez-modal-container)
+ - [ez-tabselector](../ez-tabselector)
+ - [ez-time-input](../ez-time-input)
+
+### Graph
+```mermaid
+graph TD;
+  ez-actions-button --> 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-filter-input --> ez-icon
+  ez-modal-container --> ez-icon
+  ez-tabselector --> ez-icon
+  ez-time-input --> ez-icon
+  style ez-icon fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-list/readme.md

@@ -0,0 +1,81 @@
+# ez-list
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute       | Description                                                                                                                      | Type                                      | Default     |
+| ----------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | ----------- |
+| `dataSource`      | --              | Define a lista inicial do componente.                                                                                            | `any[]`                                   | `[]`        |
+| `ezDraggable`     | `ez-draggable`  | Define se o componente terá o comportamento de arrasto de linhas.                                                                | `boolean`                                 | `false`     |
+| `ezSelectable`    | `ez-selectable` | Define se os items da lista serão selecionáveis.                                                                                 | `boolean`                                 | `false`     |
+| `itemSlotBuilder` | --              | Define se é possível selecionar mais de um registro.  /** Função responsável por renderizar um conteúdo dentro do item da lista. | `(item: any, group?: any) => HTMLElement` | `undefined` |
+| `useGroups`       | `use-groups`    | Define se o componente renderizará os itens separados em grupos..                                                                | `boolean`                                 | `false`     |
+
+
+## Events
+
+| Event      | Description                                                  | Type                                     |
+| ---------- | ------------------------------------------------------------ | ---------------------------------------- |
+| `ezChange` | Evento disparado ao modificar ordenação nas linhas da grade. | `CustomEvent<ListGroup[] \| ListItem[]>` |
+
+
+## Methods
+
+### `clearHistory() => Promise<void>`
+
+Responsável por limpar a lista de histórico do componente.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `getList() => Promise<ListItem[] | ListGroup[]>`
+
+Retorna   a lista de items conforme o modo de uso.
+
+#### Returns
+
+Type: `Promise<ListItem[] | ListGroup[]>`
+
+
+
+### `getSelection() => Promise<any>`
+
+Retorna   o item selecionado.
+
+#### Returns
+
+Type: `Promise<any>`
+
+
+
+### `scrollToTop() => Promise<void>`
+
+Responsável por dar um scroll top no componente da lista.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setSelection(selectedItem: ListItem, scrollToOption?: boolean) => Promise<void>`
+
+Recebe   como argumento um ListItem {label: string} e um booleano que define se o componente deve fazer scroll para exibir o item específico (opcional).
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+----------------------------------------------
+
+

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

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

package/components/ez-modal/readme.md

@@ -0,0 +1,29 @@
+# ez-modal
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property            | Attribute             | Description                                                                                      | Type      | Default     |
+| ------------------- | --------------------- | ------------------------------------------------------------------------------------------------ | --------- | ----------- |
+| `align`             | `align`               | Define o alinhamento do modal. Seus valores podem ser "right" ou "left"                          | `string`  | `undefined` |
+| `closeEsc`          | `close-esc`           | Define se o 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`     |
+| `modalSize`         | `modal-size`          | Define o tamanho do modal. Devem ser utilizados os tamanhos definidos de colunas como "col-sd-3" | `string`  | `undefined` |
+| `opened`            | `opened`              | Controle de exibição do Modal                                                                    | `boolean` | `true`      |
+
+
+## Events
+
+| Event          | Description                                                    | Type                   |
+| -------------- | -------------------------------------------------------------- | ---------------------- |
+| `ezCloseModal` | Um evento disparado quando o modal é fechado (onEzCloseModal). | `CustomEvent<boolean>` |
+| `ezOpenModal`  | Um evento disparado quando o modal é aberto (onEzOpenModal).   | `CustomEvent<any>`     |
+
+
+----------------------------------------------
+
+