@sankhyalabs/ezui-docs 0.0.0-bugfix-dev-KB-08202.0

package/components/ez-text-area/readme.md

@@ -0,0 +1,90 @@
+# ez-text-area
+
+
+
+<!-- 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`      |
+| `enableResize` | `enable-resize`  | Ativa a opção de fazer resize do input.                                           | `boolean`             | `false`     |
+| `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"` |
+| `rows`         | `rows`           | Define o número de linhas.                                                        | `number`              | `4`         |
+| `value`        | `value`          | Define o valor do campo.                                                          | `string`              | `undefined` |
+
+
+## Events
+
+| Event      | Description                                            | Type                  |
+| ---------- | ------------------------------------------------------ | --------------------- |
+| `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<string>` |
+
+
+## Methods
+
+### `appendTextToSelection(text: string) => Promise<void>`
+
+Adiciona o argumento text no value do text area, seguindo as regras:
+- Se o cursor do mouse está posicionado em algum local do texto, o argumento será adicionado nesse local.
+- Se existir uma seleção no texto, o trecho selecionado deve ser substituído pelo argumento.
+- Se não existir seleção nem posicionamento do cursor do mouse, o argumento será adicionado no final do texto.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `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)
+
+### Graph
+```mermaid
+graph TD;
+  ez-form-view --> ez-text-area
+  style ez-text-area fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-text-edit/readme.md

@@ -0,0 +1,60 @@
+# ez-text-edit
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property | Attribute | Description                 | Type      | Default     |
+| -------- | --------- | --------------------------- | --------- | ----------- |
+| `styled` | --        | Define atributos do estilo. | `IStyled` | `undefined` |
+| `value`  | `value`   | Define o valor do campo.    | `string`  | `undefined` |
+
+
+## Events
+
+| Event           | Description                    | Type               |
+| --------------- | ------------------------------ | ------------------ |
+| `cancelEdition` | Emitido ao cancelar uma edição | `CustomEvent<any>` |
+| `saveEdition`   | Emitido ao salvar uma edição   | `CustomEvent<any>` |
+
+
+## Methods
+
+### `applyFocusSelect() => Promise<void>`
+
+Aplica foco no campo.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-collapsible-box](../ez-collapsible-box)
+
+### Depends on
+
+- [ez-text-input](../ez-text-input)
+- [ez-button](../ez-button)
+
+### Graph
+```mermaid
+graph TD;
+  ez-text-edit --> ez-text-input
+  ez-text-edit --> ez-button
+  ez-button --> ez-icon
+  ez-collapsible-box --> ez-text-edit
+  style ez-text-edit fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

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

@@ -0,0 +1,92 @@
+# ez-text-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` |
+| `mask`         | `mask`           | Aplica uma máscara no conteúdo conforme o padrão estabelecido                     | `string`              | `undefined` |
+| `mode`         | `mode`           | Define o tamanho do campo.                                                        | `"regular" \| "slim"` | `"regular"` |
+| `noBorder`     | `no-border`      | Se true o campo não terá bordas.                                                  | `boolean`             | `false`     |
+| `restrict`     | `restrict`       | Restringe o que o usuário pode digitar.                                           | `string`              | `undefined` |
+| `value`        | `value`          | Define o valor do campo.                                                          | `string`              | `undefined` |
+
+
+## Events
+
+| Event      | Description                                            | Type                  |
+| ---------- | ------------------------------------------------------ | --------------------- |
+| `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<string>` |
+
+
+## Methods
+
+### `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-combo-box](../ez-combo-box)
+ - [ez-date-input](../ez-date-input)
+ - [ez-date-time-input](../ez-date-time-input)
+ - [ez-filter-input](../ez-filter-input)
+ - [ez-form-view](../ez-form-view)
+ - [ez-number-input](../ez-number-input)
+ - [ez-text-edit](../ez-text-edit)
+ - [ez-time-input](../ez-time-input)
+
+### Graph
+```mermaid
+graph TD;
+  ez-combo-box --> ez-text-input
+  ez-date-input --> ez-text-input
+  ez-date-time-input --> ez-text-input
+  ez-filter-input --> ez-text-input
+  ez-form-view --> ez-text-input
+  ez-number-input --> ez-text-input
+  ez-text-edit --> ez-text-input
+  ez-time-input --> ez-text-input
+  style ez-text-input fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

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

@@ -0,0 +1,85 @@
+# ez-time-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"` |
+| `showSeconds`  | `show-seconds`   | Se true considera segundos.                                                       | `boolean`             | `false`     |
+| `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
+
+### `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({ selectText }: 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)
+- [ez-icon](../ez-icon)
+
+### Graph
+```mermaid
+graph TD;
+  ez-time-input --> ez-text-input
+  ez-time-input --> ez-icon
+  ez-form-view --> ez-time-input
+  style ez-time-input fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-toast/readme.md

@@ -0,0 +1,33 @@
+# ez-toast
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property   | Attribute   | Description                                    | Type      | Default     |
+| ---------- | ----------- | ---------------------------------------------- | --------- | ----------- |
+| `canClose` | `can-close` | Se false, o usuário não consegue fechar.       | `boolean` | `true`      |
+| `fadeTime` | `fade-time` | Define o tempo de exibição em milissegundos.   | `number`  | `5000`      |
+| `message`  | `message`   | Mensagem a ser exibida no componente.          | `string`  | `undefined` |
+| `useIcon`  | `use-icon`  | Se true permite a utilização do slot de ícone. | `boolean` | `false`     |
+
+
+## Methods
+
+### `show(message: string, fadeTime: number, useIcon: boolean, canClose?: boolean) => Promise<void>`
+
+Exibe o ez-toast.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+----------------------------------------------
+
+

package/components/ez-tree/readme.md

@@ -0,0 +1,158 @@
+# ez-tree
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute     | Description                                                                                              | Type                                                            | Default               |
+| ----------------- | ------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | --------------------- |
+| `iconResolver`    | --            | Define uma função que vai resolver o ícone daquele item. Retorna o nome do ícone da lib de icones do DS. | `(item: ITreeItem, expanded: boolean, level: number) => string` | `defaultIconResolver` |
+| `items`           | --            | Define os itens apresentados na árvore.                                                                  | `ITreeItem[]`                                                   | `[]`                  |
+| `selectedId`      | `selected-id` | Forma alternativa para atribuir o item selecionado por seu ID.                                           | `string`                                                        | `undefined`           |
+| `tooltipResolver` | --            | Define uma função que vai resolver o `tooltip` ou `title` daquele item.                                  | `(item: ITreeItem, enabled: boolean, level: number) => string`  | `undefined`           |
+| `value`           | --            | Define o item selecionado na árvore.                                                                     | `ITreeItem`                                                     | `undefined`           |
+
+
+## Events
+
+| Event        | Description                                     | Type                     |
+| ------------ | ----------------------------------------------- | ------------------------ |
+| `ezChange`   | Emitido quando um item é selecionado na árvore. | `CustomEvent<ITreeItem>` |
+| `ezOpenItem` | Emitido quando um item é aberto na árvore.      | `CustomEvent<ITreeItem>` |
+
+
+## Methods
+
+### `addChild(item: ITreeItem, parentId?: string) => Promise<void>`
+
+Adiciona um ou mais itens. Opcionalmente pode-se determinar a qual
+item da árvore será anexado o item. Caso não informado parentId,
+adiciona no item selecionado.
+Observação para carga dinâmica (Lazyload): O parentId deve ser
+um item carregado atualmente na árvore.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `applyFilter(pattern: string) => Promise<void>`
+
+Efetua a seleção de um item.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `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<ITreeItem>>`
+
+Obtem um array do caminho de itens da seleção atual.
+
+#### Returns
+
+Type: `Promise<ITreeItem[]>`
+
+Retorna um array do caminho de itens da seleção atual.
+
+### `getItem(id: string) => Promise<ITreeItem>`
+
+Obtem um item pelo id
+
+#### Returns
+
+Type: `Promise<ITreeItem>`
+
+
+
+### `getParent(id: string) => Promise<ITreeItem>`
+
+Obtem o item pai a partir de um id
+
+#### Returns
+
+Type: `Promise<ITreeItem>`
+
+
+
+### `openItem(id: string) => Promise<void>`
+
+Realiza a abertura de um item, incluindo a hieraquia acima.
+Observação para carga dinâmica (Lazyload): O item solicitado já deve
+estar carregado na lista. Nos casos onde o item ainda não esteja 
+carregado o id pode ser uma string no formato "id1>>id2>>id3",
+tornando possível a carga a partir de um ponto já carregado.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `selectItem(id: string) => Promise<void>`
+
+Efetua a seleção de um item.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `updateItem(item: ITreeItem) => Promise<void>`
+
+Atualiza um item
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-guide-navigator](../ez-guide-navigator)
+
+### Depends on
+
+- [ez-icon](../ez-icon)
+
+### Graph
+```mermaid
+graph TD;
+  ez-tree --> ez-icon
+  ez-guide-navigator --> ez-tree
+  style ez-tree fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/ez-upload/readme.md

