@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-KB-106794.0 → 0.0.0-hotfix-ga-kb-107084.0
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 +89 -25
- package/components/snk-configurator/readme.md +1 -1
- package/components/snk-crud/readme.md +9 -9
- package/components/snk-crud/subcomponents/readme.md +4 -4
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +4 -4
- package/components/snk-data-exporter/exporter-email-sender/readme.md +1 -1
- package/components/snk-data-unit/readme.md +8 -0
- package/components/snk-filter-bar/filter-item/readme.md +1 -1
- package/components/snk-filter-bar/readme.md +6 -4
- package/components/snk-filter-field-search/readme.md +1 -1
- package/components/snk-form/readme.md +20 -10
- package/components/snk-grid/readme.md +69 -51
- package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md +1 -1
- package/components/snk-simple-crud/readme.md +60 -58
- package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +2 -2
- package/components/snk-taskbar/readme.md +22 -22
- package/package.json +1 -1
@@ -41,7 +41,7 @@ Adiciona um item de filtro.
|
|
41
41
|
|
42
42
|
Type: `Promise<void>`
|
43
43
|
|
44
|
-
|
44
|
+
---
|
45
45
|
|
46
46
|
### `getFilterItem(id: string) => Promise<SnkFilterItemConfig | undefined>`
|
47
47
|
|
@@ -51,7 +51,7 @@ Retorna um item de filtro pelo ID.
|
|
51
51
|
|
52
52
|
Type: `Promise<SnkFilterItemConfig>`
|
53
53
|
|
54
|
-
|
54
|
+
---
|
55
55
|
|
56
56
|
### `reload() => Promise<void>`
|
57
57
|
|
@@ -61,7 +61,7 @@ Faz o recarregamento da filterbar buscando o state no servidor.
|
|
61
61
|
|
62
62
|
Type: `Promise<void>`
|
63
63
|
|
64
|
-
|
64
|
+
---
|
65
65
|
|
66
66
|
### `removeFilterItem(filterID: string) => Promise<SnkFilterItemConfig | undefined>`
|
67
67
|
|
@@ -73,6 +73,8 @@ Type: `Promise<SnkFilterItemConfig>`
|
|
73
73
|
|
74
74
|
- Retorna o item de filtro removido, ou undefined caso não encontrado.
|
75
75
|
|
76
|
+
---
|
77
|
+
|
76
78
|
### `showFilterModal() => Promise<void>`
|
77
79
|
|
78
80
|
Abre o modal de filtros
|
@@ -81,7 +83,7 @@ Abre o modal de filtros
|
|
81
83
|
|
82
84
|
Type: `Promise<void>`
|
83
85
|
|
84
|
-
|
86
|
+
---
|
85
87
|
|
86
88
|
### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
|
87
89
|
|
@@ -10,7 +10,7 @@
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
11
11
|
| ---------------------- | ------------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
12
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
|
13
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legada do formulário. | `string` | `undefined` |
|
14
14
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
15
15
|
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
16
16
|
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
@@ -18,24 +18,24 @@
|
|
18
18
|
|
19
19
|
## Events
|
20
20
|
|
21
|
-
| Event | Description
|
22
|
-
| ---------------- |
|
23
|
-
| `actionClick` |
|
24
|
-
| `exit` |
|
25
|
-
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
21
|
+
| Event | Description | Type |
|
22
|
+
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
|
23
|
+
| `actionClick` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<string>` |
|
24
|
+
| `exit` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<void>` |
|
25
|
+
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. OBS: Emitido no subcomponente snk-form-view | `CustomEvent<HTMLElement[]>` |
|
26
26
|
|
27
27
|
|
28
28
|
## Methods
|
29
29
|
|
30
30
|
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
31
31
|
|
32
|
-
Registra um editor customizado para campos
|
32
|
+
Registra um editor customizado para campos do formulário.
|
33
33
|
|
34
34
|
#### Returns
|
35
35
|
|
36
36
|
Type: `Promise<void>`
|
37
37
|
|
38
|
-
|
38
|
+
---
|
39
39
|
|
40
40
|
### `hideConfig() => Promise<void>`
|
41
41
|
|
@@ -45,7 +45,7 @@ Fecha a janela de configurações do formulário.
|
|
45
45
|
|
46
46
|
Type: `Promise<void>`
|
47
47
|
|
48
|
-
|
48
|
+
---
|
49
49
|
|
50
50
|
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
51
51
|
|
@@ -55,7 +55,7 @@ Altera/adiciona uma propriedade nos metadados do campo.
|
|
55
55
|
|
56
56
|
Type: `Promise<void>`
|
57
57
|
|
58
|
-
|
58
|
+
---
|
59
59
|
|
60
60
|
### `showConfig() => Promise<void>`
|
61
61
|
|
@@ -65,6 +65,16 @@ Exibe a janela de configurações do formulário.
|
|
65
65
|
|
66
66
|
Type: `Promise<void>`
|
67
67
|
|
68
|
+
---
|
69
|
+
|
70
|
+
### `validate() => Promise<void>`
|
71
|
+
|
72
|
+
Valida o formulário.
|
73
|
+
|
74
|
+
#### Returns
|
75
|
+
|
76
|
+
Type: `Promise<void>`
|
77
|
+
|
68
78
|
|
69
79
|
|
70
80
|
|
@@ -7,94 +7,102 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description
|
11
|
-
| ------------------------------- | ----------------------------------- |
|
12
|
-
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do
|
13
|
-
| `autoFocus` | `auto-focus` | Define se a
|
14
|
-
| `autoLoad` | `auto-load` | Define se
|
15
|
-
| `canEdit` | `can-edit` | Define se a edição
|
16
|
-
| `columnFilterDataSource` | -- |
|
17
|
-
| `compact` | `compact` | Define se a grade deve ser exibida em modo compacto
|
18
|
-
| `configName` | `config-name` | Nome usado para salvar
|
19
|
-
| `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na
|
20
|
-
| `enableGridInsert` | `enable-grid-insert` |
|
21
|
-
| `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação
|
22
|
-
| `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar.
|
23
|
-
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração
|
24
|
-
| `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros
|
25
|
-
| `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` |
|
26
|
-
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração
|
27
|
-
| `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe.
|
28
|
-
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
|
29
|
-
| `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros
|
30
|
-
| `multipleSelection` | `multiple-selection` | Determina se
|
31
|
-
| `outlineMode` | `outline-mode` | Altera
|
32
|
-
| `paginationCounterMode` | `pagination-counter-mode` | Define
|
33
|
-
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar
|
34
|
-
| `recordsValidator` | -- | Validador responsável por
|
35
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso.
|
36
|
-
| `selectionToastConfig` | -- | Configuração
|
37
|
-
| `statusResolver` | -- |
|
38
|
-
| `strategyExporter` | `strategy-exporter` |
|
39
|
-
| `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de
|
40
|
-
| `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir
|
41
|
-
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do
|
42
|
-
| `taskbarManager` | -- | Gerenciador das barras de tarefas.
|
43
|
-
| `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` |
|
44
|
-
| `useEnterLikeTab` | `use-enter-like-tab` | Quando
|
45
|
-
| `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------- |
|
12
|
+
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`. | `Action[]` | `undefined` |
|
13
|
+
| `autoFocus` | `auto-focus` | Define se a grade receberá o foco automaticamente ao ser carregada. | `boolean` | `true` |
|
14
|
+
| `autoLoad` | `auto-load` | Define se os dados serão carregados automaticamente na inicialização do componente. | `boolean` | `undefined` |
|
15
|
+
| `canEdit` | `can-edit` | Define se a edição de dados na grade está habilitada. | `boolean` | `true` |
|
16
|
+
| `columnFilterDataSource` | -- | Define o data source para o filtro de colunas. | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
|
17
|
+
| `compact` | `compact` | Define se a grade deve ser exibida em modo compacto. | `boolean` | `undefined` |
|
18
|
+
| `configName` | `config-name` | Nome usado para salvar e recuperar a configuração da grade. | `string` | `undefined` |
|
19
|
+
| `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na barra de filtros (chip de filtros) e no modal lateral de filtros (contêiner de filtros personalizados). | `boolean` | `undefined` |
|
20
|
+
| `enableGridInsert` | `enable-grid-insert` | Habilita a inserção de registros diretamente na 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
|
+
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legada da barra de filtros. | `string` | `undefined` |
|
24
|
+
| `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros. | `string` | `undefined` |
|
25
|
+
| `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
|
26
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade. | `string` | `undefined` |
|
27
|
+
| `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe de outra tela. | `boolean` | `undefined` |
|
28
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
29
|
+
| `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultaneamente. | `boolean` | `true` |
|
30
|
+
| `multipleSelection` | `multiple-selection` | Determina se a seleção de múltiplas linhas é permitida. | `boolean` | `undefined` |
|
31
|
+
| `outlineMode` | `outline-mode` | Altera a aparência das bordas e sombras do componente. Se `false`, aplica o padrão de sombras (ideal para o elemento principal do layout). Se `true`, aplica um contorno (ideal para quando o componente está dentro de outro, como um painel ou pop-up). | `boolean` | `false` |
|
32
|
+
| `paginationCounterMode` | `pagination-counter-mode` | Define o modo de exibição do contador de paginação. | `"auto" \| "hidden" \| "show"` | `'auto'` |
|
33
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do `snk-taskbar`. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
34
|
+
| `recordsValidator` | -- | Validador responsável por verificar a integridade dos dados de um registro. | `IRecordValidator` | `undefined` |
|
35
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos, como configurações e permissões de acesso. | `string` | `undefined` |
|
36
|
+
| `selectionToastConfig` | -- | Configuração do toast de seleção da grade. | `ISelectionToastConfig` | `undefined` |
|
37
|
+
| `statusResolver` | -- | Define a configuração de cores para a coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
38
|
+
| `strategyExporter` | `strategy-exporter` | Define o modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
|
39
|
+
| `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de checkbox deve ser suprimida. | `boolean` | `undefined` |
|
40
|
+
| `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir a barra de rolagem horizontal. | `boolean` | `false` |
|
41
|
+
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do contêiner de elementos customizados da `Taskbar`. | `string` | `undefined` |
|
42
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
43
|
+
| `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
|
44
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando `true`, a tecla ENTER navega entre as células como a tecla TAB. | `boolean` | `false` |
|
45
|
+
| `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`. | `boolean` | `true` |
|
46
46
|
|
47
47
|
|
48
48
|
## Events
|
49
49
|
|
50
|
-
| Event | Description
|
51
|
-
| ----------------- |
|
52
|
-
| `actionClick` | Emitido
|
53
|
-
| `componentReady` |
|
54
|
-
| `gridDoubleClick` | Emitido
|
50
|
+
| Event | Description | Type |
|
51
|
+
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
|
52
|
+
| `actionClick` | Emitido ao clicar em um botão de ação ou item de menu. | `CustomEvent<string>` |
|
53
|
+
| `componentReady` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<void>` |
|
54
|
+
| `gridDoubleClick` | Emitido ao realizar um duplo clique em uma linha da grade. | `CustomEvent<any>` |
|
55
55
|
|
56
56
|
|
57
57
|
## Methods
|
58
58
|
|
59
59
|
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
|
60
60
|
|
61
|
-
Registra um editor customizado para
|
61
|
+
Registra um editor customizado para um campo da grade ou formulário.
|
62
62
|
|
63
63
|
#### Returns
|
64
64
|
|
65
65
|
Type: `Promise<void>`
|
66
66
|
|
67
|
+
Uma promessa que é resolvida quando o editor é registrado.
|
67
68
|
|
69
|
+
---
|
68
70
|
|
69
71
|
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
70
72
|
|
71
|
-
Registra um formatador de
|
73
|
+
Registra um formatador de valor customizado para uma coluna da grade.
|
72
74
|
|
73
75
|
#### Returns
|
74
76
|
|
75
77
|
Type: `Promise<void>`
|
76
78
|
|
79
|
+
Uma promessa que é resolvida quando o formatador é registrado.
|
77
80
|
|
81
|
+
---
|
78
82
|
|
79
83
|
### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
|
80
84
|
|
81
|
-
Registra um
|
85
|
+
Registra um renderizador customizado para uma coluna da grade.
|
82
86
|
|
83
87
|
#### Returns
|
84
88
|
|
85
89
|
Type: `Promise<void>`
|
86
90
|
|
91
|
+
Uma promessa que é resolvida quando o renderizador é registrado.
|
87
92
|
|
93
|
+
---
|
88
94
|
|
89
95
|
### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
|
90
96
|
|
91
|
-
Retorna o elemento da
|
97
|
+
Retorna o elemento da barra de filtros da grade.
|
92
98
|
|
93
99
|
#### Returns
|
94
100
|
|
95
101
|
Type: `Promise<HTMLSnkFilterBarElement>`
|
96
102
|
|
103
|
+
O elemento da barra de filtros.
|
97
104
|
|
105
|
+
---
|
98
106
|
|
99
107
|
### `hideConfig() => Promise<void>`
|
100
108
|
|
@@ -104,47 +112,55 @@ Fecha a janela de configurações da grade.
|
|
104
112
|
|
105
113
|
Type: `Promise<void>`
|
106
114
|
|
115
|
+
Uma promessa que é resolvida quando a janela de configuração é fechada.
|
107
116
|
|
117
|
+
---
|
108
118
|
|
109
119
|
### `reloadConfig() => Promise<void>`
|
110
120
|
|
111
|
-
|
121
|
+
Recarrega a configuração da grade.
|
112
122
|
|
113
123
|
#### Returns
|
114
124
|
|
115
125
|
Type: `Promise<void>`
|
116
126
|
|
117
|
-
|
127
|
+
---
|
118
128
|
|
119
129
|
### `reloadFilterBar() => Promise<void>`
|
120
130
|
|
121
|
-
|
131
|
+
Recarrega a barra de filtros da grade, buscando o estado do servidor.
|
122
132
|
|
123
133
|
#### Returns
|
124
134
|
|
125
135
|
Type: `Promise<void>`
|
126
136
|
|
137
|
+
Uma promessa que é resolvida quando a barra de filtros é recarregada.
|
127
138
|
|
139
|
+
---
|
128
140
|
|
129
141
|
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
130
142
|
|
131
|
-
Remove
|
143
|
+
Remove um formatador de valor customizado de uma coluna da grade.
|
132
144
|
|
133
145
|
#### Returns
|
134
146
|
|
135
147
|
Type: `Promise<void>`
|
136
148
|
|
149
|
+
Uma promessa que é resolvida quando o formatador é removido.
|
137
150
|
|
151
|
+
---
|
138
152
|
|
139
153
|
### `setConfig(config: IGridConfig) => Promise<void>`
|
140
154
|
|
141
|
-
|
155
|
+
Define a configuração da grade.
|
142
156
|
|
143
157
|
#### Returns
|
144
158
|
|
145
159
|
Type: `Promise<void>`
|
146
160
|
|
161
|
+
Uma promessa que é resolvida quando a configuração é aplicada.
|
147
162
|
|
163
|
+
---
|
148
164
|
|
149
165
|
### `setFocus() => Promise<void>`
|
150
166
|
|
@@ -154,7 +170,9 @@ Atribui o foco para a grade.
|
|
154
170
|
|
155
171
|
Type: `Promise<void>`
|
156
172
|
|
173
|
+
Uma promessa que é resolvida quando o foco é atribuído.
|
157
174
|
|
175
|
+
---
|
158
176
|
|
159
177
|
### `showConfig() => Promise<void>`
|
160
178
|
|
@@ -164,7 +182,7 @@ Exibe a janela de configurações da grade.
|
|
164
182
|
|
165
183
|
Type: `Promise<void>`
|
166
184
|
|
167
|
-
|
185
|
+
Uma promessa que é resolvida quando a janela de configuração é exibida.
|
168
186
|
|
169
187
|
|
170
188
|
## Dependencies
|