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

package/components/snk-grid/readme.md

@@ -0,0 +1,120 @@
+# snk-grid
+
+
+
+<!-- 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`                |
+| `configName`           | `config-name`        | Nome usado para salvar/recuperar a configuração.                                                                    | `string`                                                 | `undefined`                |
+| `isDetail`             | `is-detail`          | Determina se a grade está vinculada a um detalhe.                                                                   | `boolean`                                                | `undefined`                |
+| `messagesBuilder`      | --                   | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.                              | `SnkMessageBuilder`                                      | `undefined`                |
+| `multipleSelection`    | `multiple-selection` | Determina se pode haver mais de uma linha selecionada.                                                              | `boolean`                                                | `undefined`                |
+| `presentationMode`     | `presentation-mode`  | Altera o modo de apresentação dos botões do snk-taskbar.                                                            | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
+| `selectionToastConfig` | --                   | Configuração da seleção de grade no toast.                                                                          | `ISelectionToastConfig`                                  | `undefined`                |
+| `statusResolver`       | --                   | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'          | `((data: object) => string) \| IStatusResolver`          | `undefined`                |
+| `taskbarManager`       | --                   | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager`                                         | `undefined`                |
+
+
+## Events
+
+| Event             | Description                                       | Type                  |
+| ----------------- | ------------------------------------------------- | --------------------- |
+| `actionClick`     | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
+| `gridDoubleClick` | Emitido sempre que houver duplo click na grade.   | `CustomEvent<void>`   |
+
+
+## Methods
+
+### `hideConfig() => Promise<void>`
+
+Fecha a janela de configurações da grade.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `reloadFilterBar() => Promise<void>`
+
+Faz o recarregamento da filter-bar da grade buscando o state no servidor.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `setConfig(config: IGridConfig) => Promise<void>`
+
+Atribui o valor da configuração da grade.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+### `showConfig() => Promise<void>`
+
+Exibe a janela de configurações da grade.
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-crud](../snk-crud)
+ - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
+
+### Depends on
+
+- [snk-filter-bar](../snk-filter-bar)
+- [snk-taskbar](../snk-taskbar)
+- [snk-grid-config](./subcomponents/snk-grid-config)
+- [snk-data-exporter](../snk-data-exporter)
+- [snk-actions-button](../snk-actions-button)
+
+### Graph
+```mermaid
+graph TD;
+  snk-grid --> snk-filter-bar
+  snk-grid --> snk-taskbar
+  snk-grid --> snk-grid-config
+  snk-grid --> snk-data-exporter
+  snk-grid --> snk-actions-button
+  snk-filter-bar --> snk-filter-item
+  snk-filter-bar --> snk-personalized-filter
+  snk-filter-item --> snk-filter-detail
+  snk-personalized-filter --> snk-filter-field-search
+  snk-personalized-filter --> snk-filter-assistent-mode
+  snk-personalized-filter --> snk-filter-advanced-mode
+  snk-personalized-filter --> snk-simple-bar
+  snk-filter-assistent-mode --> snk-expression-group
+  snk-expression-group --> snk-expression-item
+  snk-expression-group --> snk-expression-group
+  snk-expression-item --> snk-filter-field-search
+  snk-expression-item --> snk-filter-param-config
+  snk-taskbar --> snk-data-exporter
+  snk-taskbar --> snk-actions-button
+  snk-data-exporter --> snk-exporter-email-sender
+  snk-grid-config --> snk-select-box
+  snk-crud --> snk-grid
+  snk-detail-view --> snk-grid
+  style snk-grid fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-grid/subcomponents/snk-grid-config/readme.md

@@ -0,0 +1,47 @@
+# ez-grid-config
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property        | Attribute        | Description                                      | Type             | Default     |
+| --------------- | ---------------- | ------------------------------------------------ | ---------------- | ----------- |
+| `application`   | --               | Referência para o SnkApplication                 | `SnkApplication` | `undefined` |
+| `columns`       | --               | Colunas da grade.                                | `EzGridColumn[]` | `undefined` |
+| `config`        | --               | Configurações da grade.                          | `IGridConfig`    | `undefined` |
+| `configName`    | `config-name`    | Nome usado para salvar/recuperar a configuração. | `string`         | `undefined` |
+| `selectedIndex` | `selected-index` | Aba selecionada das configurações da grade.      | `number`         | `0`         |
+
+
+## Events
+
+| Event          | Description                                        | Type                       |
+| -------------- | -------------------------------------------------- | -------------------------- |
+| `configCancel` | Emitido ao cancelar a alteração das configurações. | `CustomEvent<void>`        |
+| `configChange` | Emitido ao salvar a alteração das configurações.   | `CustomEvent<IGridConfig>` |
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-grid](../..)
+
+### Depends on
+
+- [snk-select-box](../snk-select-box)
+
+### Graph
+```mermaid
+graph TD;
+  snk-grid-config --> snk-select-box
+  snk-grid --> snk-grid-config
+  style snk-grid-config fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-grid/subcomponents/snk-select-box/readme.md

@@ -0,0 +1,37 @@
+# snk-select-box
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property         | Attribute         | Description                    | Type                | Default             |
+| ---------------- | ----------------- | ------------------------------ | ------------------- | ------------------- |
+| `selectedOption` | `selected-option` | Determina a opção selecionada. | `IOption \| string` | `ORDER_VALUES.none` |
+
+
+## Events
+
+| Event      | Description                                                | Type                  |
+| ---------- | ---------------------------------------------------------- | --------------------- |
+| `ezChange` | Emitido ao alterar a seleção do componente snk-select-box. | `CustomEvent<string>` |
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-grid-config](../snk-grid-config)
+
+### Graph
+```mermaid
+graph TD;
+  snk-grid-config --> snk-select-box
+  style snk-select-box fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-personalized-filter/readme.md

@@ -0,0 +1,70 @@
+# snk-personalized-filter
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute     | Description                                                                            | Type                | Default     |
+| ----------------- | ------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
+| `configName`      | `config-name` | Nome da config para buscar no resourceId                                               | `string`            | `undefined` |
+| `entityUri`       | `entity-uri`  | Responsável por receber a URI da entidade.                                             | `string`            | `undefined` |
+| `filterId`        | `filter-id`   | Id do filtro que será carregado.                                                       | `string`            | `undefined` |
+| `messagesBuilder` | --            | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
+
+
+## Events
+
+| Event      | Description | Type                  |
+| ---------- | ----------- | --------------------- |
+| `ezCancel` |             | `CustomEvent<void>`   |
+| `ezSave`   |             | `CustomEvent<string>` |
+
+
+## Methods
+
+### `createPersonalizedFilter() => Promise<void>`
+
+
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-filter-bar](../snk-filter-bar)
+
+### Depends on
+
+- [snk-filter-field-search](../snk-filter-field-search)
+- [snk-filter-assistent-mode](./subcomponents/snk-filter-assistent-mode)
+- [snk-filter-advanced-mode](./subcomponents/snk-filter-advanced-mode)
+- [snk-simple-bar](../snk-simple-bar)
+
+### Graph
+```mermaid
+graph TD;
+  snk-personalized-filter --> snk-filter-field-search
+  snk-personalized-filter --> snk-filter-assistent-mode
+  snk-personalized-filter --> snk-filter-advanced-mode
+  snk-personalized-filter --> snk-simple-bar
+  snk-filter-assistent-mode --> snk-expression-group
+  snk-expression-group --> snk-expression-item
+  snk-expression-group --> snk-expression-group
+  snk-expression-item --> snk-filter-field-search
+  snk-expression-item --> snk-filter-param-config
+  snk-filter-bar --> snk-personalized-filter
+  style snk-personalized-filter fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-personalized-filter/subcomponents/snk-expression-group/readme.md

@@ -0,0 +1,65 @@
+# snk-expression-group
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute      | Description                                                                            | Type                | Default     |
+| ----------------- | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
+| `entityURI`       | `entity-u-r-i` | Identificador da unidade de dados.                                                     | `string`            | `undefined` |
+| `filterId`        | `filter-id`    | Id do filtro que será carregado.                                                       | `string`            | `undefined` |
+| `group`           | --             | Grupo que será representado visualmente pelo componente.                               | `IExpressionGroup`  | `undefined` |
+| `messagesBuilder` | --             | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
+| `parentTop`       | `parent-top`   | Tamanho do elemento pai do grupo                                                       | `number`            | `0`         |
+
+
+## Events
+
+| Event                       | Description                                           | Type                            |
+| --------------------------- | ----------------------------------------------------- | ------------------------------- |
+| `ezExpressionLayoutChanged` | Emitido ao alterar quantidade de grupos ou expressões | `CustomEvent<null>`             |
+| `ezFilterGroupChange`       | Emitido quando ocorrer alterações no grupo.           | `CustomEvent<IExpressionGroup>` |
+| `ezFilterGroupRemove`       | Emitido ao pressionar o botão de remover grupo.       | `CustomEvent<IExpressionGroup>` |
+
+
+## Methods
+
+### `getExpressionGroup() => Promise<IExpressionGroup>`
+
+
+
+#### Returns
+
+Type: `Promise<IExpressionGroup>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-expression-group](.)
+ - [snk-filter-assistent-mode](../snk-filter-assistent-mode)
+
+### Depends on
+
+- [snk-expression-item](../snk-expression-item)
+- [snk-expression-group](.)
+
+### Graph
+```mermaid
+graph TD;
+  snk-expression-group --> snk-expression-group
+  snk-expression-item --> snk-filter-field-search
+  snk-expression-item --> snk-filter-param-config
+  snk-filter-assistent-mode --> snk-expression-group
+  style snk-expression-group fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md

@@ -0,0 +1,48 @@
+# snk-expression-item
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute      | Description                                                                            | Type                | Default     |
+| ----------------- | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
+| `canRemove`       | `can-remove`   | Controla a exibição do botão Remover.                                                  | `boolean`           | `true`      |
+| `entityURI`       | `entity-u-r-i` | Identificador da unidade de dados.                                                     | `string`            | `undefined` |
+| `expression`      | --             | Expressão que será representada visualmente.                                           | `IExpressionItem`   | `undefined` |
+| `messagesBuilder` | --             | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
+
+
+## Events
+
+| Event                | Description                                      | Type                           |
+| -------------------- | ------------------------------------------------ | ------------------------------ |
+| `ezFilterItemChange` | Emitido quando acontece alterações na expressão. | `CustomEvent<IExpressionItem>` |
+| `ezFilterItemRemove` | Emitido ao confirmar uma remoção.                | `CustomEvent<IExpressionItem>` |
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-expression-group](../snk-expression-group)
+
+### Depends on
+
+- [snk-filter-field-search](../../../snk-filter-field-search)
+- [snk-filter-param-config](../snk-filter-param-config)
+
+### Graph
+```mermaid
+graph TD;
+  snk-expression-item --> snk-filter-field-search
+  snk-expression-item --> snk-filter-param-config
+  snk-expression-group --> snk-expression-item
+  style snk-expression-item fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-personalized-filter/subcomponents/snk-filter-advanced-mode/readme.md

@@ -0,0 +1,38 @@
+# snk-filter-advanced-mode
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute | Description                                                        | Type                  | Default     |
+| ----------------- | --------- | ------------------------------------------------------------------ | --------------------- | ----------- |
+| `application`     | --        | Propriedade que mantém informações relacionadas ao SnkApplication. | `SnkApplication`      | `undefined` |
+| `filterAssistent` | --        | Propriedade que contém informações do filtro personalizado.        | `IPersonalizedFilter` | `undefined` |
+
+
+## Events
+
+| Event                | Description                                                    | Type                |
+| -------------------- | -------------------------------------------------------------- | ------------------- |
+| `ezExpressionChange` | Evento emitido sempre que uma edição na expressão é realizada. | `CustomEvent<void>` |
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-personalized-filter](../..)
+
+### Graph
+```mermaid
+graph TD;
+  snk-personalized-filter --> snk-filter-advanced-mode
+  style snk-filter-advanced-mode fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-personalized-filter/subcomponents/snk-filter-assistent-mode/readme.md

@@ -0,0 +1,50 @@
+# snk-filter-assistent-mode
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute    | Description                                                                            | Type                  | Default     |
+| ----------------- | ------------ | -------------------------------------------------------------------------------------- | --------------------- | ----------- |
+| `application`     | --           | Propriedade que mantém informações relacionadas ao SnkApplication.                     | `SnkApplication`      | `undefined` |
+| `entityUri`       | `entity-uri` | Responsável por receber a URI da entidade.                                             | `string`              | `undefined` |
+| `filterAssistent` | --           | Propriedade que contém informações do filtro personalizado.                            | `IPersonalizedFilter` | `undefined` |
+| `filterId`        | `filter-id`  | Id do filtro que será carregado.                                                       | `string`              | `undefined` |
+| `messagesBuilder` | --           | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder`   | `undefined` |
+
+
+## Events
+
+| Event            | Description | Type                               |
+| ---------------- | ----------- | ---------------------------------- |
+| `ezChangeFilter` |             | `CustomEvent<IPersonalizedFilter>` |
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-personalized-filter](../..)
+
+### Depends on
+
+- [snk-expression-group](../snk-expression-group)
+
+### Graph
+```mermaid
+graph TD;
+  snk-filter-assistent-mode --> snk-expression-group
+  snk-expression-group --> snk-expression-item
+  snk-expression-group --> snk-expression-group
+  snk-expression-item --> snk-filter-field-search
+  snk-expression-item --> snk-filter-param-config
+  snk-personalized-filter --> snk-filter-assistent-mode
+  style snk-filter-assistent-mode fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md

@@ -0,0 +1,53 @@
+# snk-filter-param-config
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute | Description                                                                            | Type                | Default     |
+| ----------------- | --------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
+| `messagesBuilder` | --        | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
+
+
+## Methods
+
+### `close() => Promise<IExpressionItem>`
+
+Fecha o modal de configuração de valor variável
+
+#### Returns
+
+Type: `Promise<IExpressionItem>`
+
+
+
+### `open(expressionItem: IExpressionItem) => Promise<IExpressionItem>`
+
+Abre o modal de configuração de valor variável
+
+#### Returns
+
+Type: `Promise<IExpressionItem>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-expression-item](../snk-expression-item)
+
+### Graph
+```mermaid
+graph TD;
+  snk-expression-item --> snk-filter-param-config
+  style snk-filter-param-config fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-pesquisa/readme.md

@@ -0,0 +1,32 @@
+# snk-pesquisa
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property       | Attribute  | Description                                                         | Type                             | Default     |
+| -------------- | ---------- | ------------------------------------------------------------------- | -------------------------------- | ----------- |
+| `argument`     | `argument` | Argumentos que serão usados ao chamar a função searchLoader.        | `string`                         | `undefined` |
+| `searchLoader` | --         | Função responsável em carregar os itens do componente snk-pesquisa. | `(text: string) => Promise<any>` | `undefined` |
+| `selectItem`   | --         | Função disparada ao selecionar um item.                             | `(option: IOption) => void`      | `undefined` |
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-application](../snk-application)
+
+### Graph
+```mermaid
+graph TD;
+  snk-application --> snk-pesquisa
+  style snk-pesquisa fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+

package/components/snk-print-selector/readme.md

@@ -0,0 +1,23 @@
+# snk-print-selector
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Methods
+
+### `openPrintSelector(printJobData: PendingPrintJobData) => Promise<PrintSelectorResponse>`
+
+
+
+#### Returns
+
+Type: `Promise<PrintSelectorResponse>`
+
+
+
+
+----------------------------------------------
+
+

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

@@ -0,0 +1,42 @@
+# snk-simple-bar
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute | Description                                                                            | Type                | Default     |
+| ----------------- | --------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
+| `breadcrumbItens` | --        | Define os itens que serão apresentados pelo breadcrumb                                 | `IBreadcrumbItem[]` | `undefined` |
+| `label`           | `label`   | Define o título do header                                                              | `string`            | `undefined` |
+| `messagesBuilder` | --        | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
+
+
+## Events
+
+| Event                 | Description                                       | Type                           |
+| --------------------- | ------------------------------------------------- | ------------------------------ |
+| `clickBreadcrumbItem` | Emitido quando algum item do breadcrumb é clicado | `CustomEvent<IBreadcrumbItem>` |
+| `exit`                | Emitido quando o botão voltar é acionado          | `CustomEvent<void>`            |
+
+
+## Dependencies
+
+### Used by
+
+ - [snk-attach](../snk-attach)
+ - [snk-personalized-filter](../snk-personalized-filter)
+
+### Graph
+```mermaid
+graph TD;
+  snk-attach --> snk-simple-bar
+  snk-personalized-filter --> snk-simple-bar
+  style snk-simple-bar fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+