@@ -0,0 +1,80 @@
+# ez-upload
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property         | Attribute         | Description                                                                 | Type       | Default     |
+| ---------------- | ----------------- | --------------------------------------------------------------------------- | ---------- | ----------- |
+| `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` |
+| `maxFileSize`    | `max-file-size`   | Define o tamanho máximo (em bytes) de cada arquivo que pode ser transferido | `number`   | `undefined` |
+| `maxFiles`       | `max-files`       | Define um limite para a quantidade de arquivos                              | `number`   | `undefined` |
+| `requestHeaders` | `request-headers` | Headers para a requisição Http                                              | `any`      | `undefined` |
+| `subtitle`       | `subtitle`        | Define o subtítulo utilizado no campo de upload                             | `string`   | `undefined` |
+| `urlDelete`      | `url-delete`      | Define a URL de deleção                                                     | `string`   | `undefined` |
+| `urlUpload`      | `url-upload`      | Define a URL de upload                                                      | `string`   | `undefined` |
+| `value`          | --                | Define o valor do campo.                                                    | `EzFile[]` | `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<EzFile[]>`      |
+| `ezStartChange`         | Emitido ao iniciar a alteração (remover ou adicionar um arquivo).                              | `CustomEvent<WaitingChange>` |
+
+
+## Methods
+
+### `addFiles(files: Array<File>) => Promise<void>`
+
+Adiciona arquivos.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `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)
+
+### Graph
+```mermaid
+graph TD;
+  ez-form-view --> ez-upload
+  style ez-upload fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

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

@@ -0,0 +1,33 @@
+# ez-view-stack
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Methods
+
+### `getSelectedIndex() => Promise<number>`
+
+Obtem o índice selecionado.
+
+#### Returns
+
+Type: `Promise<number>`
+
+
+
+### `show(index: number) => Promise<void>`
+
+Exibe a visão de acordo com o índice.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+----------------------------------------------
+
+

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@sankhyalabs/ezui-docs",
+  "version": "0.0.0-bugfix-dev-KB-08202.0",
+  "description": "Documentação da biblioteca de componentes Sankhya.",
+  "main": "",
+  "files": [
+    "/**/*.md"
+  ],
+  "scripts": {},
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {}
+}