@sankhyalabs/sankhyablocks-docs 8.16.0-dev.110 → 8.16.0-dev.111

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/components/snk-attach/readme.md +2 -0
  2. package/components/snk-crud/readme.md +7 -0
  3. package/components/snk-crud/subcomponents/readme.md +6 -10
  4. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +5 -0
  5. package/components/snk-grid/readme.md +4 -10
  6. package/components/snk-simple-crud/readme.md +4 -1
  7. package/components/snk-taskbar/elements/taskbar-split-button/readme.md +47 -0
  8. package/components/snk-taskbar/readme.md +19 -16
  9. package/package.json +1 -1
package/components/snk-attach/readme.md CHANGED
@@ -49,9 +49,11 @@ graph TD;
49
49
  snk-simple-crud --> snk-grid-config
50
50
  snk-simple-crud --> snk-data-exporter
51
51
  snk-simple-crud --> snk-actions-button
52
+ snk-simple-crud --> taskbar-split-button
52
53
  snk-simple-crud --> taskbar-actions-button
53
54
  snk-taskbar --> snk-data-exporter
54
55
  snk-taskbar --> snk-actions-button
56
+ snk-taskbar --> taskbar-split-button
55
57
  snk-taskbar --> taskbar-actions-button
56
58
  snk-data-exporter --> snk-exporter-email-sender
57
59
  snk-configurator --> snk-layout-form-config
package/components/snk-crud/readme.md CHANGED
@@ -162,6 +162,7 @@ Type: `Promise<void>`
162
162
  - [snk-configurator](../snk-configurator)
163
163
  - [snk-data-exporter](../snk-data-exporter)
164
164
  - [snk-actions-button](../snk-actions-button)
165
+ - [taskbar-split-button](../snk-taskbar/elements/taskbar-split-button)
165
166
  - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
166
167
 
167
168
  ### Graph
@@ -173,12 +174,14 @@ graph TD;
173
174
  snk-crud --> snk-configurator
174
175
  snk-crud --> snk-data-exporter
175
176
  snk-crud --> snk-actions-button
177
+ snk-crud --> taskbar-split-button
176
178
  snk-crud --> taskbar-actions-button
177
179
  snk-grid --> snk-filter-bar
178
180
  snk-grid --> snk-taskbar
179
181
  snk-grid --> snk-grid-config
180
182
  snk-grid --> snk-data-exporter
181
183
  snk-grid --> snk-actions-button
184
+ snk-grid --> taskbar-split-button
182
185
  snk-grid --> taskbar-actions-button
183
186
  snk-filter-bar --> snk-filter-item
184
187
  snk-filter-bar --> snk-personalized-filter
@@ -194,6 +197,7 @@ graph TD;
194
197
  snk-expression-item --> snk-filter-param-config
195
198
  snk-taskbar --> snk-data-exporter
196
199
  snk-taskbar --> snk-actions-button
200
+ snk-taskbar --> taskbar-split-button
197
201
  snk-taskbar --> taskbar-actions-button
198
202
  snk-data-exporter --> snk-exporter-email-sender
199
203
  snk-grid-config --> snk-select-box
@@ -205,6 +209,7 @@ graph TD;
205
209
  snk-guides-viewer --> snk-configurator
206
210
  snk-guides-viewer --> snk-data-exporter
207
211
  snk-guides-viewer --> snk-actions-button
212
+ snk-guides-viewer --> taskbar-split-button
208
213
  snk-guides-viewer --> taskbar-actions-button
209
214
  snk-form-view --> snk-form-summary
210
215
  snk-detail-view --> snk-data-unit
@@ -214,6 +219,7 @@ graph TD;
214
219
  snk-detail-view --> snk-attach
215
220
  snk-detail-view --> snk-data-exporter
216
221
  snk-detail-view --> snk-actions-button
222
+ snk-detail-view --> taskbar-split-button
217
223
  snk-detail-view --> taskbar-actions-button
218
224
  snk-attach --> snk-simple-bar
219
225
  snk-attach --> snk-simple-crud
@@ -224,6 +230,7 @@ graph TD;
224
230
  snk-simple-crud --> snk-grid-config
225
231
  snk-simple-crud --> snk-data-exporter
226
232
  snk-simple-crud --> snk-actions-button
233
+ snk-simple-crud --> taskbar-split-button
227
234
  snk-simple-crud --> taskbar-actions-button
