@sankhyalabs/sankhyablocks-docs 8.16.0-dev.11 → 8.16.0-dev.111
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 +93 -8
- package/components/snk-attach/readme.md +6 -5
- package/components/snk-configurator/readme.md +7 -0
- package/components/snk-crud/readme.md +40 -24
- package/components/snk-crud/subcomponents/readme.md +18 -17
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +27 -22
- package/components/snk-filter-bar/readme.md +15 -12
- package/components/snk-form-config/readme.md +6 -7
- package/components/snk-grid/readme.md +43 -33
- package/components/snk-layout-form-config/readme.md +41 -0
- package/components/snk-layout-form-config/snk-view-representation/readme.md +30 -0
- package/components/snk-pesquisa/pesquisa-grid/readme.md +42 -0
- package/components/snk-pesquisa/pesquisa-tree/readme.md +53 -0
- package/components/snk-pesquisa/readme.md +16 -5
- package/components/snk-simple-crud/readme.md +40 -31
- package/components/snk-simple-form-config/readme.md +51 -0
- package/components/snk-taskbar/elements/taskbar-split-button/readme.md +47 -0
- package/components/snk-taskbar/readme.md +24 -19
- package/components/teste-pesquisa/readme.md +2 -0
- package/package.json +1 -1
|
@@ -7,18 +7,21 @@
|
|
|
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
|
+
| `afterApplyConfig` | -- | Função chamada depois de aplicar os filtros. | `() => void` | `undefined` |
|
|
13
|
+
| `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
|
|
14
|
+
| `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` |
|
|
15
|
+
| `customFilterBarConfig` | -- | Loader customizado para carregar as configurações | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
|
|
16
|
+
| `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` |
|
|
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
|
+
| `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento | `boolean` | `false` |
|
|
19
|
+
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
|
20
|
+
| `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
|
|
21
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
22
|
+
| `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
|
|
23
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
24
|
+
| `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
|
22
25
|
|
|
23
26
|
|
|
24
27
|
## Events
|
|
@@ -7,11 +7,12 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `configManager`
|
|
13
|
-
| `dataUnit`
|
|
14
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------------------------- | ------------------------------ | -------------------------------------------------------------------------------------- | ---------------------- | ----------- |
|
|
12
|
+
| `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
|
|
13
|
+
| `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
|
|
14
|
+
| `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
|
|
15
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
15
16
|
|
|
16
17
|
|
|
17
18
|
## Events
|
|
@@ -28,7 +29,6 @@
|
|
|
28
29
|
|
|
29
30
|
- [snk-form](../snk-form)
|
|
30
31
|
- [snk-guides-viewer](../snk-crud/subcomponents)
|
|
31
|
-
- [snk-simple-crud](../snk-simple-crud)
|
|
32
32
|
|
|
33
33
|
### Depends on
|
|
34
34
|
|
|
@@ -44,7 +44,6 @@ graph TD;
|
|
|
44
44
|
snk-form-config --> snk-tab-config
|
|
45
45
|
snk-form --> snk-form-config
|
|
46
46
|
snk-guides-viewer --> snk-form-config
|
|
47
|
-
snk-simple-crud --> snk-form-config
|
|
48
47
|
style snk-form-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
49
48
|
```
|
|
50
49
|
|
|
@@ -7,31 +7,38 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `actionsList`
|
|
13
|
-
| `autoFocus`
|
|
14
|
-
| `autoLoad`
|
|
15
|
-
| `canEdit`
|
|
16
|
-
| `columnFilterDataSource`
|
|
17
|
-
| `configName`
|
|
18
|
-
| `disablePersonalizedFilter`
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
34
|
-
| `
|
|
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
|
+
| `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
|
|
14
|
+
| `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
|
|
15
|
+
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
|
16
|
+
| `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
|
|
17
|
+
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
|
18
|
+
| `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` |
|
|
19
|
+
| `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
|
|
20
|
+
| `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
|
|
21
|
+
| `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
|
|
22
|
+
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
|
23
|
+
| `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
|
24
|
+
| `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
|
|
25
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
|
26
|
+
| `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
|
|
27
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
28
|
+
| `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
|
|
29
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
|
|
30
|
+
| `outlineMode` | `outline-mode` | Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up) | `boolean` | `false` |
|
|
31
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
|
32
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
33
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
34
|
+
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
|
|
35
|
+
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
|
36
|
+
| `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
|
|
37
|
+
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
|
|
38
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
39
|
+
| `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
|
|
40
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
|
41
|
+
| `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F | `boolean` | `true` |
|
|
35
42
|
|
|
36
43
|
|
|
37
44
|
## Events
|
|
@@ -74,29 +81,29 @@ Type: `Promise<void>`
|
|
|
74
81
|
|
|
75
82
|
|
|
76
83
|
|
|
77
|
-
### `
|
|
84
|
+
### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
|
|
78
85
|
|
|
79
|
-
|
|
86
|
+
Retorna o elemento da filter-bar da grade.
|
|
80
87
|
|
|
81
88
|
#### Returns
|
|
82
89
|
|
|
83
|
-
Type: `Promise<
|
|
90
|
+
Type: `Promise<HTMLSnkFilterBarElement>`
|
|
84
91
|
|
|
85
92
|
|
|
86
93
|
|
|
87
|
-
### `
|
|
94
|
+
### `hideConfig() => Promise<void>`
|
|
88
95
|
|
|
89
|
-
|
|
96
|
+
Fecha a janela de configurações da grade.
|
|
90
97
|
|
|
91
98
|
#### Returns
|
|
92
99
|
|
|
93
|
-
Type: `Promise<
|
|
100
|
+
Type: `Promise<void>`
|
|
94
101
|
|
|
95
102
|
|
|
96
103
|
|
|
97
|
-
### `
|
|
104
|
+
### `reloadConfig() => Promise<void>`
|
|
105
|
+
|
|
98
106
|
|
|
99
|
-
Fecha a janela de configurações da grade.
|
|
100
107
|
|
|
101
108
|
#### Returns
|
|
102
109
|
|
|
@@ -169,6 +176,7 @@ Type: `Promise<void>`
|
|
|
169
176
|
- [snk-grid-config](../snk-grid-config)
|
|
170
177
|
- [snk-data-exporter](../snk-data-exporter)
|
|
171
178
|
- [snk-actions-button](../snk-actions-button)
|
|
179
|
+
- [taskbar-split-button](../snk-taskbar/elements/taskbar-split-button)
|
|
172
180
|
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
|
173
181
|
|
|
174
182
|
### Graph
|
|
@@ -179,6 +187,7 @@ graph TD;
|
|
|
179
187
|
snk-grid --> snk-grid-config
|
|
180
188
|
snk-grid --> snk-data-exporter
|
|
181
189
|
snk-grid --> snk-actions-button
|
|
190
|
+
snk-grid --> taskbar-split-button
|
|
182
191
|
snk-grid --> taskbar-actions-button
|
|
183
192
|
snk-filter-bar --> snk-filter-item
|
|
184
193
|
snk-filter-bar --> snk-personalized-filter
|
|
@@ -194,6 +203,7 @@ graph TD;
|
|
|
194
203
|
snk-expression-item --> snk-filter-param-config
|
|
195
204
|
snk-taskbar --> snk-data-exporter
|
|
196
205
|
snk-taskbar --> snk-actions-button
|
|
206
|
+
snk-taskbar --> taskbar-split-button
|
|
197
207
|
snk-taskbar --> taskbar-actions-button
|
|
198
208
|
snk-data-exporter --> snk-exporter-email-sender
|
|
199
209
|
snk-grid-config --> snk-select-box
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# snk-layout-form-config
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Methods
|
|
9
|
+
|
|
10
|
+
### `save() => Promise<void>`
|
|
11
|
+
|
|
12
|
+
Salva o tipo de layout escolhido. Sem retorno.
|
|
13
|
+
|
|
14
|
+
#### Returns
|
|
15
|
+
|
|
16
|
+
Type: `Promise<void>`
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
## Dependencies
|
|
22
|
+
|
|
23
|
+
### Used by
|
|
24
|
+
|
|
25
|
+
- [snk-configurator](../snk-configurator)
|
|
26
|
+
|
|
27
|
+
### Depends on
|
|
28
|
+
|
|
29
|
+
- [snk-view-representation](snk-view-representation)
|
|
30
|
+
|
|
31
|
+
### Graph
|
|
32
|
+
```mermaid
|
|
33
|
+
graph TD;
|
|
34
|
+
snk-layout-form-config --> snk-view-representation
|
|
35
|
+
snk-configurator --> snk-layout-form-config
|
|
36
|
+
style snk-layout-form-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
----------------------------------------------
|
|
40
|
+
|
|
41
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# snk-view-representation
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------- | --------- | ---------------------------------------------------------- | ------------ | ------------------------- |
|
|
12
|
+
| `mode` | `mode` | Define o layout do componente: 'CASCADE' ou 'SIDE_BY_SIDE' | `FormLayout` | `FormLayout.SIDE_BY_SIDE` |
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## Dependencies
|
|
16
|
+
|
|
17
|
+
### Used by
|
|
18
|
+
|
|
19
|
+
- [snk-layout-form-config](..)
|
|
20
|
+
|
|
21
|
+
### Graph
|
|
22
|
+
```mermaid
|
|
23
|
+
graph TD;
|
|
24
|
+
snk-layout-form-config --> snk-view-representation
|
|
25
|
+
style snk-view-representation fill:#f9f,stroke:#333,stroke-width:4px
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
----------------------------------------------
|
|
29
|
+
|
|
30
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# pesquisa-grid
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------------ | -------------------- | ------------------------------------------------- | -------------- | ----------- |
|
|
12
|
+
| `dataSource` | -- | Registros da grade | `Record[]` | `[]` |
|
|
13
|
+
| `descriptionField` | `description-field` | Campo que representa a descrição do registro | `string` | `undefined` |
|
|
14
|
+
| `entityName` | `entity-name` | Nome da entidade representada na grade | `string` | `undefined` |
|
|
15
|
+
| `metadata` | -- | Campos que representam as colunas da grade. | `UnitMetadata` | `undefined` |
|
|
16
|
+
| `pkField` | `pk-field` | Campo que representa a chave primária do registro | `string` | `undefined` |
|
|
17
|
+
| `shouldLoadConfig` | `should-load-config` | Define se deve carregar configurações da grade | `boolean` | `false` |
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
## Events
|
|
21
|
+
|
|
22
|
+
| Event | Description | Type |
|
|
23
|
+
| ------------------------ | ----------- | ---------------------- |
|
|
24
|
+
| `pesquisaGridSelectItem` | | `CustomEvent<IOption>` |
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## Dependencies
|
|
28
|
+
|
|
29
|
+
### Used by
|
|
30
|
+
|
|
31
|
+
- [snk-pesquisa](..)
|
|
32
|
+
|
|
33
|
+
### Graph
|
|
34
|
+
```mermaid
|
|
35
|
+
graph TD;
|
|
36
|
+
snk-pesquisa --> pesquisa-grid
|
|
37
|
+
style pesquisa-grid fill:#f9f,stroke:#333,stroke-width:4px
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
----------------------------------------------
|
|
41
|
+
|
|
42
|
+
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# pesquisa-tree
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------------- | --------------------- | ------------------------------------------------------------------ | ---------------------------------------- | ----------- |
|
|
12
|
+
| `allowsNonAnalytic` | `allows-non-analytic` | Define se permite seleção de items não analíticos | `boolean` | `false` |
|
|
13
|
+
| `argument` | `argument` | Argumentos que serão usados ao chamar a função treeLoader. | `string` | `undefined` |
|
|
14
|
+
| `shouldLoadTree` | `should-load-tree` | Informa se a árvore hierárquica deve ou não ser carregada. | `boolean` | `false` |
|
|
15
|
+
| `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente | `(text: string) => Promise<ITreeItem[]>` | `undefined` |
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Events
|
|
19
|
+
|
|
20
|
+
| Event | Description | Type |
|
|
21
|
+
| ------------------------ | ----------- | ---------------------- |
|
|
22
|
+
| `pesquisaTreeSelectItem` | | `CustomEvent<IOption>` |
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
## Methods
|
|
26
|
+
|
|
27
|
+
### `applyFilter() => Promise<void>`
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
#### Returns
|
|
32
|
+
|
|
33
|
+
Type: `Promise<void>`
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
## Dependencies
|
|
39
|
+
|
|
40
|
+
### Used by
|
|
41
|
+
|
|
42
|
+
- [snk-pesquisa](..)
|
|
43
|
+
|
|
44
|
+
### Graph
|
|
45
|
+
```mermaid
|
|
46
|
+
graph TD;
|
|
47
|
+
snk-pesquisa --> pesquisa-tree
|
|
48
|
+
style pesquisa-tree fill:#f9f,stroke:#333,stroke-width:4px
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
----------------------------------------------
|
|
52
|
+
|
|
53
|
+
|
|
@@ -7,11 +7,15 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------------- | --------------------- | ------------------------------------------------------------------- | -------------------------------- | ----------- |
|
|
12
|
+
| `allowsNonAnalytic` | `allows-non-analytic` | Define se permite seleção de items não analíticos | `boolean` | `false` |
|
|
13
|
+
| `argument` | `argument` | Argumentos que serão usados ao chamar a função searchLoader. | `string` | `undefined` |
|
|
14
|
+
| `entityName` | `entity-name` | Nome da entidade onde a pesquisa é aplicada. | `string` | `undefined` |
|
|
15
|
+
| `isHierarchyEntity` | `is-hierarchy-entity` | Define se a popup de pesquisa possuirá ou não modo Hierarquico. | `boolean` | `false` |
|
|
16
|
+
| `searchLoader` | -- | Função responsável em carregar os itens do componente snk-pesquisa. | `(text: string) => Promise<any>` | `undefined` |
|
|
17
|
+
| `selectItem` | -- | Função disparada ao selecionar um item. | `(option: IOption) => void` | `undefined` |
|
|
18
|
+
| `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente | `(text: string) => Promise<any>` | `undefined` |
|
|
15
19
|
|
|
16
20
|
|
|
17
21
|
## Dependencies
|
|
@@ -20,9 +24,16 @@
|
|
|
20
24
|
|
|
21
25
|
- [snk-application](../snk-application)
|
|
22
26
|
|
|
27
|
+
### Depends on
|
|
28
|
+
|
|
29
|
+
- [pesquisa-grid](pesquisa-grid)
|
|
30
|
+
- [pesquisa-tree](pesquisa-tree)
|
|
31
|
+
|
|
23
32
|
### Graph
|
|
24
33
|
```mermaid
|
|
25
34
|
graph TD;
|
|
35
|
+
snk-pesquisa --> pesquisa-grid
|
|
36
|
+
snk-pesquisa --> pesquisa-tree
|
|
26
37
|
snk-application --> snk-pesquisa
|
|
27
38
|
style snk-pesquisa fill:#f9f,stroke:#333,stroke-width:4px
|
|
28
39
|
```
|
|
@@ -7,30 +7,37 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `actionsList`
|
|
13
|
-
| `autoFocus`
|
|
14
|
-
| `autoLoad`
|
|
15
|
-
| `configName`
|
|
16
|
-
| `dataState`
|
|
17
|
-
| `dataUnit`
|
|
18
|
-
| `domainMessagesBuilder`
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
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
|
+
| `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
|
|
14
|
+
| `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
|
|
15
|
+
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
|
16
|
+
| `dataState` | -- | | `DataState` | `undefined` |
|
|
17
|
+
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
|
18
|
+
| `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
|
|
19
|
+
| `enableContinuousInsert` | `enable-continuous-insert` | | `boolean` | `false` |
|
|
20
|
+
| `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
|
|
21
|
+
| `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
|
|
22
|
+
| `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
|
|
23
|
+
| `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
|
|
24
|
+
| `formConfig` | -- | | `IFormConfig` | `undefined` |
|
|
25
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
26
|
+
| `gridConfig` | -- | | `IGridConfig` | `undefined` |
|
|
27
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
|
28
|
+
| `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
|
|
29
|
+
| `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `false` |
|
|
30
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
31
|
+
| `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
|
|
32
|
+
| `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
|
|
33
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
|
|
34
|
+
| `outlineMode` | `outline-mode` | Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up) | `boolean` | `false` |
|
|
35
|
+
| `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
|
|
36
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
37
|
+
| `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `false` |
|
|
38
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
39
|
+
| `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
|
|
40
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
|
34
41
|
|
|
35
42
|
|
|
36
43
|
## Events
|
|
@@ -176,33 +183,35 @@ Type: `Promise<void>`
|
|
|
176
183
|
|
|
177
184
|
### Depends on
|
|
178
185
|
|
|
179
|
-
- [snk-data-unit](../snk-data-unit)
|
|
180
186
|
- [snk-taskbar](../snk-taskbar)
|
|
181
|
-
- [snk-
|
|
187
|
+
- [snk-data-unit](../snk-data-unit)
|
|
188
|
+
- [snk-simple-form-config](../snk-simple-form-config)
|
|
182
189
|
- [snk-configurator](../snk-configurator)
|
|
183
190
|
- [snk-grid-config](../snk-grid-config)
|
|
184
191
|
- [snk-data-exporter](../snk-data-exporter)
|
|
185
192
|
- [snk-actions-button](../snk-actions-button)
|
|
193
|
+
- [taskbar-split-button](../snk-taskbar/elements/taskbar-split-button)
|
|
186
194
|
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
|
187
195
|
|
|
188
196
|
### Graph
|
|
189
197
|
```mermaid
|
|
190
198
|
graph TD;
|
|
191
|
-
snk-simple-crud --> snk-data-unit
|
|
192
199
|
snk-simple-crud --> snk-taskbar
|
|
193
|
-
snk-simple-crud --> snk-
|
|
200
|
+
snk-simple-crud --> snk-data-unit
|
|
201
|
+
snk-simple-crud --> snk-simple-form-config
|
|
194
202
|
snk-simple-crud --> snk-configurator
|
|
195
203
|
snk-simple-crud --> snk-grid-config
|
|
196
204
|
snk-simple-crud --> snk-data-exporter
|
|
197
205
|
snk-simple-crud --> snk-actions-button
|
|
206
|
+
snk-simple-crud --> taskbar-split-button
|
|
198
207
|
snk-simple-crud --> taskbar-actions-button
|
|
199
208
|
snk-taskbar --> snk-data-exporter
|
|
200
209
|
snk-taskbar --> snk-actions-button
|
|
210
|
+
snk-taskbar --> taskbar-split-button
|
|
201
211
|
snk-taskbar --> taskbar-actions-button
|
|
202
212
|
snk-data-exporter --> snk-exporter-email-sender
|
|
203
|
-
snk-
|
|
204
|
-
snk-form-config --> snk-
|
|
205
|
-
snk-form-config --> snk-tab-config
|
|
213
|
+
snk-configurator --> snk-layout-form-config
|
|
214
|
+
snk-layout-form-config --> snk-view-representation
|
|
206
215
|
snk-grid-config --> snk-select-box
|
|
207
216
|
snk-attach --> snk-simple-crud
|
|
208
217
|
style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
|