@sankhyalabs/ezui-docs 2.0.0

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

@@ -0,0 +1,84 @@
+# ez-time-input
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property       | Attribute       | Description                                                           | Type      | Default     |
+| -------------- | --------------- | --------------------------------------------------------------------- | --------- | ----------- |
+| `enabled`      | `enabled`       | Deixa o campo disponível ou não para digitação.                       | `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`  | Define se o componente irá ou não considerar os segundos.             | `boolean` | `false`     |
+| `value`        | `value`         | Valor que será transmitido para o back-end.                           | `number`  | `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 quando o estado do componente é alterado (onEzChange).                                                       | `CustomEvent<number>`        |
+| `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 input
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setFocus() => Promise<void>`
+
+Faz o foco no componente de input
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-form](../ez-form)
+
+### 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 --> 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` | Controla o uso do icone de fechar o toast.                   | `boolean` | `true`      |
+| `fadeTime` | `fade-time` | Controla o tempo de exibição do componente em milissegundos. | `number`  | `5000`      |
+| `message`  | `message`   | Mensagem exibida no componente.                              | `string`  | `undefined` |
+| `useIcon`  | `use-icon`  | Adiciona ícone de check no componente.                       | `boolean` | `false`     |
+
+
+## Methods
+
+### `show(message: string, fadeTime: number, useIcon: boolean, canClose?: boolean) => Promise<unknown>`
+
+Exibe o componente na tela.
+
+#### Returns
+
+Type: `Promise<unknown>`
+
+
+
+
+----------------------------------------------
+
+

package/components/ez-upload/readme.md

@@ -0,0 +1,79 @@
+# ez-upload
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property         | Attribute         | Description                                                                 | Type       | Default     |
+| ---------------- | ----------------- | --------------------------------------------------------------------------- | ---------- | ----------- |
+| `enabled`        | `enabled`         | Deixa o campo disponível ou não para digitação.                             | `boolean`  | `true`      |
+| `label`          | `label`           | 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` |
+| `urlDelete`      | `url-delete`      | Define a URL de deleção                                                     | `string`   | `undefined` |
+| `urlUpload`      | `url-upload`      | Define a URL de upload                                                      | `string`   | `undefined` |
+| `value`          | --                | Lista de arquivos que será trafegada entre cliente e servidor               | `EzFile[]` | `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 emitido ao finalizar o upload de um arquivo (onEzChange).                                                              | `CustomEvent<EzFile[]>`      |
+| `ezStartChange`         | Evento emitido ao iniciar a alteração (remover ou adicionar um arquivo).                                                      | `CustomEvent<WaitingChange>` |
+
+
+## Methods
+
+### `addFiles(files: Array<File>) => Promise<void>`
+
+Método responsável por adicionar um ou mais arquivos ao componente.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setBlur() => Promise<void>`
+
+Remove o foco no componente de upload
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setFocus() => Promise<void>`
+
+Realiza o foco no componente de upload
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [ez-form](../ez-form)
+
+### Graph
+```mermaid
+graph TD;
+  ez-form --> 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>`
+
+Retorna o index que está atualmente ativo e sendo exibido.
+
+#### Returns
+
+Type: `Promise<number>`
+
+
+
+### `show(index: number) => Promise<void>`
+
+Exibe a aba desejada de acordo com o index passado na tela fazendo com a ativa atual seja removida ou oculta dependendo da hidePolicy.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+----------------------------------------------
+
+

package/package.json

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