@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-KB-5516.0

package/components/snk-simple-crud/readme.md

@@ -0,0 +1,104 @@
+# snk-simple-crud
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property            | Attribute            | Description                                                                                                         | Type                                                    | Default                   |
+| ------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------- |
+| `dataState`         | --                   |                                                                                                                     | `DataState`                                             | `undefined`               |
+| `dataUnit`          | --                   |                                                                                                                     | `DataUnit`                                              | `undefined`               |
+| `formConfig`        | --                   |                                                                                                                     | `IFormConfig`                                           | `undefined`               |
+| `gridConfig`        | --                   |                                                                                                                     | `IGridConfig`                                           | `undefined`               |
+| `messagesBuilder`   | --                   | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.                              | `SnkMessageBuilder`                                     | `undefined`               |
+| `mode`              | `mode`               |                                                                                                                     | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
+| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade.                                                     | `boolean`                                               | `undefined`               |
+| `taskbarManager`    | --                   | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager`                                        | `undefined`               |
+| `useCancelConfirm`  | `use-cancel-confirm` |                                                                                                                     | `boolean`                                               | `true`                    |
+
+
+## Events
+
+| Event             | Description                                               | Type                     |
+| ----------------- | --------------------------------------------------------- | ------------------------ |
+| `actionClick`     | Emitido sempre que houver click de botão ou ação.         | `CustomEvent<string>`    |
+| `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
+| `dataUnitReady`   | Emitido quando o DataUnit está pronto.                    | `CustomEvent<DataUnit>`  |
+
+
+## Methods
+
+### `getRecords() => Promise<Array<Record>>`
+
+
+
+#### Returns
+
+Type: `Promise<Record[]>`
+
+
+
+### `goToView(view: VIEW_MODE) => Promise<void>`
+
+Usado para alternar a visão entre GRID e FORM externamente.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setMetadata(metadata: UnitMetadata) => Promise<void>`
+
+
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setRecords(records: Array<Record>) => Promise<void>`
+
+
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-attach](../snk-attach)
+
+### Depends on
+
+- [snk-data-unit](../snk-data-unit)
+- [snk-taskbar](../snk-taskbar)
+- [snk-data-exporter](../snk-data-exporter)
+- [snk-actions-button](../snk-actions-button)
+
+### Graph
+```mermaid
+graph TD;
+  snk-simple-crud --> snk-data-unit
+  snk-simple-crud --> snk-taskbar
+  snk-simple-crud --> snk-data-exporter
+  snk-simple-crud --> snk-actions-button
+  snk-taskbar --> snk-data-exporter
+  snk-taskbar --> snk-actions-button
+  snk-data-exporter --> snk-exporter-email-sender
+  snk-attach --> snk-simple-crud
+  style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-taskbar/readme.md

@@ -0,0 +1,59 @@
+# snk-taskbar
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property           | Attribute           | Description                                                                                                                          | Type                                                     | Default                    |
+| ------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------- | -------------------------- |
+| `actionsList`      | --                  | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.                                                | `Action[]`                                               | `undefined`                |
+| `buttons`          | `buttons`           | Lista separada por virgula, contendo todos os elementos a serem criados.                                                             | `string`                                                 | `undefined`                |
+| `configName`       | `config-name`       | Usado para guardar ou recuperar as configurações do formulário.                                                                      | `string`                                                 | `undefined`                |
+| `customButtons`    | --                  | Mapa com definição de botões personalizados. A chave do mapa deve ser passada na lista "buttons" no lugar onde o botão irá aparecer. | `Map<string, CustomButton>`                              | `undefined`                |
+| `dataUnit`         | --                  | Instância do DataUnit.                                                                                                               | `DataUnit`                                               | `undefined`                |
+| `disabledButtons`  | --                  | Array contendo todos os botões a serem desabilitados.                                                                                | `string[]`                                               | `undefined`                |
+| `messagesBuilder`  | --                  | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.                                               | `SnkMessageBuilder`                                      | `undefined`                |
+| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar.                                                                             | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
+| `primaryButton`    | `primary-button`    | Determina qual botão deve ter aparência primária.                                                                                    | `string`                                                 | `undefined`                |
+
+
+## Events
+
+| Event         | Description                                       | Type                  |
+| ------------- | ------------------------------------------------- | --------------------- |
+| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
+ - [snk-grid](../snk-grid)
+ - [snk-guides-viewer](../snk-crud/subcomponents)
+ - [snk-simple-crud](../snk-simple-crud)
+
+### Depends on
+
+- [snk-data-exporter](../snk-data-exporter)
+- [snk-actions-button](../snk-actions-button)
+
+### Graph
+```mermaid
+graph TD;
+  snk-taskbar --> snk-data-exporter
+  snk-taskbar --> snk-actions-button
+  snk-data-exporter --> snk-exporter-email-sender
+  snk-detail-view --> snk-taskbar
+  snk-grid --> snk-taskbar
+  snk-guides-viewer --> snk-taskbar
+  snk-simple-crud --> snk-taskbar
+  style snk-taskbar fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/teste-pesquisa/readme.md

@@ -0,0 +1,24 @@
+# teste-pesquisa
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Dependencies
+
+### Depends on
+
+- [snk-application](../snk-application)
+
+### Graph
+```mermaid
+graph TD;
+  teste-pesquisa --> snk-application
+  snk-application --> snk-pesquisa
+  style teste-pesquisa fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/package.json

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