@sankhyalabs/sankhyablocks-docs 8.15.0-dev.9 → 8.15.0-rc.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/components/snk-application/readme.md +17 -5
- package/components/snk-attach/readme.md +16 -5
- package/components/snk-configurator/readme.md +2 -0
- package/components/snk-crud/readme.md +21 -13
- package/components/snk-crud/subcomponents/readme.md +5 -1
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +6 -0
- package/components/snk-filter-bar/filter-modal/readme.md +12 -11
- package/components/snk-filter-bar/readme.md +21 -7
- package/components/snk-form/readme.md +8 -7
- package/components/{snk-form/subcomponents/snk-form-config → snk-form-config}/readme.md +7 -5
- package/components/{snk-form → snk-form-config}/subcomponents/snk-config-options/readme.md +1 -1
- package/components/{snk-form → snk-form-config}/subcomponents/snk-field-config/readme.md +1 -1
- package/components/{snk-form → snk-form-config}/subcomponents/snk-tab-config/readme.md +1 -1
- package/components/snk-grid/readme.md +24 -20
- package/components/{snk-grid/subcomponents/snk-grid-config → snk-grid-config}/readme.md +4 -3
- package/components/{snk-grid/subcomponents → snk-grid-config}/snk-select-box/readme.md +1 -1
- package/components/snk-simple-crud/readme.md +55 -18
- package/components/snk-taskbar/readme.md +2 -0
- package/package.json +1 -1
|
@@ -7,11 +7,13 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `configName`
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
|
|
12
|
+
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
|
13
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
14
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
|
15
|
+
| `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: Record<string, any>; }) => void` | `undefined` |
|
|
16
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
15
17
|
|
|
16
18
|
|
|
17
19
|
## Events
|
|
@@ -439,6 +441,16 @@ Type: `Promise<any>`
|
|
|
439
441
|
|
|
440
442
|
|
|
441
443
|
|
|
444
|
+
### `setSearchFilterContext(name: string, value: string) => Promise<void>`
|
|
445
|
+
|
|
446
|
+
Atribui valor para parâmetros de contexto no componente de pesquisa.
|
|
447
|
+
|
|
448
|
+
#### Returns
|
|
449
|
+
|
|
450
|
+
Type: `Promise<void>`
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
442
454
|
### `showAlerts(alerts: Array<AlertItem>) => Promise<void>`
|
|
443
455
|
|
|
444
456
|
Apresenta uma lista de alertas,
|
|
@@ -7,11 +7,15 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description | Type
|
|
11
|
-
| -------------------------- | -------------- | -------------------------------------------------------------------------------------- |
|
|
12
|
-
| `
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------------------------- | -------------- | -------------------------------------------------------------------------------------- | ----------------------------------------- | ---------------- |
|
|
12
|
+
| `dataUnit` | -- | DataUnit responsável por carregar os dados. | `DataUnit` | `undefined` |
|
|
13
|
+
| `dataUnitBuilder` | -- | DataUnitBuilder responsável por implementar dados a serem utilizados no DataUnit. | `FetcherFacade` | `undefined` |
|
|
14
|
+
| `entityName` | `entity-name` | Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai. | `string` | `undefined` |
|
|
15
|
+
| `fetcher` | -- | Fetcher responsável por carregar os dados do DataUnit. | `AttachFetcherFacadeInterface` | `undefined` |
|
|
16
|
+
| `fetcherType` | `fetcher-type` | FetcherType define o tipo de fetcher responsável por carregar os dados do DataUnit. | `"AnexoSistema" \| "Another" \| "Attach"` | `"AnexoSistema"` |
|
|
17
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
18
|
+
| `registerKey` _(required)_ | `register-key` | Identificação do registro pai. | `string` | `undefined` |
|
|
15
19
|
|
|
16
20
|
|
|
17
21
|
## Events
|
|
@@ -40,6 +44,9 @@ graph TD;
|
|
|
40
44
|
snk-attach --> snk-simple-crud
|
|
41
45
|
snk-simple-crud --> snk-data-unit
|
|
42
46
|
snk-simple-crud --> snk-taskbar
|
|
47
|
+
snk-simple-crud --> snk-form-config
|
|
48
|
+
snk-simple-crud --> snk-configurator
|
|
49
|
+
snk-simple-crud --> snk-grid-config
|
|
43
50
|
snk-simple-crud --> snk-data-exporter
|
|
44
51
|
snk-simple-crud --> snk-actions-button
|
|
45
52
|
snk-simple-crud --> taskbar-actions-button
|
|
@@ -47,6 +54,10 @@ graph TD;
|
|
|
47
54
|
snk-taskbar --> snk-actions-button
|
|
48
55
|
snk-taskbar --> taskbar-actions-button
|
|
49
56
|
snk-data-exporter --> snk-exporter-email-sender
|
|
57
|
+
snk-form-config --> snk-field-config
|
|
58
|
+
snk-form-config --> snk-config-options
|
|
59
|
+
snk-form-config --> snk-tab-config
|
|
60
|
+
snk-grid-config --> snk-select-box
|
|
50
61
|
snk-crud --> snk-attach
|
|
51
62
|
snk-detail-view --> snk-attach
|
|
52
63
|
style snk-attach fill:#f9f,stroke:#333,stroke-width:4px
|
|
@@ -56,12 +56,14 @@ Type: `Promise<void>`
|
|
|
56
56
|
|
|
57
57
|
- [snk-crud](../snk-crud)
|
|
58
58
|
- [snk-guides-viewer](../snk-crud/subcomponents)
|
|
59
|
+
- [snk-simple-crud](../snk-simple-crud)
|
|
59
60
|
|
|
60
61
|
### Graph
|
|
61
62
|
```mermaid
|
|
62
63
|
graph TD;
|
|
63
64
|
snk-crud --> snk-configurator
|
|
64
65
|
snk-guides-viewer --> snk-configurator
|
|
66
|
+
snk-simple-crud --> snk-configurator
|
|
65
67
|
style snk-configurator fill:#f9f,stroke:#333,stroke-width:4px
|
|
66
68
|
```
|
|
67
69
|
|
|
@@ -7,19 +7,24 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `actionsList`
|
|
13
|
-
| `configName`
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -------------------------- |
|
|
12
|
+
| `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
|
13
|
+
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
|
14
|
+
| `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). | `boolean` | `undefined` |
|
|
15
|
+
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
|
16
|
+
| `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
|
17
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
18
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
|
19
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
20
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
|
|
21
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
|
22
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
23
|
+
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
|
|
24
|
+
| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
|
|
25
|
+
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
|
26
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
27
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
|
23
28
|
|
|
24
29
|
|
|
25
30
|
## Events
|
|
@@ -152,6 +157,9 @@ graph TD;
|
|
|
152
157
|
snk-attach --> snk-simple-crud
|
|
153
158
|
snk-simple-crud --> snk-data-unit
|
|
154
159
|
snk-simple-crud --> snk-taskbar
|
|
160
|
+
snk-simple-crud --> snk-form-config
|
|
161
|
+
snk-simple-crud --> snk-configurator
|
|
162
|
+
snk-simple-crud --> snk-grid-config
|
|
155
163
|
snk-simple-crud --> snk-data-exporter
|
|
156
164
|
snk-simple-crud --> snk-actions-button
|
|
157
165
|
snk-simple-crud --> taskbar-actions-button
|
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
| `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
|
|
17
17
|
| `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
|
|
18
18
|
| `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
|
|
19
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
19
20
|
| `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
|
|
20
21
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
21
22
|
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
|
|
@@ -69,7 +70,7 @@ Type: `Promise<void>`
|
|
|
69
70
|
- [snk-data-unit](../../snk-data-unit)
|
|
70
71
|
- [snk-detail-view](snk-detail-view)
|
|
71
72
|
- [snk-taskbar](../../snk-taskbar)
|
|
72
|
-
- [snk-form-config](../../snk-form
|
|
73
|
+
- [snk-form-config](../../snk-form-config)
|
|
73
74
|
- [snk-configurator](../../snk-configurator)
|
|
74
75
|
- [snk-data-exporter](../../snk-data-exporter)
|
|
75
76
|
- [snk-actions-button](../../snk-actions-button)
|
|
@@ -123,6 +124,9 @@ graph TD;
|
|
|
123
124
|
snk-attach --> snk-simple-crud
|
|
124
125
|
snk-simple-crud --> snk-data-unit
|
|
125
126
|
snk-simple-crud --> snk-taskbar
|
|
127
|
+
snk-simple-crud --> snk-form-config
|
|
128
|
+
snk-simple-crud --> snk-configurator
|
|
129
|
+
snk-simple-crud --> snk-grid-config
|
|
126
130
|
snk-simple-crud --> snk-data-exporter
|
|
127
131
|
snk-simple-crud --> snk-actions-button
|
|
128
132
|
snk-simple-crud --> taskbar-actions-button
|
|
@@ -122,9 +122,15 @@ graph TD;
|
|
|
122
122
|
snk-attach --> snk-simple-crud
|
|
123
123
|
snk-simple-crud --> snk-data-unit
|
|
124
124
|
snk-simple-crud --> snk-taskbar
|
|
125
|
+
snk-simple-crud --> snk-form-config
|
|
126
|
+
snk-simple-crud --> snk-configurator
|
|
127
|
+
snk-simple-crud --> snk-grid-config
|
|
125
128
|
snk-simple-crud --> snk-data-exporter
|
|
126
129
|
snk-simple-crud --> snk-actions-button
|
|
127
130
|
snk-simple-crud --> taskbar-actions-button
|
|
131
|
+
snk-form-config --> snk-field-config
|
|
132
|
+
snk-form-config --> snk-config-options
|
|
133
|
+
snk-form-config --> snk-tab-config
|
|
128
134
|
snk-guides-viewer --> snk-detail-view
|
|
129
135
|
style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
|
|
130
136
|
```
|
|
@@ -7,17 +7,18 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `addPersonalizedFilter`
|
|
13
|
-
| `applyFilters`
|
|
14
|
-
| `closeModal`
|
|
15
|
-
| `configName`
|
|
16
|
-
| `deletePersonalizedFilter`
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| --------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- | ----------- |
|
|
12
|
+
| `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `() => void` | `undefined` |
|
|
13
|
+
| `applyFilters` | -- | Ação executada ao aplicar os filtros | `(updatedFilterConfig: SnkFilterItemConfig[]) => void` | `undefined` |
|
|
14
|
+
| `closeModal` | -- | Ação disparada ao fechar o modal | `() => void` | `undefined` |
|
|
15
|
+
| `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
|
|
16
|
+
| `deletePersonalizedFilter` | -- | Ação executada ao deletar um filtro personalizado | `(filter: IPersonalizedFilter, configName: string) => void` | `undefined` |
|
|
17
|
+
| `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). | `boolean` | `undefined` |
|
|
18
|
+
| `editPersonalizedFilter` | -- | Ação executada ao editar um filtro personalizado | `(id: string) => void` | `undefined` |
|
|
19
|
+
| `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
|
|
20
|
+
| `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
|
|
21
|
+
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
|
21
22
|
|
|
22
23
|
|
|
23
24
|
## Dependencies
|
|
@@ -7,13 +7,17 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `configName`
|
|
13
|
-
| `dataUnit`
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ----------- |
|
|
12
|
+
| `configName` | `config-name` | Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. | `string` | `undefined` |
|
|
13
|
+
| `dataUnit` | -- | Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. | `DataUnit` | `undefined` |
|
|
14
|
+
| `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). | `boolean` | `undefined` |
|
|
15
|
+
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
|
16
|
+
| `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
|
|
17
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
18
|
+
| `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
|
|
19
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
20
|
+
| `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
|
17
21
|
|
|
18
22
|
|
|
19
23
|
## Events
|
|
@@ -65,6 +69,16 @@ Type: `Promise<SnkFilterItemConfig>`
|
|
|
65
69
|
|
|
66
70
|
- Retorna o item de filtro removido, ou undefined caso não encontrado.
|
|
67
71
|
|
|
72
|
+
### `showFilterModal() => Promise<void>`
|
|
73
|
+
|
|
74
|
+
Abre o modal de filtros
|
|
75
|
+
|
|
76
|
+
#### Returns
|
|
77
|
+
|
|
78
|
+
Type: `Promise<void>`
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
68
82
|
### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
|
|
69
83
|
|
|
70
84
|
Atualiza um item do filtro.
|
|
@@ -7,12 +7,13 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `configName`
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ---------------------- | ------------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
|
12
|
+
| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
|
|
13
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
14
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
15
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
16
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
16
17
|
|
|
17
18
|
|
|
18
19
|
## Events
|
|
@@ -51,7 +52,7 @@ Type: `Promise<void>`
|
|
|
51
52
|
|
|
52
53
|
### Depends on
|
|
53
54
|
|
|
54
|
-
- [snk-form-config](
|
|
55
|
+
- [snk-form-config](../snk-form-config)
|
|
55
56
|
|
|
56
57
|
### Graph
|
|
57
58
|
```mermaid
|
|
@@ -26,14 +26,15 @@
|
|
|
26
26
|
|
|
27
27
|
### Used by
|
|
28
28
|
|
|
29
|
-
- [snk-form](
|
|
30
|
-
- [snk-guides-viewer](
|
|
29
|
+
- [snk-form](../snk-form)
|
|
30
|
+
- [snk-guides-viewer](../snk-crud/subcomponents)
|
|
31
|
+
- [snk-simple-crud](../snk-simple-crud)
|
|
31
32
|
|
|
32
33
|
### Depends on
|
|
33
34
|
|
|
34
|
-
- [snk-field-config](
|
|
35
|
-
- [snk-config-options](
|
|
36
|
-
- [snk-tab-config](
|
|
35
|
+
- [snk-field-config](./subcomponents/snk-field-config)
|
|
36
|
+
- [snk-config-options](./subcomponents/snk-config-options)
|
|
37
|
+
- [snk-tab-config](./subcomponents/snk-tab-config)
|
|
37
38
|
|
|
38
39
|
### Graph
|
|
39
40
|
```mermaid
|
|
@@ -43,6 +44,7 @@ graph TD;
|
|
|
43
44
|
snk-form-config --> snk-tab-config
|
|
44
45
|
snk-form --> snk-form-config
|
|
45
46
|
snk-guides-viewer --> snk-form-config
|
|
47
|
+
snk-simple-crud --> snk-form-config
|
|
46
48
|
style snk-form-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
47
49
|
```
|
|
48
50
|
|
|
@@ -7,25 +7,29 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `actionsList`
|
|
13
|
-
| `canEdit`
|
|
14
|
-
| `columnFilterDataSource`
|
|
15
|
-
| `configName`
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------- |
|
|
12
|
+
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
|
13
|
+
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
|
14
|
+
| `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
|
|
15
|
+
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
|
16
|
+
| `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). | `boolean` | `undefined` |
|
|
17
|
+
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
|
18
|
+
| `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
|
19
|
+
| `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
|
|
20
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
|
21
|
+
| `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
|
|
22
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
23
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
|
|
24
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
|
25
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
26
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
27
|
+
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
|
|
28
|
+
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
|
29
|
+
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
|
|
30
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
31
|
+
| `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
|
|
32
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
|
29
33
|
|
|
30
34
|
|
|
31
35
|
## Events
|
|
@@ -110,7 +114,7 @@ Type: `Promise<void>`
|
|
|
110
114
|
|
|
111
115
|
- [snk-filter-bar](../snk-filter-bar)
|
|
112
116
|
- [snk-taskbar](../snk-taskbar)
|
|
113
|
-
- [snk-grid-config](
|
|
117
|
+
- [snk-grid-config](../snk-grid-config)
|
|
114
118
|
- [snk-data-exporter](../snk-data-exporter)
|
|
115
119
|
- [snk-actions-button](../snk-actions-button)
|
|
116
120
|
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
|
@@ -9,7 +9,6 @@
|
|
|
9
9
|
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
|
11
11
|
| --------------- | ---------------- | ------------------------------------------------ | ---------------- | ----------- |
|
|
12
|
-
| `application` | -- | Referência para o SnkApplication | `SnkApplication` | `undefined` |
|
|
13
12
|
| `columns` | -- | Colunas da grade. | `EzGridColumn[]` | `undefined` |
|
|
14
13
|
| `config` | -- | Configurações da grade. | `IGridConfig` | `undefined` |
|
|
15
14
|
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
|
@@ -29,17 +28,19 @@
|
|
|
29
28
|
|
|
30
29
|
### Used by
|
|
31
30
|
|
|
32
|
-
- [snk-grid](
|
|
31
|
+
- [snk-grid](../snk-grid)
|
|
32
|
+
- [snk-simple-crud](../snk-simple-crud)
|
|
33
33
|
|
|
34
34
|
### Depends on
|
|
35
35
|
|
|
36
|
-
- [snk-select-box](
|
|
36
|
+
- [snk-select-box](snk-select-box)
|
|
37
37
|
|
|
38
38
|
### Graph
|
|
39
39
|
```mermaid
|
|
40
40
|
graph TD;
|
|
41
41
|
snk-grid-config --> snk-select-box
|
|
42
42
|
snk-grid --> snk-grid-config
|
|
43
|
+
snk-simple-crud --> snk-grid-config
|
|
43
44
|
style snk-grid-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
44
45
|
```
|
|
45
46
|
|
|
@@ -7,32 +7,49 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------- |
|
|
12
|
+
| `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
|
13
|
+
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
|
14
|
+
| `dataState` | -- | | `DataState` | `undefined` |
|
|
15
|
+
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
|
16
|
+
| `formConfig` | -- | | `IFormConfig` | `undefined` |
|
|
17
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
18
|
+
| `gridConfig` | -- | | `IGridConfig` | `undefined` |
|
|
19
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
|
20
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
21
|
+
| `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
|
|
22
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
|
|
23
|
+
| `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
|
|
24
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
25
|
+
| `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
|
|
26
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
|
22
27
|
|
|
23
28
|
|
|
24
29
|
## Events
|
|
25
30
|
|
|
26
|
-
| Event
|
|
27
|
-
|
|
|
28
|
-
| `actionClick`
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
31
|
+
| Event | Description | Type |
|
|
32
|
+
| -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
|
|
33
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
|
34
|
+
| `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
|
|
35
|
+
| `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
|
|
36
|
+
| `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
|
|
37
|
+
| `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
|
|
38
|
+
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
|
32
39
|
|
|
33
40
|
|
|
34
41
|
## Methods
|
|
35
42
|
|
|
43
|
+
### `closeConfigurator() => Promise<void>`
|
|
44
|
+
|
|
45
|
+
Usado para fechar o configurator do CRUD
|
|
46
|
+
|
|
47
|
+
#### Returns
|
|
48
|
+
|
|
49
|
+
Type: `Promise<void>`
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
36
53
|
### `getRecords() => Promise<Array<Record>>`
|
|
37
54
|
|
|
38
55
|
|
|
@@ -53,6 +70,16 @@ Type: `Promise<void>`
|
|
|
53
70
|
|
|
54
71
|
|
|
55
72
|
|
|
73
|
+
### `openConfigurator() => Promise<void>`
|
|
74
|
+
|
|
75
|
+
Usado para abrir o configurator do CRUD
|
|
76
|
+
|
|
77
|
+
#### Returns
|
|
78
|
+
|
|
79
|
+
Type: `Promise<void>`
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
56
83
|
### `setMetadata(metadata: UnitMetadata) => Promise<void>`
|
|
57
84
|
|
|
58
85
|
|
|
@@ -84,6 +111,9 @@ Type: `Promise<void>`
|
|
|
84
111
|
|
|
85
112
|
- [snk-data-unit](../snk-data-unit)
|
|
86
113
|
- [snk-taskbar](../snk-taskbar)
|
|
114
|
+
- [snk-form-config](../snk-form-config)
|
|
115
|
+
- [snk-configurator](../snk-configurator)
|
|
116
|
+
- [snk-grid-config](../snk-grid-config)
|
|
87
117
|
- [snk-data-exporter](../snk-data-exporter)
|
|
88
118
|
- [snk-actions-button](../snk-actions-button)
|
|
89
119
|
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
|
@@ -93,6 +123,9 @@ Type: `Promise<void>`
|
|
|
93
123
|
graph TD;
|
|
94
124
|
snk-simple-crud --> snk-data-unit
|
|
95
125
|
snk-simple-crud --> snk-taskbar
|
|
126
|
+
snk-simple-crud --> snk-form-config
|
|
127
|
+
snk-simple-crud --> snk-configurator
|
|
128
|
+
snk-simple-crud --> snk-grid-config
|
|
96
129
|
snk-simple-crud --> snk-data-exporter
|
|
97
130
|
snk-simple-crud --> snk-actions-button
|
|
98
131
|
snk-simple-crud --> taskbar-actions-button
|
|
@@ -100,6 +133,10 @@ graph TD;
|
|
|
100
133
|
snk-taskbar --> snk-actions-button
|
|
101
134
|
snk-taskbar --> taskbar-actions-button
|
|
102
135
|
snk-data-exporter --> snk-exporter-email-sender
|
|
136
|
+
snk-form-config --> snk-field-config
|
|
137
|
+
snk-form-config --> snk-config-options
|
|
138
|
+
snk-form-config --> snk-tab-config
|
|
139
|
+
snk-grid-config --> snk-select-box
|
|
103
140
|
snk-attach --> snk-simple-crud
|
|
104
141
|
style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
|
|
105
142
|
```
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
|
11
11
|
| ------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | --------------------------- |
|
|
12
12
|
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
|
13
|
+
| `alignRigth` | `align-rigth` | Usado para determinar O alinhamento dos items na taskbar. | `boolean` | `false` |
|
|
13
14
|
| `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
|
|
14
15
|
| `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
|
|
15
16
|
| `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` |
|
|
@@ -18,6 +19,7 @@
|
|
|
18
19
|
| `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
|
|
19
20
|
| `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
|
|
20
21
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
22
|
+
| `overflowStrategy` | `overflow-strategy` | Define como será o comportamento da taskbar quando ocorrer overflow | `"hiddenItems" \| "none"` | `'hiddenItems'` |
|
|
21
23
|
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
|
22
24
|
| `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
|
|
23
25
|
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|