228
235
  snk-configurator --> snk-layout-form-config
229
236
  snk-layout-form-config --> snk-view-representation
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -61,16 +61,6 @@ Type: `Promise<void>`
61
61
 
62
62
 
63
63
 
64
- ### `findField() => Promise<void>`
65
-
66
- Abre o localizador de campos
67
-
68
- #### Returns
69
-
70
- Type: `Promise<void>`
71
-
72
-
73
-
74
64
  ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
75
65
 
76
66
  Altera/adiciona uma propriedade nos metadados do campo.
@@ -118,6 +108,7 @@ Type: `Promise<void>`
118
108
  - [snk-configurator](../../snk-configurator)
119
109
  - [snk-data-exporter](../../snk-data-exporter)
120
110
  - [snk-actions-button](../../snk-actions-button)
111
+ - [taskbar-split-button](../../snk-taskbar/elements/taskbar-split-button)
121
112
  - [taskbar-actions-button](../../snk-taskbar/elements/taskbar-actions-button)
122
113
 
123
114
  ### Graph
@@ -131,6 +122,7 @@ graph TD;
131
122
  snk-guides-viewer --> snk-configurator
132
123
  snk-guides-viewer --> snk-data-exporter
133
124
  snk-guides-viewer --> snk-actions-button
125
+ snk-guides-viewer --> taskbar-split-button
134
126
  snk-guides-viewer --> taskbar-actions-button
135
127
  snk-form-view --> snk-form-summary
136
128
  snk-detail-view --> snk-data-unit
@@ -140,12 +132,14 @@ graph TD;
140
132
  snk-detail-view --> snk-attach
141
133
  snk-detail-view --> snk-data-exporter
142
134
  snk-detail-view --> snk-actions-button
135
+ snk-detail-view --> taskbar-split-button
143
136
  snk-detail-view --> taskbar-actions-button
144
137
  snk-grid --> snk-filter-bar
145
138
  snk-grid --> snk-taskbar
146
139
  snk-grid --> snk-grid-config
147
140
  snk-grid --> snk-data-exporter
148
141
  snk-grid --> snk-actions-button
142
+ snk-grid --> taskbar-split-button
149
143
  snk-grid --> taskbar-actions-button
150
144
  snk-filter-bar --> snk-filter-item
151
145
  snk-filter-bar --> snk-personalized-filter
@@ -161,6 +155,7 @@ graph TD;
161
155
  snk-expression-item --> snk-filter-param-config
162
156
  snk-taskbar --> snk-data-exporter
163
157
  snk-taskbar --> snk-actions-button
158
+ snk-taskbar --> taskbar-split-button
164
159
  snk-taskbar --> taskbar-actions-button
165
160
  snk-data-exporter --> snk-exporter-email-sender
166
161
  snk-grid-config --> snk-select-box
@@ -173,6 +168,7 @@ graph TD;
173
168
  snk-simple-crud --> snk-grid-config
174
169
  snk-simple-crud --> snk-data-exporter
175
170
  snk-simple-crud --> snk-actions-button
171
+ snk-simple-crud --> taskbar-split-button
176
172
  snk-simple-crud --> taskbar-actions-button
177
173
  snk-configurator --> snk-layout-form-config
178
174
  snk-layout-form-config --> snk-view-representation
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -104,6 +104,7 @@ Type: `Promise<void>`
104
104
  - [snk-attach](../../../snk-attach)
105
105
  - [snk-data-exporter](../../../snk-data-exporter)
106
106
  - [snk-actions-button](../../../snk-actions-button)
107
+ - [taskbar-split-button](../../../snk-taskbar/elements/taskbar-split-button)
107
108
  - [taskbar-actions-button](../../../snk-taskbar/elements/taskbar-actions-button)
108
109
 
109
110
  ### Graph
@@ -116,12 +117,14 @@ graph TD;
116
117
  snk-detail-view --> snk-attach
117
118
  snk-detail-view --> snk-data-exporter
118
119
  snk-detail-view --> snk-actions-button
120
+ snk-detail-view --> taskbar-split-button
119
121
  snk-detail-view --> taskbar-actions-button
120
122
  snk-grid --> snk-filter-bar
121
123
  snk-grid --> snk-taskbar
122
124
  snk-grid --> snk-grid-config
123
125
  snk-grid --> snk-data-exporter
124
126
  snk-grid --> snk-actions-button
127
+ snk-grid --> taskbar-split-button
125
128
  snk-grid --> taskbar-actions-button
126
129
  snk-filter-bar --> snk-filter-item
127
130
  snk-filter-bar --> snk-personalized-filter
@@ -137,6 +140,7 @@ graph TD;
137
140
  snk-expression-item --> snk-filter-param-config
138
141
  snk-taskbar --> snk-data-exporter
139
142
  snk-taskbar --> snk-actions-button
143
+ snk-taskbar --> taskbar-split-button
140
144
  snk-taskbar --> taskbar-actions-button
141
145
  snk-data-exporter --> snk-exporter-email-sender
142
146
  snk-grid-config --> snk-select-box
@@ -150,6 +154,7 @@ graph TD;
150
154
  snk-simple-crud --> snk-grid-config
151
155
  snk-simple-crud --> snk-data-exporter
152
156
  snk-simple-crud --> snk-actions-button
157
+ snk-simple-crud --> taskbar-split-button
153
158
  snk-simple-crud --> taskbar-actions-button
154
159
  snk-configurator --> snk-layout-form-config
155
160
  snk-layout-form-config --> snk-view-representation
package/components/snk-grid/readme.md CHANGED
@@ -38,6 +38,7 @@
38
38
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
39
39
  | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
40
40
  | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
41
+ | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F | `boolean` | `true` |
41
42
 
42
43
 
43
44
  ## Events
@@ -80,16 +81,6 @@ Type: `Promise<void>`
80
81
 
81
82
 
82
83
 
83
- ### `findColumn() => Promise<void>`
84
-
85
- Abre o localizador de colunas
86
-
87
- #### Returns
88
-
89
- Type: `Promise<void>`
90
-
91
-
92
-
93
84
  ### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
94
85
 
95
86
  Retorna o elemento da filter-bar da grade.
@@ -185,6 +176,7 @@ Type: `Promise<void>`
185
176
  - [snk-grid-config](../snk-grid-config)
186
177
  - [snk-data-exporter](../snk-data-exporter)
187
178
  - [snk-actions-button](../snk-actions-button)
179
+ - [taskbar-split-button](../snk-taskbar/elements/taskbar-split-button)
188
180
  - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
189
181
 
190
182
  ### Graph
@@ -195,6 +187,7 @@ graph TD;
195
187
  snk-grid --> snk-grid-config
196
188
  snk-grid --> snk-data-exporter
197
189
  snk-grid --> snk-actions-button
190
+ snk-grid --> taskbar-split-button
198
191
  snk-grid --> taskbar-actions-button
199
192
  snk-filter-bar --> snk-filter-item
200
193
  snk-filter-bar --> snk-personalized-filter
@@ -210,6 +203,7 @@ graph TD;
210
203
  snk-expression-item --> snk-filter-param-config
211
204
  snk-taskbar --> snk-data-exporter
212
205
  snk-taskbar --> snk-actions-button
206
+ snk-taskbar --> taskbar-split-button
213
207
  snk-taskbar --> taskbar-actions-button
214
208
  snk-data-exporter --> snk-exporter-email-sender
215
209
  snk-grid-config --> snk-select-box
package/components/snk-simple-crud/readme.md CHANGED
@@ -34,7 +34,7 @@
34
34
  | `outlineMode` | `outline-mode` | Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up) | `boolean` | `false` |
35
35
  | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
36
36
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
37
- | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
37
+ | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `false` |
38
38
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
39
39
  | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
40
40
  | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
@@ -190,6 +190,7 @@ Type: `Promise<void>`
190
190
  - [snk-grid-config](../snk-grid-config)
191
191
  - [snk-data-exporter](../snk-data-exporter)
192
192
  - [snk-actions-button](../snk-actions-button)
193
+ - [taskbar-split-button](../snk-taskbar/elements/taskbar-split-button)
193
194
  - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
194
195
 
195
196
  ### Graph
@@ -202,9 +203,11 @@ graph TD;
202
203
  snk-simple-crud --> snk-grid-config
203
204
  snk-simple-crud --> snk-data-exporter
204
205
  snk-simple-crud --> snk-actions-button
206
+ snk-simple-crud --> taskbar-split-button
205
207
  snk-simple-crud --> taskbar-actions-button
206
208
  snk-taskbar --> snk-data-exporter
207
209
  snk-taskbar --> snk-actions-button
210
+ snk-taskbar --> taskbar-split-button
208
211
  snk-taskbar --> taskbar-actions-button
209
212
  snk-data-exporter --> snk-exporter-email-sender
210
213
  snk-configurator --> snk-layout-form-config
package/components/snk-taskbar/elements/taskbar-split-button/readme.md ADDED
@@ -0,0 +1,47 @@
1
+ # taskbar-split-button
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
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` |
20
+
21
+
22
+ ## Dependencies
23
+
24
+ ### Used by
25
+
26
+ - [snk-crud](../../../snk-crud)
27
+ - [snk-detail-view](../../../snk-crud/subcomponents/snk-detail-view)
28
+ - [snk-grid](../../../snk-grid)
29
+ - [snk-guides-viewer](../../../snk-crud/subcomponents)
30
+ - [snk-simple-crud](../../../snk-simple-crud)
31
+ - [snk-taskbar](../..)
32
+
33
+ ### Graph
34
+ ```mermaid
35
+ graph TD;
36
+ snk-crud --> taskbar-split-button
37
+ snk-detail-view --> taskbar-split-button
38
+ snk-grid --> taskbar-split-button
39
+ snk-guides-viewer --> taskbar-split-button
40
+ snk-simple-crud --> taskbar-split-button
41
+ snk-taskbar --> taskbar-split-button
42
+ style taskbar-split-button fill:#f9f,stroke:#333,stroke-width:4px
43
+ ```
44
+
45
+ ----------------------------------------------
46
+
47
+
package/components/snk-taskbar/readme.md CHANGED
@@ -7,22 +7,23 @@
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
- | `alignRigth` | `align-rigth` | Usado para determinar O alinhamento dos items na taskbar. | `boolean` | `false` |
14
- | `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
15
- | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
16
- | `customButtons` | -- | Mapa com definição de botões personalizados. A chave do mapa deve ser passada na lista "buttons" no lugar onde o botão irá aparecer. | `Map<string, CustomButton>` | `undefined` |
17
- | `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` |
18
- | `customSlotId` | `custom-slot-id` | Usado para determinar o identificador do slot que recebe elementos personalizados. | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
19
- | `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
20
- | `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
21
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
- | `overflowStrategy` | `overflow-strategy` | Define como será o comportamento da taskbar quando ocorrer overflow | `"hiddenItems" \| "none"` | `'hiddenItems'` |
23
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
24
- | `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
25
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
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
+ | `actionsSettingsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
14
+ | `alignRigth` | `align-rigth` | Usado para determinar O alinhamento dos items na taskbar. | `boolean` | `false` |
15
+ | `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
16
+ | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
17
+ | `customButtons` | -- | Mapa com definição de botões personalizados. A chave do mapa deve ser passada na lista "buttons" no lugar onde o botão irá aparecer. | `Map<string, CustomButton>` | `undefined` |
18
+ | `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` |
19
+ | `customSlotId` | `custom-slot-id` | Usado para determinar o identificador do slot que recebe elementos personalizados. | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
20
+ | `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
21
+ | `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
22
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
23
+ | `overflowStrategy` | `overflow-strategy` | Define como será o comportamento da taskbar quando ocorrer overflow | `"hiddenItems" \| "none"` | `'hiddenItems'` |
24
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
25
+ | `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
26
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
26
27
 
27
28
 
28
29
  ## Events
@@ -47,6 +48,7 @@
47
48
 
48
49
  - [snk-data-exporter](../snk-data-exporter)
49
50
  - [snk-actions-button](../snk-actions-button)
51
+ - [taskbar-split-button](./elements/taskbar-split-button)
50
52
  - [taskbar-actions-button](./elements/taskbar-actions-button)
51
53
 
52
54
  ### Graph
@@ -54,6 +56,7 @@
54
56
  graph TD;
55
57
  snk-taskbar --> snk-data-exporter
56
58
  snk-taskbar --> snk-actions-button
59
+ snk-taskbar --> taskbar-split-button
57
60
  snk-taskbar --> taskbar-actions-button
58
61
  snk-data-exporter --> snk-exporter-email-sender
59
62
  snk-detail-view --> snk-taskbar
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "8.16.0-dev.110",
3
+ "version": "8.16.0-dev.111",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [