@sankhyalabs/sankhyablocks-docs 10.1.0-rc.2 → 10.1.0-rc.20

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.
Files changed (23) hide show
  1. package/components/snk-actions-button/readme.md +7 -0
  2. package/components/snk-application/readme.md +20 -8
  3. package/components/snk-attach/readme.md +28 -5
  4. package/components/snk-crud/readme.md +24 -15
  5. package/components/snk-crud/subcomponents/readme.md +11 -9
  6. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +2 -1
  7. package/components/snk-custom-slot-guide/readme.md +24 -0
  8. package/components/snk-data-exporter/readme.md +5 -4
  9. package/components/snk-filter-bar/filter-item/readme.md +1 -0
  10. package/components/snk-filter-bar/filter-modal/readme.md +15 -15
  11. package/components/snk-filter-bar/readme.md +6 -0
  12. package/components/snk-form-config/readme.md +1 -0
  13. package/components/snk-grid/readme.md +74 -39
  14. package/components/snk-grid-config/readme.md +9 -7
  15. package/components/snk-image-input/readme.md +56 -0
  16. package/components/snk-pesquisa/readme.md +14 -0
  17. package/components/snk-simple-bar/readme.md +0 -2
  18. package/components/snk-simple-crud/readme.md +34 -32
  19. package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +6 -5
  20. package/components/snk-taskbar/elements/taskbar-split-button/readme.md +11 -10
  21. package/components/snk-taskbar/readme.md +8 -2
  22. package/components/snk-taskbar/subcomponents/readme.md +23 -0
  23. package/package.json +1 -1
package/components/snk-actions-button/readme.md CHANGED
@@ -5,6 +5,13 @@
5
5
  <!-- Auto Generated Below -->
6
6
 
7
7
 
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------- | --------- | -------------------------------------------------------------------- | -------------------------------- | ---------- |
12
+ | `size` | `size` | Define o tamanho do botão, podendo ser 'small', 'medium' ou 'large'. | `"large" \| "medium" \| "small"` | `'medium'` |
13
+
14
+
8
15
  ## Dependencies
9
16
 
10
17
  ### Used by
package/components/snk-application/readme.md CHANGED
@@ -7,14 +7,14 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ----------- |
12
- | `configName` | `config-name` | Nome da configuração utilizada para salvar as preferências dos blocos de construção. | `string` | `undefined` |
13
- | `enableLockManagerLoadingApp` | `enable-lock-manager-loading-app` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação. | `boolean` | `undefined` |
14
- | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legada do formulário, utilizada para migração de configurações antigas. | `string` | `undefined` |
15
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade, utilizada para migração de configurações antigas. | `string` | `undefined` |
16
- | `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: any; }, redirectFrom?: string) => void` | `undefined` |
17
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ----------- |
12
+ | `configName` | `config-name` | Nome da configuração utilizada para salvar as preferências dos blocos de construção. | `string` | `undefined` |
13
+ | `enableLockManagerLoadingApp` | `enable-lock-manager-loading-app` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação. | `boolean` | `undefined` |
14
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legada do formulário, utilizada para migração de configurações antigas. | `string` | `undefined` |
15
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade, utilizada para migração de configurações antigas. | `string` | `undefined` |
16
+ | `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>; }, redirectFrom?: string) => void` | `undefined` |
17
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
18
18
 
19
19
 
20
20
  ## Events
@@ -184,6 +184,18 @@ Uma lista de opções ou uma única opção.
184
184
 
185
185
  ---
186
186
 
187
+ ### `executePreparedSearchWithFullResponse(argument: string, options: any) => Promise<any>`
188
+
189
+ Obtém as opções em componentes de pesquisa além dos metadados como showMore e entityPk.
190
+
191
+ #### Returns
192
+
193
+ Type: `Promise<any>`
194
+
195
+ Uma lista de opções ou uma única opção.
196
+
197
+ ---
198
+
187
199
  ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: ISearchCtxOptions) => Promise<Array<IOption> | IOption>`
188
200
 
189
201
  Obtém as opções em componentes de pesquisa.
package/components/snk-attach/readme.md CHANGED
@@ -21,9 +21,33 @@
21
21
 
22
22
  ## Events
23
23
 
24
- | Event | Description | Type |
25
- | ------ | -------------------------------------------------------- | ------------------- |
26
- | `back` | Evento disparado quando o usuário clica no botão voltar. | `CustomEvent<void>` |
24
+ | Event | Description | Type |
25
+ | -------------- | ------------------------------------------------------------- | ------------------- |
26
+ | `ezClosePopup` | Evento emitido ao clicar no botão de fechar (onEzClosePopup). | `CustomEvent<void>` |
27
+
28
+
29
+ ## Methods
30
+
31
+ ### `close() => Promise<void>`
32
+
33
+ Fecha o popup do SnkAttach.
34
+
35
+ #### Returns
36
+
37
+ Type: `Promise<void>`
38
+
39
+ ---
40
+
41
+ ### `open() => Promise<void>`
42
+
43
+ Abre o popup do SnkAttach.
44
+ Inicializa o componente apenas na abertura.
45
+
46
+ #### Returns
47
+
48
+ Type: `Promise<void>`
49
+
50
+
27
51
 
28
52
 
29
53
  ## Dependencies
@@ -35,13 +59,11 @@
35
59
 
36
60
  ### Depends on
37
61
 
38
- - [snk-simple-bar](../snk-simple-bar)
39
62
  - [snk-simple-crud](../snk-simple-crud)
40
63
 
41
64
  ### Graph
42
65
  ```mermaid
43
66
  graph TD;
44
- snk-attach --> snk-simple-bar
45
67
  snk-attach --> snk-simple-crud
46
68
  snk-simple-crud --> snk-taskbar
47
69
  snk-simple-crud --> snk-data-unit
@@ -52,6 +74,7 @@ graph TD;
52
74
  snk-simple-crud --> snk-actions-button
53
75
  snk-simple-crud --> taskbar-split-button
54
76
  snk-simple-crud --> taskbar-actions-button
77
+ snk-taskbar --> snk-taskbar-skeleton
55
78
  snk-taskbar --> snk-data-exporter
56
79
  snk-taskbar --> snk-actions-button
57
80
  snk-taskbar --> taskbar-split-button
package/components/snk-crud/readme.md CHANGED
@@ -13,6 +13,7 @@
13
13
  | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
14
14
  | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
15
15
  | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
16
+ | `customGuidesConfig` | -- | Fornece as informações das guias personalizadas. | `CustomGuideItem[]` | `[]` |
16
17
  | `disableNumberingConfig` | `disable-numbering-config` | Define se a configuração de numeração será desabilitada. | `boolean` | `false` |
17
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` |
18
19
  | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
@@ -33,7 +34,8 @@
33
34
  | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
34
35
  | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
35
36
  | `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
36
- | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
37
+ | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `true` |
38
+ | `showEntitySearch` | `show-entity-search` | Define se o campo de busca de entidades será exibido na barra superior. | `boolean` | `true` |
37
39
  | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
38
40
  | `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
39
41
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
@@ -49,6 +51,7 @@
49
51
  | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
50
52
  | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
51
53
  | `numberingConfigChanged` | Emitido quando a configuração de numeração é alterada. | `CustomEvent<ResponseGetConfig>` |
54
+ | `snkShowGuide` | Emitido pelo guides-viewer sempre que houver mudança de guia. | `CustomEvent<string>` |
52
55
  | `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
53
56
 
54
57
 
@@ -179,6 +182,9 @@ Type: `Promise<void>`
179
182
 
180
183
  ### Depends on
181
184
 
185
+ - [snk-entity-search](subcomponents)
186
+ - [snk-taskbar](../snk-taskbar)
187
+ - [snk-filter-bar](../snk-filter-bar)
182
188
  - [snk-grid](../snk-grid)
183
189
  - [snk-guides-viewer](subcomponents)
184
190
  - [snk-attach](../snk-attach)
@@ -191,6 +197,9 @@ Type: `Promise<void>`
191
197
  ### Graph
192
198
  ```mermaid
193
199
  graph TD;
200
+ snk-crud --> snk-entity-search
201
+ snk-crud --> snk-taskbar
202
+ snk-crud --> snk-filter-bar
194
203
  snk-crud --> snk-grid
195
204
  snk-crud --> snk-guides-viewer
196
205
  snk-crud --> snk-attach
@@ -199,13 +208,12 @@ graph TD;
199
208
  snk-crud --> snk-actions-button
200
209
  snk-crud --> taskbar-split-button
201
210
  snk-crud --> taskbar-actions-button
202
- snk-grid --> snk-filter-bar
203
- snk-grid --> snk-taskbar
204
- snk-grid --> snk-grid-config
205
- snk-grid --> snk-data-exporter
206
- snk-grid --> snk-actions-button
207
- snk-grid --> taskbar-split-button
208
- snk-grid --> taskbar-actions-button
211
+ snk-taskbar --> snk-taskbar-skeleton
212
+ snk-taskbar --> snk-data-exporter
213
+ snk-taskbar --> snk-actions-button
214
+ snk-taskbar --> taskbar-split-button
215
+ snk-taskbar --> taskbar-actions-button
216
+ snk-data-exporter --> snk-exporter-email-sender
209
217
  snk-filter-bar --> snk-filter-item
210
218
  snk-filter-bar --> snk-personalized-filter
211
219
  snk-filter-bar --> snk-filter-modal
@@ -221,22 +229,24 @@ graph TD;
221
229
  snk-expression-item --> snk-filter-param-config
222
230
  snk-filter-modal --> snk-filter-modal-item
223
231
  snk-filter-modal --> snk-default-filter
224
- snk-taskbar --> snk-data-exporter
225
- snk-taskbar --> snk-actions-button
226
- snk-taskbar --> taskbar-split-button
227
- snk-taskbar --> taskbar-actions-button
228
- snk-data-exporter --> snk-exporter-email-sender
232
+ snk-grid --> snk-filter-bar
233
+ snk-grid --> snk-taskbar
234
+ snk-grid --> snk-grid-config
235
+ snk-grid --> snk-data-exporter
236
+ snk-grid --> snk-actions-button
237
+ snk-grid --> taskbar-split-button
238
+ snk-grid --> taskbar-actions-button
229
239
  snk-grid-config --> snk-select-box
230
240
  snk-guides-viewer --> snk-form-view
231
241
  snk-guides-viewer --> snk-data-unit
232
242
  snk-guides-viewer --> snk-detail-view
233
- snk-guides-viewer --> snk-taskbar
234
243
  snk-guides-viewer --> snk-form-config
235
244
  snk-guides-viewer --> snk-configurator
236
245
  snk-guides-viewer --> snk-data-exporter
237
246
  snk-guides-viewer --> snk-actions-button
238
247
  snk-guides-viewer --> taskbar-split-button
239
248
  snk-guides-viewer --> taskbar-actions-button
249
+ snk-form-view --> snk-image-input
240
250
  snk-form-view --> snk-form-summary
241
251
  snk-detail-view --> snk-data-unit
242
252
  snk-detail-view --> snk-grid
@@ -247,7 +257,6 @@ graph TD;
247
257
  snk-detail-view --> snk-actions-button
248
258
  snk-detail-view --> taskbar-split-button
249
259
  snk-detail-view --> taskbar-actions-button
250
- snk-attach --> snk-simple-bar
251
260
  snk-attach --> snk-simple-crud
252
261
  snk-simple-crud --> snk-taskbar
253
262
  snk-simple-crud --> snk-data-unit
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -12,6 +12,7 @@
12
12
  | `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
13
13
  | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
14
  | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
15
+ | `customGuidesConfig` | -- | Fornece as informações das guias personalizadas. | `CustomGuideItem[]` | `[]` |
15
16
  | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
16
17
  | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
17
18
  | `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
@@ -31,12 +32,14 @@
31
32
 
32
33
  ## Events
33
34
 
34
- | Event | Description | Type |
35
- | --------------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
36
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
37
- | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
38
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
39
- | `snkMasterFormConfigChange` | Emitido quando a configuração do formulário master é definida. | `CustomEvent<IFormConfig>` |
35
+ | Event | Description | Type |
36
+ | ----------------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
37
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
38
+ | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
39
+ | `formConfigVisibilityChanged` | Emitido quando a visibilidade do configurador do formulário é alterada. | `CustomEvent<boolean>` |
40
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
41
+ | `snkMasterFormConfigChange` | Emitido quando a configuração do formulário master é definida. | `CustomEvent<IFormConfig>` |
42
+ | `snkShowGuide` | Emitido quando a uma gua é exibida no formulário. | `CustomEvent<string>` |
40
43
 
41
44
 
42
45
  ## Methods
@@ -113,7 +116,6 @@ Type: `Promise<void>`
113
116
  - [snk-form-view](.)
114
117
  - [snk-data-unit](../../snk-data-unit)
115
118
  - [snk-detail-view](snk-detail-view)
116
- - [snk-taskbar](../../snk-taskbar)
117
119
  - [snk-form-config](../../snk-form-config)
118
120
  - [snk-configurator](../../snk-configurator)
119
121
  - [snk-data-exporter](../../snk-data-exporter)
@@ -127,13 +129,13 @@ graph TD;
127
129
  snk-guides-viewer --> snk-form-view
128
130
  snk-guides-viewer --> snk-data-unit
129
131
  snk-guides-viewer --> snk-detail-view
130
- snk-guides-viewer --> snk-taskbar
131
132
  snk-guides-viewer --> snk-form-config
132
133
  snk-guides-viewer --> snk-configurator
133
134
  snk-guides-viewer --> snk-data-exporter
134
135
  snk-guides-viewer --> snk-actions-button
135
136
  snk-guides-viewer --> taskbar-split-button
136
137
  snk-guides-viewer --> taskbar-actions-button
138
+ snk-form-view --> snk-image-input
137
139
  snk-form-view --> snk-form-summary
138
140
  snk-detail-view --> snk-data-unit
139
141
  snk-detail-view --> snk-grid
@@ -166,13 +168,13 @@ graph TD;
166
168
  snk-expression-item --> snk-filter-param-config
167
169
  snk-filter-modal --> snk-filter-modal-item
168
170
  snk-filter-modal --> snk-default-filter
171
+ snk-taskbar --> snk-taskbar-skeleton
169
172
  snk-taskbar --> snk-data-exporter
170
173
  snk-taskbar --> snk-actions-button
171
174
  snk-taskbar --> taskbar-split-button
172
175
  snk-taskbar --> taskbar-actions-button
173
176
  snk-data-exporter --> snk-exporter-email-sender
174
177
  snk-grid-config --> snk-select-box
175
- snk-attach --> snk-simple-bar
176
178
  snk-attach --> snk-simple-crud
177
179
  snk-simple-crud --> snk-taskbar
178
180
  snk-simple-crud --> snk-data-unit
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -141,14 +141,15 @@ graph TD;
141
141
  snk-expression-item --> snk-filter-param-config
142
142
  snk-filter-modal --> snk-filter-modal-item
143
143
  snk-filter-modal --> snk-default-filter
144
+ snk-taskbar --> snk-taskbar-skeleton
144
145
  snk-taskbar --> snk-data-exporter
145
146
  snk-taskbar --> snk-actions-button
146
147
  snk-taskbar --> taskbar-split-button
147
148
  snk-taskbar --> taskbar-actions-button
148
149
  snk-data-exporter --> snk-exporter-email-sender
149
150
  snk-grid-config --> snk-select-box
151
+ snk-form-view --> snk-image-input
150
152
  snk-form-view --> snk-form-summary
151
- snk-attach --> snk-simple-bar
152
153
  snk-attach --> snk-simple-crud
153
154
  snk-simple-crud --> snk-taskbar
154
155
  snk-simple-crud --> snk-data-unit
package/components/snk-custom-slot-guide/readme.md ADDED
@@ -0,0 +1,24 @@
1
+ # snk-custom-slot-guide
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------- | ----------- | ------------------------------------------------------------- | -------- | --------------------- |
12
+ | `slotName` | `slot-name` | Nome do slot onde os elementos customizados deverão aparecer. | `string` | `'CUSTOM_SLOT_GUIDE'` |
13
+
14
+
15
+ ## Events
16
+
17
+ | Event | Description | Type |
18
+ | -------------------------- | -------------------------------------------- | --------------------- |
19
+ | `snkCustomSlotGuideLoaded` | Emitido quando elemento é carregado na tela. | `CustomEvent<string>` |
20
+
21
+
22
+ ----------------------------------------------
23
+
24
+
package/components/snk-data-exporter/readme.md CHANGED
@@ -7,10 +7,11 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | --------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
13
- | `provider` | -- | Provedor das informações para exportação dos dados. | `IExporterProvider` | `null` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | --------- | -------------------------------------------------------------------------------------- | -------------------------------- | ----------- |
12
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
13
+ | `provider` | -- | Provedor das informações para exportação dos dados. | `IExporterProvider` | `null` |
14
+ | `size` | `size` | Define o tamanho do botão, podendo ser 'small', 'medium' ou 'large'. | `"large" \| "medium" \| "small"` | `'medium'` |
14
15
 
15
16
 
16
17
  ## Dependencies
package/components/snk-filter-bar/filter-item/readme.md CHANGED
@@ -12,6 +12,7 @@
12
12
  | `config` | -- | Define as configurações do componente snk-filter-item. | `SnkFilterItemConfig` | `undefined` |
13
13
  | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
14
14
  | `showChips` | `show-chips` | Usado para controlar a visibilidade dos chips de filtros | `boolean` | `true` |
15
+ | `sizeChips` | `size-chips` | | `"default" \| "large" \| "medium"` | `'default'` |
15
16
 
16
17
 
17
18
  ## Events
package/components/snk-filter-bar/filter-modal/readme.md CHANGED
@@ -7,21 +7,21 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | ----------- |
12
- | `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `(isDefault?: boolean) => 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, isDefault?: boolean) => 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, isDefault?: boolean) => void` | `undefined` |
19
- | `filterConfig` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
20
- | `filterCustomConfigInterceptor` | -- | | `(config: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
21
- | `filterDefaultToDelete` | -- | Guarda o filtro a ser deletado no Apply do modal | `SnkFilterItemConfig` | `undefined` |
22
- | `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
23
- | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
24
- | `opened` | `opened` | Define se o modal está aberto ou não. | `boolean` | `false` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ----------- |
12
+ | `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `(isDefault?: boolean) => 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, isDefault?: boolean) => 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, isDefault?: boolean) => void` | `undefined` |
19
+ | `filterConfig` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
20
+ | `filterCustomConfigInterceptor` | -- | | `(config: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
21
+ | `filterDefaultToDelete` | -- | Guarda o filtro a ser deletado no Apply do modal | `SnkFilterItemConfig` | `undefined` |
22
+ | `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
23
+ | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
24
+ | `opened` | `opened` | Define se o modal está aberto ou não. | `boolean` | `false` |
25
25
 
26
26
 
27
27
  ## Dependencies
package/components/snk-filter-bar/readme.md CHANGED
@@ -20,9 +20,11 @@
20
20
  | `filterConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
21
21
  | `filterCustomConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
22
22
  | `filterCustomConfigInterceptor` | -- | | `(config: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
23
+ | `hideFilterButton` | `hide-filter-button` | | `boolean` | `false` |
23
24
  | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
24
25
  | `mode` | `mode` | | `"button" \| "hidden" \| "regular"` | `"regular"` |
25
26
  | `resourceID` | `resource-i-d` | | `string` | `undefined` |
27
+ | `sizeChips` | `size-chips` | | `"default" \| "large" \| "medium"` | `'default'` |
26
28
  | `title` | `title` | | `string` | `undefined` |
27
29
 
28
30
 
@@ -67,6 +69,8 @@ O item de filtro correspondente ou undefined se não for encontrado.
67
69
 
68
70
  Type: `Promise<Filter[]>`
69
71
 
72
+ Retorna uma Promise que resolve com a lista de filtros ativos.
73
+
70
74
  ---
71
75
 
72
76
  ### `reload() => Promise<void>`
@@ -118,6 +122,7 @@ Retorna uma Promise que resolve quando a atualização for concluída.
118
122
 
119
123
  ### Used by
120
124
 
125
+ - [snk-crud](../snk-crud)
121
126
  - [snk-grid](../snk-grid)
122
127
 
123
128
  ### Depends on
@@ -144,6 +149,7 @@ graph TD;
144
149
  snk-expression-item --> snk-filter-param-config
145
150
  snk-filter-modal --> snk-filter-modal-item
146
151
  snk-filter-modal --> snk-default-filter
152
+ snk-crud --> snk-filter-bar
147
153
  snk-grid --> snk-filter-bar
148
154
  style snk-filter-bar fill:#f9f,stroke:#333,stroke-width:4px
149
155
  ```
package/components/snk-form-config/readme.md CHANGED
@@ -10,6 +10,7 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | -------------------------- | ------------------------------ | -------------------------------------------------------------------------------------- | ---------------------- | ----------- |
12
12
  | `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
13
+ | `customGuidesConfig` | -- | Informações das guias personalizadas. | `CustomGuideItem[]` | `[]` |
13
14
  | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
14
15
  | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
15
16
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
package/components/snk-grid/readme.md CHANGED
@@ -7,45 +7,49 @@
7
7
 
8
8
  ## Properties
9
9
 
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
- | `filterCustomConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
26
- | `filterCustomConfigInterceptor` | -- | | `(config: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
27
- | `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'` |
28
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade. | `string` | `undefined` |
29
- | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe de outra tela. | `boolean` | `undefined` |
30
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
31
- | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultaneamente. | `boolean` | `true` |
32
- | `multipleSelection` | `multiple-selection` | Determina se a seleção de múltiplas linhas é permitida. | `boolean` | `undefined` |
33
- | `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` |
34
- | `paginationCounterMode` | `pagination-counter-mode` | Define o modo de exibição do contador de paginação. | `"auto" \| "hidden" \| "show"` | `'auto'` |
35
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do `snk-taskbar`. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
36
- | `recordsValidator` | -- | Validador responsável por verificar a integridade dos dados de um registro. | `IRecordValidator` | `undefined` |
37
- | `resourceID` | `resource-i-d` | Identificador de recursos, como configurações e permissões de acesso. | `string` | `undefined` |
38
- | `selectionToastConfig` | -- | Configuração do toast de seleção da grade. | `ISelectionToastConfig` | `undefined` |
39
- | `statusResolver` | -- | Define a configuração de cores para a coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
40
- | `strategyExporter` | `strategy-exporter` | Define o modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
41
- | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de checkbox deve ser suprimida. | `boolean` | `undefined` |
42
- | `suppressFilterColumn` | `suppress-filter-column` | Informa se a grade deve suprimir o filtro de coluna. | `boolean` | `false` |
43
- | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir a barra de rolagem horizontal. | `boolean` | `false` |
44
- | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do contêiner de elementos customizados da `Taskbar`. | `string` | `undefined` |
45
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
46
- | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
47
- | `useEnterLikeTab` | `use-enter-like-tab` | Quando `true`, a tecla ENTER navega entre as células como a tecla TAB. | `boolean` | `false` |
48
- | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`. | `boolean` | `true` |
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` | `undefined` |
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
+ | `filterCustomConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
26
+ | `filterCustomConfigInterceptor` | -- | | `(config: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
27
+ | `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'` |
28
+ | `gridHeaderDynamicSearchSlotId` | `grid-header-dynamic-search-slot-id` | Define o nome do slot para a aba de pesquisa no cabeçalho da grade. | `string` | `'GRID_HEADER_DYNAMIC_SEARCH'` |
29
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade. | `string` | `undefined` |
30
+ | `hideGridTaskbar` | `hide-grid-taskbar` | Oculta a barra de tarefas interna da grade. | `boolean` | `false` |
31
+ | `hideHeader` | `hide-header` | Oculta o cabeçalho da grade (filtros e taskbar superior). | `boolean` | `false` |
32
+ | `hidePagination` | `hide-pagination` | Oculta a paginação da grade. | `boolean` | `false` |
33
+ | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe de outra tela. | `boolean` | `undefined` |
34
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
35
+ | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultaneamente. | `boolean` | `true` |
36
+ | `multipleSelection` | `multiple-selection` | Determina se a seleção de múltiplas linhas é permitida. | `boolean` | `undefined` |
37
+ | `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` |
38
+ | `paginationCounterMode` | `pagination-counter-mode` | Define o modo de exibição do contador de paginação. | `"auto" \| "hidden" \| "show"` | `'auto'` |
39
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do `snk-taskbar`. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
40
+ | `recordsValidator` | -- | Validador responsável por verificar a integridade dos dados de um registro. | `IRecordValidator` | `undefined` |
41
+ | `resourceID` | `resource-i-d` | Identificador de recursos, como configurações e permissões de acesso. | `string` | `undefined` |
42
+ | `selectionToastConfig` | -- | Configuração do toast de seleção da grade. | `ISelectionToastConfig` | `undefined` |
43
+ | `statusResolver` | -- | Define a configuração de cores para a coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
44
+ | `strategyExporter` | `strategy-exporter` | Define o modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
45
+ | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de checkbox deve ser suprimida. | `boolean` | `undefined` |
46
+ | `suppressFilterColumn` | `suppress-filter-column` | Informa se a grade deve suprimir o filtro de coluna. | `boolean` | `false` |
47
+ | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir a barra de rolagem horizontal. | `boolean` | `false` |
48
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do contêiner de elementos customizados da `Taskbar`. | `string` | `undefined` |
49
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
50
+ | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
51
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando `true`, a tecla ENTER navega entre as células como a tecla TAB. | `boolean` | `false` |
52
+ | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`. | `boolean` | `true` |
49
53
 
50
54
 
51
55
  ## Events
@@ -95,6 +99,16 @@ Uma promessa que é resolvida quando o renderizador é registrado.
95
99
 
96
100
  ---
97
101
 
102
+ ### `filterColumns(search: string) => Promise<EzGridColumn[]>`
103
+
104
+ Usa um argumento para filtrar as colunas por label
105
+
106
+ #### Returns
107
+
108
+ Type: `Promise<EzGridColumn[]>`
109
+
110
+ ---
111
+
98
112
  ### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
99
113
 
100
114
  Retorna o elemento da barra de filtros da grade.
@@ -107,6 +121,16 @@ O elemento da barra de filtros.
107
121
 
108
122
  ---
109
123
 
124
+ ### `handlePageChange() => Promise<void>`
125
+
126
+ Manipula a mudança de página da grid.
127
+
128
+ #### Returns
129
+
130
+ Type: `Promise<void>`
131
+
132
+ ---
133
+
110
134
  ### `hideConfig() => Promise<void>`
111
135
 
112
136
  Fecha a janela de configurações da grade.
@@ -119,6 +143,16 @@ Uma promessa que é resolvida quando a janela de configuração é fechada.
119
143
 
120
144
  ---
121
145
 
146
+ ### `locateColumn(columnName: string) => Promise<void>`
147
+
148
+ Localiza determinada coluna tornando-a visível.
149
+
150
+ #### Returns
151
+
152
+ Type: `Promise<void>`
153
+
154
+ ---
155
+
122
156
  ### `refreshColumnFilterDataSource() => Promise<void>`
123
157
 
124
158
 
@@ -240,6 +274,7 @@ graph TD;
240
274
  snk-expression-item --> snk-filter-param-config
241
275
  snk-filter-modal --> snk-filter-modal-item
242
276
  snk-filter-modal --> snk-default-filter
277
+ snk-taskbar --> snk-taskbar-skeleton
243
278
  snk-taskbar --> snk-data-exporter
244
279
  snk-taskbar --> snk-actions-button
245
280
  snk-taskbar --> taskbar-split-button
package/components/snk-grid-config/readme.md CHANGED
@@ -7,13 +7,15 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------- | ---------------- | ------------------------------------------------ | ---------------- | ----------- |
12
- | `columns` | -- | Colunas da grade. | `EzGridColumn[]` | `undefined` |
13
- | `config` | -- | Configurações da grade. | `IGridConfig` | `undefined` |
14
- | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
15
- | `resourceID` | `resource-i-d` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
16
- | `selectedIndex` | `selected-index` | Aba selecionada das configurações da grade. | `number` | `0` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ---------------- | ------------------------------------------------ | ---------------- | ----------- |
12
+ | `columns` | -- | Colunas da grade. | `EzGridColumn[]` | `[]` |
13
+ | `config` | -- | Configurações da grade. | `IGridConfig` | `undefined` |
14
+ | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
15
+ | `metadata` | -- | Define a propriedade metadata da instância | `UnitMetadata` | `undefined` |
16
+ | `originalColumns` | -- | Lista de Colunas original. | `EzGridColumn[]` | `[]` |
17
+ | `resourceID` | `resource-i-d` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
18
+ | `selectedIndex` | `selected-index` | Aba selecionada das configurações da grade. | `number` | `0` |
17
19
 
18
20
 
19
21
  ## Events
package/components/snk-image-input/readme.md ADDED
@@ -0,0 +1,56 @@
1
+ # snk-image-input
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------ | ------------- | ----------------------------------------------- | ---------- | ----------- |
12
+ | `acceptType` | `accept-type` | Tipos MIME aceitos (separados por vírgula) | `string` | `undefined` |
13
+ | `dataUnit` | -- | DataUnit associado ao componente | `DataUnit` | `undefined` |
14
+ | `enabled` | `enabled` | Define se está habilitado | `boolean` | `true` |
15
+ | `entityName` | `entity-name` | Nome da entidade (usado quando não há DataUnit) | `string` | `undefined` |
16
+ | `fieldName` | `field-name` | Nome do campo no DataUnit | `string` | `undefined` |
17
+ | `label` | `label` | Label do componente | `string` | `undefined` |
18
+ | `maxSize` | `max-size` | Tamanho máximo do arquivo em KB | `number` | `undefined` |
19
+
20
+
21
+ ## Events
22
+
23
+ | Event | Description | Type |
24
+ | ------------ | ------------------------------- | --------------------- |
25
+ | `imageError` | Evento disparado quando há erro | `CustomEvent<string>` |
26
+
27
+
28
+ ## Methods
29
+
30
+ ### `reloadImage(pks?: Record<string, any>) => Promise<void>`
31
+
32
+ Força o reload da imagem
33
+
34
+ #### Returns
35
+
36
+ Type: `Promise<void>`
37
+
38
+
39
+
40
+
41
+ ## Dependencies
42
+
43
+ ### Used by
44
+
45
+ - [snk-form-view](../snk-crud/subcomponents)
46
+
47
+ ### Graph
48
+ ```mermaid
49
+ graph TD;
50
+ snk-form-view --> snk-image-input
51
+ style snk-image-input fill:#f9f,stroke:#333,stroke-width:4px
52
+ ```
53
+
54
+ ----------------------------------------------
55
+
56
+
package/components/snk-pesquisa/readme.md CHANGED
@@ -18,6 +18,20 @@
18
18
  | `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível. | `(text: string) => Promise<any>` | `undefined` |
19
19
 
20
20
 
21
+ ## Methods
22
+
23
+ ### `executeSearch(text: string) => Promise<void>`
24
+
25
+ * Executa uma pesquisa programaticamente.
26
+ Útil para cenários onde a pesquisa precisa ser disparada sem interação do usuário.
27
+
28
+ #### Returns
29
+
30
+ Type: `Promise<void>`
31
+
32
+
33
+
34
+
21
35
  ## Dependencies
22
36
 
23
37
  ### Used by
package/components/snk-simple-bar/readme.md CHANGED
@@ -26,13 +26,11 @@
26
26
 
27
27
  ### Used by
28
28
 
29
- - [snk-attach](../snk-attach)
30
29
  - [snk-personalized-filter](../snk-personalized-filter)
31
30
 
32
31
  ### Graph
33
32
  ```mermaid
34
33
  graph TD;
35
- snk-attach --> snk-simple-bar
36
34
  snk-personalized-filter --> snk-simple-bar
37
35
  style snk-simple-bar fill:#f9f,stroke:#333,stroke-width:4px
38
36
  ```
package/components/snk-simple-crud/readme.md CHANGED
@@ -7,38 +7,39 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------------- | ----------------------------------- | ----------- | ------------------------------------------------------- | ------------------------- |
12
- | `actionsList` | -- | | `Action[]` | `undefined` |
13
- | `autoFocus` | `auto-focus` | | `boolean` | `true` |
14
- | `autoLoad` | `auto-load` | | `boolean` | `undefined` |
15
- | `configName` | `config-name` | | `string` | `undefined` |
16
- | `dataState` | -- | | `DataState` | `undefined` |
17
- | `dataUnit` | -- | | `DataUnit` | `undefined` |
18
- | `domainMessagesBuilder` | `domain-messages-builder` | | `string` | `undefined` |
19
- | `enableContinuousInsert` | `enable-continuous-insert` | | `boolean` | `false` |
20
- | `enableGridInsert` | `enable-grid-insert` | | `boolean` | `false` |
21
- | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | | `boolean` | `false` |
22
- | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | | `boolean` | `false` |
23
- | `entityName` | `entity-name` | | `string` | `undefined` |
24
- | `formConfig` | -- | | `IFormConfig` | `undefined` |
25
- | `formLegacyConfigName` | `form-legacy-config-name` | | `string` | `undefined` |
26
- | `gridConfig` | -- | | `IGridConfig` | `undefined` |
27
- | `gridLegacyConfigName` | `grid-legacy-config-name` | | `string` | `undefined` |
28
- | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | | `boolean` | `false` |
29
- | `layoutFormConfig` | `layout-form-config` | | `boolean` | `true` |
30
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
31
- | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
32
- | `multipleEditionEnabled` | `multiple-edition-enabled` | | `boolean` | `true` |
33
- | `multipleSelection` | `multiple-selection` | | `boolean` | `undefined` |
34
- | `outlineMode` | `outline-mode` | | `boolean` | `false` |
35
- | `pageSize` | `page-size` | | `number` | `150` |
36
- | `paginationCounterMode` | `pagination-counter-mode` | | `"auto" \| "hidden" \| "show"` | `'auto'` |
37
- | `resourceID` | `resource-i-d` | | `string` | `undefined` |
38
- | `showConfiguratorButtons` | `show-configurator-buttons` | | `boolean` | `false` |
39
- | `taskbarManager` | -- | | `TaskbarManager` | `undefined` |
40
- | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
41
- | `useEnterLikeTab` | `use-enter-like-tab` | | `boolean` | `false` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------------- | ----------------------------------- | ----------------------------- | ------------------------------------------------------- | ------------------------- |
12
+ | `actionsList` | -- | | `Action[]` | `undefined` |
13
+ | `autoFocus` | `auto-focus` | | `boolean` | `true` |
14
+ | `autoLoad` | `auto-load` | | `boolean` | `undefined` |
15
+ | `configName` | `config-name` | | `string` | `undefined` |
16
+ | `dataState` | -- | | `DataState` | `undefined` |
17
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
18
+ | `disableGridEdition` | `disable-grid-edition` | Desabilita a edição na grade. | `boolean` | `false` |
19
+ | `domainMessagesBuilder` | `domain-messages-builder` | | `string` | `undefined` |
20
+ | `enableContinuousInsert` | `enable-continuous-insert` | | `boolean` | `false` |
21
+ | `enableGridInsert` | `enable-grid-insert` | | `boolean` | `false` |
22
+ | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | | `boolean` | `false` |
23
+ | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | | `boolean` | `false` |
24
+ | `entityName` | `entity-name` | | `string` | `undefined` |
25
+ | `formConfig` | -- | | `IFormConfig` | `undefined` |
26
+ | `formLegacyConfigName` | `form-legacy-config-name` | | `string` | `undefined` |
27
+ | `gridConfig` | -- | | `IGridConfig` | `undefined` |
28
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | | `string` | `undefined` |
29
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | | `boolean` | `false` |
30
+ | `layoutFormConfig` | `layout-form-config` | | `boolean` | `true` |
31
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
32
+ | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
33
+ | `multipleEditionEnabled` | `multiple-edition-enabled` | | `boolean` | `true` |
34
+ | `multipleSelection` | `multiple-selection` | | `boolean` | `undefined` |
35
+ | `outlineMode` | `outline-mode` | | `boolean` | `false` |
36
+ | `pageSize` | `page-size` | | `number` | `150` |
37
+ | `paginationCounterMode` | `pagination-counter-mode` | | `"auto" \| "hidden" \| "show"` | `'auto'` |
38
+ | `resourceID` | `resource-i-d` | | `string` | `undefined` |
39
+ | `showConfiguratorButtons` | `show-configurator-buttons` | | `boolean` | `false` |
40
+ | `taskbarManager` | -- | | `TaskbarManager` | `undefined` |
41
+ | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
42
+ | `useEnterLikeTab` | `use-enter-like-tab` | | `boolean` | `false` |
42
43
 
43
44
 
44
45
  ## Events
@@ -208,6 +209,7 @@ graph TD;
208
209
  snk-simple-crud --> snk-actions-button
209
210
  snk-simple-crud --> taskbar-split-button
210
211
  snk-simple-crud --> taskbar-actions-button
212
+ snk-taskbar --> snk-taskbar-skeleton
211
213
  snk-taskbar --> snk-data-exporter
212
214
  snk-taskbar --> snk-actions-button
213
215
  snk-taskbar --> taskbar-split-button
package/components/snk-taskbar/elements/taskbar-actions-button/readme.md CHANGED
@@ -7,11 +7,12 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------- | --------- | ------------------------------------------------------- | ---------- | ----------- |
12
- | `actions` | -- | Define a lista de ações. | `Action[]` | `undefined` |
13
- | `enabled` | `enabled` | Se false o usuário não pode interagir com o componente. | `boolean` | `undefined` |
14
- | `title` | `title` | Texto que será exibido no botão | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------- | --------- | -------------------------------------------------------------------- | -------------------------------- | ----------- |
12
+ | `actions` | -- | Define a lista de ações. | `Action[]` | `undefined` |
13
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o componente. | `boolean` | `undefined` |
14
+ | `size` | `size` | Define o tamanho do botão, podendo ser 'small', 'medium' ou 'large'. | `"large" \| "medium" \| "small"` | `'medium'` |
15
+ | `title` | `title` | Texto que será exibido no botão | `string` | `undefined` |
15
16
 
16
17
 
17
18
  ## Events
package/components/snk-taskbar/elements/taskbar-split-button/readme.md CHANGED
@@ -7,16 +7,17 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------- | ----------------- | -------------------------------------------------------------------------- | ------------------------ | ----------- |
12
- | `action` | -- | Função de callback acionada ao clicar no botão principal. | `(name: string) => void` | `undefined` |
13
- | `actions` | -- | Define a lista de ações disponíveis no dropdown do botão. | `Action[]` | `undefined` |
14
- | `className` | `class-name` | Classe CSS personalizada para estilizar o botão. | `string` | `undefined` |
15
- | `dataElementId` | `data-element-id` | Identificador de elemento para fins de rastreamento e automação de testes. | `string` | `undefined` |
16
- | `enabled` | `enabled` | Se false o usuário não pode interagir com o componente. | `boolean` | `undefined` |
17
- | `iconName` | `icon-name` | Nome do ícone a ser exibido no botão. | `string` | `undefined` |
18
- | `name` | `name` | Nome identificador da ação do botão. | `string` | `undefined` |
19
- | `title` | `title` | Texto que será exibido no botão. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------- | ----------------- | -------------------------------------------------------------------------- | -------------------------------- | ----------- |
12
+ | `action` | -- | Função de callback acionada ao clicar no botão principal. | `(name: string) => void` | `undefined` |
13
+ | `actions` | -- | Define a lista de ações disponíveis no dropdown do botão. | `Action[]` | `undefined` |
14
+ | `className` | `class-name` | Classe CSS personalizada para estilizar o botão. | `string` | `undefined` |
15
+ | `dataElementId` | `data-element-id` | Identificador de elemento para fins de rastreamento e automação de testes. | `string` | `undefined` |
16
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o componente. | `boolean` | `undefined` |
17
+ | `iconName` | `icon-name` | Nome do ícone a ser exibido no botão. | `string` | `undefined` |
18
+ | `name` | `name` | Nome identificador da ação do botão. | `string` | `undefined` |
19
+ | `size` | `size` | Define o tamanho do botão, podendo ser 'small', 'medium' ou 'large'. | `"large" \| "medium" \| "small"` | `'medium'` |
20
+ | `title` | `title` | Texto que será exibido no botão. | `string` | `undefined` |
20
21
 
21
22
 
22
23
  ## Dependencies
package/components/snk-taskbar/readme.md CHANGED
@@ -11,19 +11,23 @@
11
11
  | --------------------- | --------------------- | ----------- | ------------------------------------------------------------------------------------------- | --------------------------- |
12
12
  | `actionsList` | -- | | `Action[]` | `undefined` |
13
13
  | `actionsSettingsList` | -- | | `Action[]` | `undefined` |
14
+ | `additionalSlotId` | `additional-slot-id` | | `string` | `"TASKBAR_ADDITIONAL_SLOT"` |
14
15
  | `alignRigth` | `align-rigth` | | `boolean` | `false` |
15
16
  | `buttons` | `buttons` | | `string` | `undefined` |
16
17
  | `configName` | `config-name` | | `string` | `undefined` |
18
+ | `customActionsList` | -- | | `Action[]` | `undefined` |
17
19
  | `customButtons` | -- | | `Map<string, CustomButton>` | `undefined` |
18
20
  | `customContainerId` | `custom-container-id` | | `string` | `undefined` |
19
21
  | `customSlotId` | `custom-slot-id` | | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
20
22
  | `dataUnit` | -- | | `DataUnit` | `undefined` |
23
+ | `disableSkeleton` | `disable-skeleton` | | `boolean` | `false` |
21
24
  | `disabledButtons` | -- | | `string[]` | `undefined` |
22
25
  | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
23
26
  | `overflowStrategy` | `overflow-strategy` | | `"hiddenItems" \| "none"` | `'hiddenItems'` |
24
27
  | `presentationMode` | `presentation-mode` | | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
25
28
  | `primaryButton` | `primary-button` | | `string` | `undefined` |
26
29
  | `resourceID` | `resource-i-d` | | `string` | `undefined` |
30
+ | `sizeButtons` | `size-buttons` | | `"large" \| "medium" \| "small"` | `'small'` |
27
31
 
28
32
 
29
33
  ## Events
@@ -39,13 +43,14 @@
39
43
 
40
44
  ### Used by
41
45
 
46
+ - [snk-crud](../snk-crud)
42
47
  - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
43
48
  - [snk-grid](../snk-grid)
44
- - [snk-guides-viewer](../snk-crud/subcomponents)
45
49
  - [snk-simple-crud](../snk-simple-crud)
46
50
 
47
51
  ### Depends on
48
52
 
53
+ - [snk-taskbar-skeleton](subcomponents)
49
54
  - [snk-data-exporter](../snk-data-exporter)
50
55
  - [snk-actions-button](../snk-actions-button)
51
56
  - [taskbar-split-button](./elements/taskbar-split-button)
@@ -54,14 +59,15 @@
54
59
  ### Graph
55
60
  ```mermaid
56
61
  graph TD;
62
+ snk-taskbar --> snk-taskbar-skeleton
57
63
  snk-taskbar --> snk-data-exporter
58
64
  snk-taskbar --> snk-actions-button
59
65
  snk-taskbar --> taskbar-split-button
60
66
  snk-taskbar --> taskbar-actions-button
61
67
  snk-data-exporter --> snk-exporter-email-sender
68
+ snk-crud --> snk-taskbar
62
69
  snk-detail-view --> snk-taskbar
63
70
  snk-grid --> snk-taskbar
64
- snk-guides-viewer --> snk-taskbar
65
71
  snk-simple-crud --> snk-taskbar
66
72
  style snk-taskbar fill:#f9f,stroke:#333,stroke-width:4px
67
73
  ```
package/components/snk-taskbar/subcomponents/readme.md ADDED
@@ -0,0 +1,23 @@
1
+ # snk-taskbar-skeleton
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Dependencies
9
+
10
+ ### Used by
11
+
12
+ - [snk-taskbar](..)
13
+
14
+ ### Graph
15
+ ```mermaid
16
+ graph TD;
17
+ snk-taskbar --> snk-taskbar-skeleton
18
+ style snk-taskbar-skeleton fill:#f9f,stroke:#333,stroke-width:4px
19
+ ```
20
+
21
+ ----------------------------------------------
22
+
23
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "10.1.0-rc.2",
3
+ "version": "10.1.0-rc.20",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [