@sankhyalabs/sankhyablocks-docs 0.0.0-bugfix-dev-KB-11997.0 → 0.0.0-bugfix-dev-KB-99999.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.
Files changed (15) hide show
  1. package/components/snk-application/readme.md +59 -6
  2. package/components/snk-attach/readme.md +2 -0
  3. package/components/snk-configurator/readme.md +1 -0
  4. package/components/snk-crud/readme.md +30 -13
  5. package/components/snk-crud/subcomponents/readme.md +32 -16
  6. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +5 -0
  7. package/components/snk-custom-slot-elements/readme.md +17 -0
  8. package/components/snk-filter-bar/filter-modal/readme.md +11 -9
  9. package/components/snk-filter-bar/readme.md +47 -0
  10. package/components/snk-grid/readme.md +43 -20
  11. package/components/snk-personalized-filter/readme.md +5 -4
  12. package/components/snk-simple-crud/readme.md +3 -0
  13. package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +84 -0
  14. package/components/snk-taskbar/readme.md +51 -4
  15. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -7,10 +7,11 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | ------------- | ------------------------------------------------------------ | ------------------- | ----------- |
12
- | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
13
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
12
+ | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
13
+ | `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: Record<string, any>; }) => void` | `undefined` |
14
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
14
15
 
15
16
 
16
17
  ## Events
@@ -33,6 +34,16 @@ Type: `Promise<void>`
33
34
 
34
35
 
35
36
 
37
+ ### `addPendingAction(actionsLocker: string, action: Function) => Promise<void>`
38
+
39
+ Adiciona uma ação pendente que deve ser executada por um determinado locker.
40
+
41
+ #### Returns
42
+
43
+ Type: `Promise<void>`
44
+
45
+
46
+
36
47
  ### `addSearchListener(entityName: string, dataUnit: DataUnit, listener: ISearchListener) => Promise<IRemoveSearchListener>`
37
48
 
38
49
  Adiciona um listener no fetcher de Pesquisa
@@ -138,8 +149,8 @@ Type: `Promise<IOption | IOption[]>`
138
149
 
139
150
  ### `executeSelectDistinct(dataUnit: DataUnit, fieldName: string, argument: string) => Promise<Array<any>>`
140
151
 
141
- Com base em um campo realiza um "select distinct" respeitando os
142
- filtros atuais do dataUnit e um critério de filtro para a própria
152
+ Com base em um campo realiza um "select distinct" respeitando os
153
+ filtros atuais do dataUnit e um critério de filtro para a própria
143
154
  coluna.
144
155
 
145
156
  #### Returns
@@ -258,6 +269,16 @@ Type: `Promise<number>`
258
269
 
259
270
 
260
271
 
272
+ ### `getKeyboardManager() => Promise<KeyboardManager>`
273
+
274
+ Obtém o controlador de teclado.
275
+
276
+ #### Returns
277
+
278
+ Type: `Promise<KeyboardManager>`
279
+
280
+ the keyboard manager
281
+
261
282
  ### `getResourceID() => Promise<string>`
262
283
 
263
284
  Obtém o resourceID da tela em questão.
@@ -348,6 +369,16 @@ Type: `Promise<boolean>`
348
369
 
349
370
 
350
371
 
372
+ ### `isLoadedByPk() => Promise<boolean>`
373
+
374
+ Obtém a informação se o último carregamento do dataunit foi feito através de um loadByPk
375
+
376
+ #### Returns
377
+
378
+ Type: `Promise<boolean>`
379
+
380
+ boolean
381
+
351
382
  ### `isUserSup() => Promise<boolean>`
352
383
 
353
384
  Obtém `true` caso o usuário logado seja o SUP.
@@ -408,6 +439,18 @@ Type: `Promise<any>`
408
439
 
409
440
 
410
441
 
442
+ ### `showAlerts(alerts: Array<AlertItem>) => Promise<void>`
443
+
444
+ Apresenta uma lista de alertas,
445
+ geralmente é utilizado para apresentar resultados
446
+ de processamentos em lote.
447
+
448
+ #### Returns
449
+
450
+ Type: `Promise<void>`
451
+
452
+
453
+
411
454
  ### `showModal(content: HTMLElement) => Promise<void>`
412
455
 
413
456
  Exibe o conteúdo passado em um Modal.
@@ -468,6 +511,16 @@ Type: `Promise<void>`
468
511
 
469
512
 
470
513
 
514
+ ### `whenApplicationReady() => Promise<SnkApplication>`
515
+
516
+ Retorna uma promise que sera resolvida quando o snk-application estiver carregado e registrado no ApplicationContext
517
+
518
+ #### Returns
519
+
520
+ Type: `Promise<SnkApplication>`
521
+
522
+ SnkApplication carregado.
523
+
471
524
 
472
525
  ## Dependencies
473
526
 
package/components/snk-attach/readme.md CHANGED
@@ -42,8 +42,10 @@ graph TD;
42
42
  snk-simple-crud --> snk-taskbar
43
43
  snk-simple-crud --> snk-data-exporter
44
44
  snk-simple-crud --> snk-actions-button
45
+ snk-simple-crud --> taskbar-actions-button
45
46
  snk-taskbar --> snk-data-exporter
46
47
  snk-taskbar --> snk-actions-button
48
+ snk-taskbar --> taskbar-actions-button
47
49
  snk-data-exporter --> snk-exporter-email-sender
48
50
  snk-crud --> snk-attach
49
51
  snk-detail-view --> snk-attach
package/components/snk-configurator/readme.md CHANGED
@@ -10,6 +10,7 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ------------------- | --------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------- |
12
12
  | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
13
+ | `customContainerId` | `custom-container-id` | ID do container que contém os elementos customizados do configurator. | `string` | `undefined` |
13
14
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
14
15
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
15
16
  | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação | `boolean` | `false` |
package/components/snk-crud/readme.md CHANGED
@@ -7,19 +7,19 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ---------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -------------------------- |
12
- | `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
13
- | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
14
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
16
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
17
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
18
- | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
19
- | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
20
- | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
21
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
22
- | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -------------------------- |
12
+ | `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
13
+ | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
14
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
16
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
17
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
18
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
19
+ | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
20
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
21
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
22
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
23
23
 
24
24
 
25
25
  ## Events
@@ -44,6 +44,16 @@ Type: `Promise<void>`
44
44
 
45
45
 
46
46
 
47
+ ### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
48
+
49
+ Retorna o elemento da filter-bar da grade.
50
+
51
+ #### Returns
52
+
53
+ Type: `Promise<HTMLSnkFilterBarElement>`
54
+
55
+
56
+
47
57
  ### `goToView(mode: string) => Promise<void>`
48
58
 
49
59
  Usado para alternar a visão entre GRID e FORM externamente.
@@ -85,6 +95,7 @@ Type: `Promise<void>`
85
95
  - [snk-configurator](../snk-configurator)
86
96
  - [snk-data-exporter](../snk-data-exporter)
87
97
  - [snk-actions-button](../snk-actions-button)
98
+ - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
88
99
 
89
100
  ### Graph
90
101
  ```mermaid
@@ -95,11 +106,13 @@ graph TD;
95
106
  snk-crud --> snk-configurator
96
107
  snk-crud --> snk-data-exporter
97
108
  snk-crud --> snk-actions-button
109
+ snk-crud --> taskbar-actions-button
98
110
  snk-grid --> snk-filter-bar
99
111
  snk-grid --> snk-taskbar
100
112
  snk-grid --> snk-grid-config
101
113
  snk-grid --> snk-data-exporter
102
114
  snk-grid --> snk-actions-button
115
+ snk-grid --> taskbar-actions-button
103
116
  snk-filter-bar --> snk-filter-item
104
117
  snk-filter-bar --> snk-personalized-filter
105
118
  snk-filter-item --> snk-filter-detail
@@ -114,6 +127,7 @@ graph TD;
114
127
  snk-expression-item --> snk-filter-param-config
115
128
  snk-taskbar --> snk-data-exporter
116
129
  snk-taskbar --> snk-actions-button
130
+ snk-taskbar --> taskbar-actions-button
117
131
  snk-data-exporter --> snk-exporter-email-sender
118
132
  snk-grid-config --> snk-select-box
119
133
  snk-guides-viewer --> snk-form-view
@@ -124,6 +138,7 @@ graph TD;
124
138
  snk-guides-viewer --> snk-configurator
125
139
  snk-guides-viewer --> snk-data-exporter
126
140
  snk-guides-viewer --> snk-actions-button
141
+ snk-guides-viewer --> taskbar-actions-button
127
142
  snk-form-view --> snk-form-summary
128
143
  snk-detail-view --> snk-data-unit
129
144
  snk-detail-view --> snk-grid
@@ -132,12 +147,14 @@ graph TD;
132
147
  snk-detail-view --> snk-attach
133
148
  snk-detail-view --> snk-data-exporter
134
149
  snk-detail-view --> snk-actions-button
150
+ snk-detail-view --> taskbar-actions-button
135
151
  snk-attach --> snk-simple-bar
136
152
  snk-attach --> snk-simple-crud
137
153
  snk-simple-crud --> snk-data-unit
138
154
  snk-simple-crud --> snk-taskbar
139
155
  snk-simple-crud --> snk-data-exporter
140
156
  snk-simple-crud --> snk-actions-button
157
+ snk-simple-crud --> taskbar-actions-button
141
158
  snk-form-config --> snk-field-config
142
159
  snk-form-config --> snk-config-options
143
160
  snk-form-config --> snk-tab-config
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -7,22 +7,22 @@
7
7
 
8
8
  ## Properties
9
9
 
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
- | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
- | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
15
- | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
16
- | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
17
- | `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
18
- | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
19
- | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
20
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `undefined` |
22
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
23
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
24
- | `selectedGuide` | -- | Guia selecionada. | `IGuideItem` | `undefined` |
25
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
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
+ | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
+ | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
15
+ | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
16
+ | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
17
+ | `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
18
+ | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
19
+ | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
20
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
22
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
23
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
24
+ | `selectedGuide` | -- | Guia selecionada. | `IGuideItem` | `undefined` |
25
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
26
26
 
27
27
 
28
28
  ## Events
@@ -36,6 +36,16 @@
36
36
 
37
37
  ## Methods
38
38
 
39
+ ### `findField() => Promise<void>`
40
+
41
+ Abre o localizador de campos
42
+
43
+ #### Returns
44
+
45
+ Type: `Promise<void>`
46
+
47
+
48
+
39
49
  ### `showFormConfig(detail?: boolean) => Promise<void>`
40
50
 
41
51
  Abre o configurador do formulário
@@ -63,6 +73,7 @@ Type: `Promise<void>`
63
73
  - [snk-configurator](../../snk-configurator)
64
74
  - [snk-data-exporter](../../snk-data-exporter)
65
75
  - [snk-actions-button](../../snk-actions-button)
76
+ - [taskbar-actions-button](../../snk-taskbar/elements/taskbar-actions-button)
66
77
 
67
78
  ### Graph
68
79
  ```mermaid
@@ -75,6 +86,7 @@ graph TD;
75
86
  snk-guides-viewer --> snk-configurator
76
87
  snk-guides-viewer --> snk-data-exporter
77
88
  snk-guides-viewer --> snk-actions-button
89
+ snk-guides-viewer --> taskbar-actions-button
78
90
  snk-form-view --> snk-form-summary
79
91
  snk-detail-view --> snk-data-unit
80
92
  snk-detail-view --> snk-grid
@@ -83,11 +95,13 @@ graph TD;
83
95
  snk-detail-view --> snk-attach
84
96
  snk-detail-view --> snk-data-exporter
85
97
  snk-detail-view --> snk-actions-button
98
+ snk-detail-view --> taskbar-actions-button
86
99
  snk-grid --> snk-filter-bar
87
100
  snk-grid --> snk-taskbar
88
101
  snk-grid --> snk-grid-config
89
102
  snk-grid --> snk-data-exporter
90
103
  snk-grid --> snk-actions-button
104
+ snk-grid --> taskbar-actions-button
91
105
  snk-filter-bar --> snk-filter-item
92
106
  snk-filter-bar --> snk-personalized-filter
93
107
  snk-filter-item --> snk-filter-detail
@@ -102,6 +116,7 @@ graph TD;
102
116
  snk-expression-item --> snk-filter-param-config
103
117
  snk-taskbar --> snk-data-exporter
104
118
  snk-taskbar --> snk-actions-button
119
+ snk-taskbar --> taskbar-actions-button
105
120
  snk-data-exporter --> snk-exporter-email-sender
106
121
  snk-grid-config --> snk-select-box
107
122
  snk-attach --> snk-simple-bar
@@ -110,6 +125,7 @@ graph TD;
110
125
  snk-simple-crud --> snk-taskbar
111
126
  snk-simple-crud --> snk-data-exporter
112
127
  snk-simple-crud --> snk-actions-button
128
+ snk-simple-crud --> taskbar-actions-button
113
129
  snk-form-config --> snk-field-config
114
130
  snk-form-config --> snk-config-options
115
131
  snk-form-config --> snk-tab-config
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -81,6 +81,7 @@ Type: `Promise<void>`
81
81
  - [snk-attach](../../../snk-attach)
82
82
  - [snk-data-exporter](../../../snk-data-exporter)
83
83
  - [snk-actions-button](../../../snk-actions-button)
84
+ - [taskbar-actions-button](../../../snk-taskbar/elements/taskbar-actions-button)
84
85
 
85
86
  ### Graph
86
87
  ```mermaid
@@ -92,11 +93,13 @@ graph TD;
92
93
  snk-detail-view --> snk-attach
93
94
  snk-detail-view --> snk-data-exporter
94
95
  snk-detail-view --> snk-actions-button
96
+ snk-detail-view --> taskbar-actions-button
95
97
  snk-grid --> snk-filter-bar
96
98
  snk-grid --> snk-taskbar
97
99
  snk-grid --> snk-grid-config
98
100
  snk-grid --> snk-data-exporter
99
101
  snk-grid --> snk-actions-button
102
+ snk-grid --> taskbar-actions-button
100
103
  snk-filter-bar --> snk-filter-item
101
104
  snk-filter-bar --> snk-personalized-filter
102
105
  snk-filter-item --> snk-filter-detail
@@ -111,6 +114,7 @@ graph TD;
111
114
  snk-expression-item --> snk-filter-param-config
112
115
  snk-taskbar --> snk-data-exporter
113
116
  snk-taskbar --> snk-actions-button
117
+ snk-taskbar --> taskbar-actions-button
114
118
  snk-data-exporter --> snk-exporter-email-sender
115
119
  snk-grid-config --> snk-select-box
116
120
  snk-form-view --> snk-form-summary
@@ -120,6 +124,7 @@ graph TD;
120
124
  snk-simple-crud --> snk-taskbar
121
125
  snk-simple-crud --> snk-data-exporter
122
126
  snk-simple-crud --> snk-actions-button
127
+ snk-simple-crud --> taskbar-actions-button
123
128
  snk-guides-viewer --> snk-detail-view
124
129
  style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
125
130
  ```
package/components/snk-custom-slot-elements/readme.md ADDED
@@ -0,0 +1,17 @@
1
+ # snk-custom-slot-elements
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_ELEMENTS'` |
13
+
14
+
15
+ ----------------------------------------------
16
+
17
+
package/components/snk-filter-bar/filter-modal/readme.md CHANGED
@@ -7,15 +7,17 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------ | ------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------ | ----------- |
12
- | `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `() => void` | `undefined` |
13
- | `applyFilters` | -- | Ação executada ao aplicar os filtros | `(updatedFilterConfig: SnkFilterItemConfig[]) => void` | `undefined` |
14
- | `closeModal` | -- | Ação disparada ao fechar o modal | `() => void` | `undefined` |
15
- | `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
16
- | `editPersonalizedFilter` | -- | Ação executada ao editart um filtro personalizado | `(id: string) => void` | `undefined` |
17
- | `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
18
- | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------------- | ------------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------- | ----------- |
12
+ | `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `() => void` | `undefined` |
13
+ | `applyFilters` | -- | Ação executada ao aplicar os filtros | `(updatedFilterConfig: SnkFilterItemConfig[]) => void` | `undefined` |
14
+ | `closeModal` | -- | Ação disparada ao fechar o modal | `() => void` | `undefined` |
15
+ | `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
16
+ | `deletePersonalizedFilter` | -- | Ação executada ao deletar um filtro personalizado | `(filter: IPersonalizedFilter, configName: string) => void` | `undefined` |
17
+ | `editPersonalizedFilter` | -- | Ação executada ao editar um filtro personalizado | `(id: string) => void` | `undefined` |
18
+ | `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
19
+ | `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
20
+ | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
19
21
 
20
22
 
21
23
  ## Dependencies
package/components/snk-filter-bar/readme.md CHANGED
@@ -16,8 +16,35 @@
16
16
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
17
17
 
18
18
 
19
+ ## Events
20
+
21
+ | Event | Description | Type |
22
+ | --------------- | ----------- | ------------------------------------ |
23
+ | `configUpdated` | | `CustomEvent<SnkFilterItemConfig[]>` |
24
+
25
+
19
26
  ## Methods
20
27
 
28
+ ### `addFilterItem(filterItem: SnkFilterItemConfig) => Promise<void>`
29
+
30
+ Adiciona um item de filtro.
31
+
32
+ #### Returns
33
+
34
+ Type: `Promise<void>`
35
+
36
+
37
+
38
+ ### `getFilterItem(id: string) => Promise<SnkFilterItemConfig | undefined>`
39
+
40
+ Retorna um item de filtro pelo ID.
41
+
42
+ #### Returns
43
+
44
+ Type: `Promise<SnkFilterItemConfig>`
45
+
46
+
47
+
21
48
  ### `reload() => Promise<void>`
22
49
 
23
50
  Faz o recarregamento da filterbar buscando o state no servidor.
@@ -28,6 +55,26 @@ Type: `Promise<void>`
28
55
 
29
56
 
30
57
 
58
+ ### `removeFilterItem(filterID: string) => Promise<SnkFilterItemConfig | undefined>`
59
+
60
+ Remove um item de filtro.
61
+
62
+ #### Returns
63
+
64
+ Type: `Promise<SnkFilterItemConfig>`
65
+
66
+ - Retorna o item de filtro removido, ou undefined caso não encontrado.
67
+
68
+ ### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
69
+
70
+ Atualiza um item do filtro.
71
+
72
+ #### Returns
73
+
74
+ Type: `Promise<void>`
75
+
76
+
77
+
31
78
 
32
79
  ## Dependencies
33
80
 
package/components/snk-grid/readme.md CHANGED
@@ -7,25 +7,25 @@
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 componente snk-taskbar. | `Action[]` | `undefined` |
13
- | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
- | `columnFilterDataSource` | -- | | `SnkMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
15
- | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
16
- | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
17
- | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
18
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
19
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
20
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
21
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
22
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
23
- | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
24
- | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
25
- | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
26
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
27
- | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
28
- | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------- |
12
+ | `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
13
+ | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
+ | `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
15
+ | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
16
+ | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
17
+ | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
18
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
19
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
20
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
21
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
22
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
23
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
24
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
25
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
26
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
27
+ | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
28
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
29
29
 
30
30
 
31
31
  ## Events
@@ -33,11 +33,31 @@
33
33
  | Event | Description | Type |
34
34
  | ----------------- | ------------------------------------------------- | --------------------- |
35
35
  | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
36
- | `gridDoubleClick` | Emitido sempre que houver duplo click na grade. | `CustomEvent<void>` |
36
+ | `gridDoubleClick` | Emitido sempre que houver duplo click na grade. | `CustomEvent<any>` |
37
37
 
38
38
 
39
39
  ## Methods
40
40
 
41
+ ### `findColumn() => Promise<void>`
42
+
43
+ Abre o localizador de colunas
44
+
45
+ #### Returns
46
+
47
+ Type: `Promise<void>`
48
+
49
+
50
+
51
+ ### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
52
+
53
+ Retorna o elemento da filter-bar da grade.
54
+
55
+ #### Returns
56
+
57
+ Type: `Promise<HTMLSnkFilterBarElement>`
58
+
59
+
60
+
41
61
  ### `hideConfig() => Promise<void>`
42
62
 
43
63
  Fecha a janela de configurações da grade.
@@ -93,6 +113,7 @@ Type: `Promise<void>`
93
113
  - [snk-grid-config](./subcomponents/snk-grid-config)
94
114
  - [snk-data-exporter](../snk-data-exporter)
95
115
  - [snk-actions-button](../snk-actions-button)
116
+ - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
96
117
 
97
118
  ### Graph
98
119
  ```mermaid
@@ -102,6 +123,7 @@ graph TD;
102
123
  snk-grid --> snk-grid-config
103
124
  snk-grid --> snk-data-exporter
104
125
  snk-grid --> snk-actions-button
126
+ snk-grid --> taskbar-actions-button
105
127
  snk-filter-bar --> snk-filter-item
106
128
  snk-filter-bar --> snk-personalized-filter
107
129
  snk-filter-item --> snk-filter-detail
@@ -116,6 +138,7 @@ graph TD;
116
138
  snk-expression-item --> snk-filter-param-config
117
139
  snk-taskbar --> snk-data-exporter
118
140
  snk-taskbar --> snk-actions-button
141
+ snk-taskbar --> taskbar-actions-button
119
142
  snk-data-exporter --> snk-exporter-email-sender
120
143
  snk-grid-config --> snk-select-box
121
144
  snk-crud --> snk-grid
package/components/snk-personalized-filter/readme.md CHANGED
@@ -18,10 +18,11 @@
18
18
 
19
19
  ## Events
20
20
 
21
- | Event | Description | Type |
22
- | ---------- | ----------- | --------------------- |
23
- | `ezCancel` | | `CustomEvent<void>` |
24
- | `ezSave` | | `CustomEvent<string>` |
21
+ | Event | Description | Type |
22
+ | ------------- | ----------- | --------------------- |
23
+ | `ezAfterSave` | | `CustomEvent<void>` |
24
+ | `ezCancel` | | `CustomEvent<void>` |
25
+ | `ezSave` | | `CustomEvent<string>` |
25
26
 
26
27
 
27
28
  ## Methods
package/components/snk-simple-crud/readme.md CHANGED
@@ -86,6 +86,7 @@ Type: `Promise<void>`
86
86
  - [snk-taskbar](../snk-taskbar)
87
87
  - [snk-data-exporter](../snk-data-exporter)
88
88
  - [snk-actions-button](../snk-actions-button)
89
+ - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
89
90
 
90
91
  ### Graph
91
92
  ```mermaid
@@ -94,8 +95,10 @@ graph TD;
94
95
  snk-simple-crud --> snk-taskbar
95
96
  snk-simple-crud --> snk-data-exporter
96
97
  snk-simple-crud --> snk-actions-button
98
+ snk-simple-crud --> taskbar-actions-button
97
99
  snk-taskbar --> snk-data-exporter
98
100
  snk-taskbar --> snk-actions-button
101
+ snk-taskbar --> taskbar-actions-button
99
102
  snk-data-exporter --> snk-exporter-email-sender
100
103
  snk-attach --> snk-simple-crud
101
104
  style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
package/components/snk-taskbar/elements/taskbar-actions-button/readme.md ADDED
@@ -0,0 +1,84 @@
1
+ # taskbar-actions-button
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
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` |
15
+
16
+
17
+ ## Events
18
+
19
+ | Event | Description | Type |
20
+ | ---------------------------------- | ----------------------------------------------- | -------------------------- |
21
+ | `taskbarActionsButtonDisconnected` | Emitido quando componente é desconectado da DOM | `CustomEvent<void>` |
22
+ | `taskbarActionSelected` | Emitido ao selecionar uma ação | `CustomEvent<Action>` |
23
+ | `taskbarActionsOpened` | Emitido ao mostrar a lista de ações | `CustomEvent<HTMLElement>` |
24
+
25
+
26
+ ## Methods
27
+
28
+ ### `hideActions() => Promise<void>`
29
+
30
+ Esaconde a lista de ações.
31
+
32
+ #### Returns
33
+
34
+ Type: `Promise<void>`
35
+
36
+
37
+
38
+ ### `isOpened() => Promise<boolean>`
39
+
40
+ Informa se a lista de ações está aberta.
41
+
42
+ #### Returns
43
+
44
+ Type: `Promise<boolean>`
45
+
46
+
47
+
48
+ ### `showActions() => Promise<void>`
49
+
50
+ Exibe a lista de ações.
51
+
52
+ #### Returns
53
+
54
+ Type: `Promise<void>`
55
+
56
+
57
+
58
+
59
+ ## Dependencies
60
+
61
+ ### Used by
62
+
63
+ - [snk-crud](../../../snk-crud)
64
+ - [snk-detail-view](../../../snk-crud/subcomponents/snk-detail-view)
65
+ - [snk-grid](../../../snk-grid)
66
+ - [snk-guides-viewer](../../../snk-crud/subcomponents)
67
+ - [snk-simple-crud](../../../snk-simple-crud)
68
+ - [snk-taskbar](../..)
69
+
70
+ ### Graph
71
+ ```mermaid
72
+ graph TD;
73
+ snk-crud --> taskbar-actions-button
74
+ snk-detail-view --> taskbar-actions-button
75
+ snk-grid --> taskbar-actions-button
76
+ snk-guides-viewer --> taskbar-actions-button
77
+ snk-simple-crud --> taskbar-actions-button
78
+ snk-taskbar --> taskbar-actions-button
79
+ style taskbar-actions-button fill:#f9f,stroke:#333,stroke-width:4px
80
+ ```
81
+
82
+ ----------------------------------------------
83
+
84
+
package/components/snk-taskbar/readme.md CHANGED
@@ -1,4 +1,4 @@
1
- # snk-taskbar-custom-elements
1
+ # snk-taskbar
2
2
 
3
3
 
4
4
 
@@ -7,11 +7,58 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------- | --------- | ------------------------------------------------------------------------ | -------- | --------------------------- |
12
- | `slot` | `slot` | Nome do slot da Taskbar onde os elementos customizados deverão aparecer. | `string` | `'TASKBAR_CUSTOM_ELEMENTS'` |
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
+ | `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
14
+ | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
15
+ | `customButtons` | -- | Mapa com definição de botões personalizados. A chave do mapa deve ser passada na lista "buttons" no lugar onde o botão irá aparecer. | `Map<string, CustomButton>` | `undefined` |
16
+ | `customContainerId` | `custom-container-id` | Usado para determinar o identificador do container na DOM que é responsavel por guardar os elementos personalizados que não podem ser passados por slot. Exemplo: Elementos customizados na Taskbar da aba de detalhes. | `string` | `undefined` |
17
+ | `customSlotId` | `custom-slot-id` | Usado para determinar o identificador do slot que recebe elementos personalizados. | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
18
+ | `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
19
+ | `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
20
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
22
+ | `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
23
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
13
24
 
14
25
 
26
+ ## Events
27
+
28
+ | Event | Description | Type |
29
+ | ------------- | ------------------------------------------------- | --------------------- |
30
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
31
+
32
+
33
+ ## Dependencies
34
+
35
+ ### Used by
36
+
37
+ - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
38
+ - [snk-grid](../snk-grid)
39
+ - [snk-guides-viewer](../snk-crud/subcomponents)
40
+ - [snk-simple-crud](../snk-simple-crud)
41
+
42
+ ### Depends on
43
+
44
+ - [snk-data-exporter](../snk-data-exporter)
45
+ - [snk-actions-button](../snk-actions-button)
46
+ - [taskbar-actions-button](./elements/taskbar-actions-button)
47
+
48
+ ### Graph
49
+ ```mermaid
50
+ graph TD;
51
+ snk-taskbar --> snk-data-exporter
52
+ snk-taskbar --> snk-actions-button
53
+ snk-taskbar --> taskbar-actions-button
54
+ snk-data-exporter --> snk-exporter-email-sender
55
+ snk-detail-view --> snk-taskbar
56
+ snk-grid --> snk-taskbar
57
+ snk-guides-viewer --> snk-taskbar
58
+ snk-simple-crud --> snk-taskbar
59
+ style snk-taskbar fill:#f9f,stroke:#333,stroke-width:4px
60
+ ```
61
+
15
62
  ----------------------------------------------
16
63
 
17
64
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "0.0.0-bugfix-dev-KB-11997.0",
3
+ "version": "0.0.0-bugfix-dev-KB-99999.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [