@sankhyalabs/sankhyablocks-docs 9.0.1 → 9.1.0-dev.2

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 (31) hide show
  1. package/components/snk-application/readme.md +41 -0
  2. package/components/snk-attach/readme.md +4 -0
  3. package/components/snk-configurator/readme.md +7 -0
  4. package/components/snk-crud/readme.md +19 -3
  5. package/components/snk-crud/subcomponents/readme.md +22 -18
  6. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +25 -17
  7. package/components/snk-filter-bar/filter-modal/readme.md +15 -12
  8. package/components/snk-filter-bar/filter-modal/subcomponents/snk-default-filter/readme.md +38 -0
  9. package/components/snk-form/readme.md +8 -3
  10. package/components/snk-form-config/config-header/configs-button/readme.md +40 -0
  11. package/components/snk-form-config/config-header/readme.md +47 -0
  12. package/components/snk-form-config/field-item/field-config/readme.md +53 -0
  13. package/components/snk-form-config/field-item/readme.md +48 -0
  14. package/components/snk-form-config/fields-layout/readme.md +64 -0
  15. package/components/snk-form-config/fields-selector/readme.md +44 -0
  16. package/components/snk-form-config/guides-configurator/readme.md +42 -0
  17. package/components/snk-form-config/readme.md +13 -7
  18. package/components/snk-grid/readme.md +8 -10
  19. package/components/snk-layout-form-config/readme.md +41 -0
  20. package/components/snk-layout-form-config/snk-view-representation/readme.md +30 -0
  21. package/components/snk-personalized-filter/readme.md +8 -7
  22. package/components/snk-personalized-filter/subcomponents/snk-expression-group/readme.md +8 -7
  23. package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md +7 -6
  24. package/components/snk-personalized-filter/subcomponents/snk-filter-assistent-mode/readme.md +8 -7
  25. package/components/snk-simple-crud/readme.md +8 -1
  26. package/components/snk-taskbar/elements/taskbar-split-button/readme.md +47 -0
  27. package/components/snk-taskbar/readme.md +19 -16
  28. package/package.json +1 -1
  29. package/components/snk-form-config/subcomponents/snk-config-options/readme.md +0 -40
  30. package/components/snk-form-config/subcomponents/snk-field-config/readme.md +0 -41
  31. package/components/snk-form-config/subcomponents/snk-tab-config/readme.md +0 -46
package/components/snk-form-config/field-item/readme.md ADDED
@@ -0,0 +1,48 @@
1
+ # field-item
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------------ | ----------- | ------------------- | ----------- |
12
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
13
+ | `fieldConfig` | `field-config` | | `IFieldConfig` | `undefined` |
14
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
15
+ | `onLayoutConfig` | `on-layout-config` | | `boolean` | `false` |
16
+
17
+
18
+ ## Events
19
+
20
+ | Event | Description | Type |
21
+ | --------------------- | ----------- | --------------------------- |
22
+ | `addFieldToGuide` | | `CustomEvent<IFieldConfig>` |
23
+ | `setFieldAsAvailable` | | `CustomEvent<IFieldConfig>` |
24
+
25
+
26
+ ## Dependencies
27
+
28
+ ### Used by
29
+
30
+ - [fields-layout](../fields-layout)
31
+ - [fields-selector](../fields-selector)
32
+
33
+ ### Depends on
34
+
35
+ - [field-config](field-config)
36
+
37
+ ### Graph
38
+ ```mermaid
39
+ graph TD;
40
+ field-item --> field-config
41
+ fields-layout --> field-item
42
+ fields-selector --> field-item
43
+ style field-item fill:#f9f,stroke:#333,stroke-width:4px
44
+ ```
45
+
46
+ ----------------------------------------------
47
+
48
+
package/components/snk-form-config/fields-layout/readme.md ADDED
@@ -0,0 +1,64 @@
1
+ # fields-layout
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | --------- | ----------- | ------------------- | ----------- |
12
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
13
+ | `groupsList` | -- | | `IGroupConfig[]` | `[]` |
14
+ | `guideNames` | -- | | `string[]` | `[]` |
15
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
16
+ | `selectedGuide` | -- | | `IGuideConfig` | `undefined` |
17
+
18
+
19
+ ## Events
20
+
21
+ | Event | Description | Type |
22
+ | ------------------------- | ----------- | ----------------------------- |
23
+ | `guideRenamed` | | `CustomEvent<string>` |
24
+ | `isEditingGroupName` | | `CustomEvent<boolean>` |
25
+ | `isEditingGuideName` | | `CustomEvent<boolean>` |
26
+ | `layoutChanged` | | `CustomEvent<IGroupConfig[]>` |
27
+ | `setFieldListAsAvailable` | | `CustomEvent<IFieldConfig[]>` |
28
+
29
+
30
+ ## Methods
31
+
32
+ ### `addFieldToLayout(incomingField: IFieldConfig) => Promise<void>`
33
+
34
+
35
+
36
+ #### Returns
37
+
38
+ Type: `Promise<void>`
39
+
40
+
41
+
42
+
43
+ ## Dependencies
44
+
45
+ ### Used by
46
+
47
+ - [snk-form-config](..)
48
+
49
+ ### Depends on
50
+
51
+ - [field-item](../field-item)
52
+
53
+ ### Graph
54
+ ```mermaid
55
+ graph TD;
56
+ fields-layout --> field-item
57
+ field-item --> field-config
58
+ snk-form-config --> fields-layout
59
+ style fields-layout fill:#f9f,stroke:#333,stroke-width:4px
60
+ ```
61
+
62
+ ----------------------------------------------
63
+
64
+
package/components/snk-form-config/fields-selector/readme.md ADDED
@@ -0,0 +1,44 @@
1
+ # fields-selector
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | --------- | ----------- | ---------------- | ----------- |
12
+ | `availableFields` | -- | | `IFieldConfig[]` | `[]` |
13
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
14
+
15
+
16
+ ## Events
17
+
18
+ | Event | Description | Type |
19
+ | ------------------ | ----------- | ----------------------------- |
20
+ | `fieldListChanged` | | `CustomEvent<IFieldConfig[]>` |
21
+
22
+
23
+ ## Dependencies
24
+
25
+ ### Used by
26
+
27
+ - [snk-form-config](..)
28
+
29
+ ### Depends on
30
+
31
+ - [field-item](../field-item)
32
+
33
+ ### Graph
34
+ ```mermaid
35
+ graph TD;
36
+ fields-selector --> field-item
37
+ field-item --> field-config
38
+ snk-form-config --> fields-selector
39
+ style fields-selector fill:#f9f,stroke:#333,stroke-width:4px
40
+ ```
41
+
42
+ ----------------------------------------------
43
+
44
+
package/components/snk-form-config/guides-configurator/readme.md ADDED
@@ -0,0 +1,42 @@
1
+ # guides-configurator
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | --------- | ----------- | ------------------- | ----------- |
12
+ | `guidesList` | -- | | `IGuideConfig[]` | `[]` |
13
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
14
+ | `selectedGuide` | -- | | `IGuideConfig` | `undefined` |
15
+
16
+
17
+ ## Events
18
+
19
+ | Event | Description | Type |
20
+ | ------------------ | ----------- | ----------------------------- |
21
+ | `createNewGuide` | | `CustomEvent<void>` |
22
+ | `guideDeleted` | | `CustomEvent<IGuideConfig>` |
23
+ | `guideListChanged` | | `CustomEvent<IGuideConfig[]>` |
24
+ | `guideSelected` | | `CustomEvent<IGuideConfig>` |
25
+
26
+
27
+ ## Dependencies
28
+
29
+ ### Used by
30
+
31
+ - [snk-form-config](..)
32
+
33
+ ### Graph
34
+ ```mermaid
35
+ graph TD;
36
+ snk-form-config --> guides-configurator
37
+ style guides-configurator fill:#f9f,stroke:#333,stroke-width:4px
38
+ ```
39
+
40
+ ----------------------------------------------
41
+
42
+
package/components/snk-form-config/readme.md CHANGED
@@ -1,4 +1,4 @@
1
- # ez-form-config
1
+ # snk-form-config
2
2
 
3
3
 
4
4
 
@@ -32,16 +32,22 @@
32
32
 
33
33
  ### Depends on
34
34
 
35
- - [snk-field-config](./subcomponents/snk-field-config)
36
- - [snk-config-options](./subcomponents/snk-config-options)
37
- - [snk-tab-config](./subcomponents/snk-tab-config)
35
+ - [config-header](config-header)
36
+ - [guides-configurator](guides-configurator)
37
+ - [fields-layout](fields-layout)
38
+ - [fields-selector](fields-selector)
38
39
 
39
40
  ### Graph
40
41
  ```mermaid
41
42
  graph TD;
42
- snk-form-config --> snk-field-config
43
- snk-form-config --> snk-config-options
44
- snk-form-config --> snk-tab-config
43
+ snk-form-config --> config-header
44
+ snk-form-config --> guides-configurator
45
+ snk-form-config --> fields-layout
46
+ snk-form-config --> fields-selector
47
+ config-header --> configs-button
48
+ fields-layout --> field-item
49
+ field-item --> field-config
50
+ fields-selector --> field-item
45
51
  snk-form --> snk-form-config
46
52
  snk-guides-viewer --> snk-form-config
47
53
  style snk-form-config fill:#f9f,stroke:#333,stroke-width:4px
package/components/snk-grid/readme.md CHANGED
@@ -14,6 +14,7 @@
14
14
  | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
15
15
  | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
16
16
  | `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
17
+ | `compact` | `compact` | Define se a grade deve ser exibida em modo compacto | `boolean` | `undefined` |
17
18
  | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
18
19
  | `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). | `boolean` | `undefined` |
19
20
  | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
@@ -25,6 +26,7 @@
25
26
  | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
26
27
  | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
27
28
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
29
+ | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
28
30
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
29
31
  | `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` |
30
32
  | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
@@ -34,10 +36,13 @@
34
36
  | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
35
37
  | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
36
38
  | `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
39
+ | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de chechbox deve ser suprimida | `boolean` | `undefined` |
40
+ | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir o scroll horizontal. | `boolean` | `false` |
37
41
  | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
38
42
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
39
43
  | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
40
44
  | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
45
+ | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F | `boolean` | `true` |
41
46
 
42
47
 
43
48
  ## Events
@@ -80,16 +85,6 @@ Type: `Promise<void>`
80
85
 
81
86
 
82
87
 
83
- ### `findColumn() => Promise<void>`
84
-
85
- Abre o localizador de colunas
86
-
87
- #### Returns
88
-
89
- Type: `Promise<void>`
90
-
91
-
92
-
93
88
  ### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
94
89
 
95
90
  Retorna o elemento da filter-bar da grade.
@@ -185,6 +180,7 @@ Type: `Promise<void>`
185
180
  - [snk-grid-config](../snk-grid-config)
186
181
  - [snk-data-exporter](../snk-data-exporter)
187
182
  - [snk-actions-button](../snk-actions-button)
183
+ - [taskbar-split-button](../snk-taskbar/elements/taskbar-split-button)
188
184
  - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
189
185
 
190
186
  ### Graph
@@ -195,6 +191,7 @@ graph TD;
195
191
  snk-grid --> snk-grid-config
196
192
  snk-grid --> snk-data-exporter
197
193
  snk-grid --> snk-actions-button
194
+ snk-grid --> taskbar-split-button
198
195
  snk-grid --> taskbar-actions-button
199
196
  snk-filter-bar --> snk-filter-item
200
197
  snk-filter-bar --> snk-personalized-filter
@@ -210,6 +207,7 @@ graph TD;
210
207
  snk-expression-item --> snk-filter-param-config
211
208
  snk-taskbar --> snk-data-exporter
212
209
  snk-taskbar --> snk-actions-button
210
+ snk-taskbar --> taskbar-split-button
213
211
  snk-taskbar --> taskbar-actions-button
214
212
  snk-data-exporter --> snk-exporter-email-sender
215
213
  snk-grid-config --> snk-select-box
package/components/snk-layout-form-config/readme.md ADDED
@@ -0,0 +1,41 @@
1
+ # snk-layout-form-config
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Methods
9
+
10
+ ### `save() => Promise<void>`
11
+
12
+ Salva o tipo de layout escolhido. Sem retorno.
13
+
14
+ #### Returns
15
+
16
+ Type: `Promise<void>`
17
+
18
+
19
+
20
+
21
+ ## Dependencies
22
+
23
+ ### Used by
24
+
25
+ - [snk-configurator](../snk-configurator)
26
+
27
+ ### Depends on
28
+
29
+ - [snk-view-representation](snk-view-representation)
30
+
31
+ ### Graph
32
+ ```mermaid
33
+ graph TD;
34
+ snk-layout-form-config --> snk-view-representation
35
+ snk-configurator --> snk-layout-form-config
36
+ style snk-layout-form-config fill:#f9f,stroke:#333,stroke-width:4px
37
+ ```
38
+
39
+ ----------------------------------------------
40
+
41
+
package/components/snk-layout-form-config/snk-view-representation/readme.md ADDED
@@ -0,0 +1,30 @@
1
+ # snk-view-representation
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------- | --------- | ---------------------------------------------------------- | ------------ | ------------------------- |
12
+ | `mode` | `mode` | Define o layout do componente: 'CASCADE' ou 'SIDE_BY_SIDE' | `FormLayout` | `FormLayout.SIDE_BY_SIDE` |
13
+
14
+
15
+ ## Dependencies
16
+
17
+ ### Used by
18
+
19
+ - [snk-layout-form-config](..)
20
+
21
+ ### Graph
22
+ ```mermaid
23
+ graph TD;
24
+ snk-layout-form-config --> snk-view-representation
25
+ style snk-view-representation fill:#f9f,stroke:#333,stroke-width:4px
26
+ ```
27
+
28
+ ----------------------------------------------
29
+
30
+
package/components/snk-personalized-filter/readme.md CHANGED
@@ -7,13 +7,14 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
13
- | `entityUri` | `entity-uri` | Responsável por receber a URI da entidade. | `string` | `undefined` |
14
- | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
15
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
- | `resourceID` | `resource-i-d` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
+ | `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
13
+ | `entityUri` | `entity-uri` | Responsável por receber a URI da entidade. | `string` | `undefined` |
14
+ | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
15
+ | `isDefaultFilter` | `is-default-filter` | Define se o filtro em questão é um filtro padrão. | `boolean` | `false` |
16
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
+ | `resourceID` | `resource-i-d` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
17
18
 
18
19
 
19
20
  ## Events
package/components/snk-personalized-filter/subcomponents/snk-expression-group/readme.md CHANGED
@@ -7,13 +7,14 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `entityURI` | `entity-u-r-i` | Identificador da unidade de dados. | `string` | `undefined` |
13
- | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
14
- | `group` | -- | Grupo que será representado visualmente pelo componente. | `IExpressionGroup` | `undefined` |
15
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
- | `parentTop` | `parent-top` | Tamanho do elemento pai do grupo | `number` | `0` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
+ | `entityURI` | `entity-u-r-i` | Identificador da unidade de dados. | `string` | `undefined` |
13
+ | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
14
+ | `group` | -- | Grupo que será representado visualmente pelo componente. | `IExpressionGroup` | `undefined` |
15
+ | `isDefaultFilter` | `is-default-filter` | Define se o filtro em questão é um filtro padrão. | `boolean` | `false` |
16
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
+ | `parentTop` | `parent-top` | Tamanho do elemento pai do grupo | `number` | `0` |
17
18
 
18
19
 
19
20
  ## Events
package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md CHANGED
@@ -7,12 +7,13 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `canRemove` | `can-remove` | Controla a exibição do botão Remover. | `boolean` | `true` |
13
- | `entityURI` | `entity-u-r-i` | Identificador da unidade de dados. | `string` | `undefined` |
14
- | `expression` | -- | Expressão que será representada visualmente. | `IExpressionItem` | `undefined` |
15
- | `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
+ | `canRemove` | `can-remove` | Controla a exibição do botão Remover. | `boolean` | `true` |
13
+ | `entityURI` | `entity-u-r-i` | Identificador da unidade de dados. | `string` | `undefined` |
14
+ | `expression` | -- | Expressão que será representada visualmente. | `IExpressionItem` | `undefined` |
15
+ | `isDefaultFilter` | `is-default-filter` | Define se o filtro em questão é um filtro padrão. | `boolean` | `false` |
16
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
17
 
17
18
 
18
19
  ## Events
package/components/snk-personalized-filter/subcomponents/snk-filter-assistent-mode/readme.md CHANGED
@@ -7,13 +7,14 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | ------------ | -------------------------------------------------------------------------------------- | --------------------- | ----------- |
12
- | `application` | -- | Propriedade que mantém informações relacionadas ao SnkApplication. | `SnkApplication` | `undefined` |
13
- | `entityUri` | `entity-uri` | Responsável por receber a URI da entidade. | `string` | `undefined` |
14
- | `filterAssistent` | -- | Propriedade que contém informações do filtro personalizado. | `IPersonalizedFilter` | `undefined` |
15
- | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
16
- | `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
+ | `application` | -- | Propriedade que mantém informações relacionadas ao SnkApplication. | `SnkApplication` | `undefined` |
13
+ | `entityUri` | `entity-uri` | Responsável por receber a URI da entidade. | `string` | `undefined` |
14
+ | `filterAssistent` | -- | Propriedade que contém informações do filtro personalizado. | `IPersonalizedFilter` | `undefined` |
15
+ | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
16
+ | `isDefaultFilter` | `is-default-filter` | Define se o filtro em questão é um filtro padrão. | `boolean` | `false` |
17
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
18
 
18
19
 
19
20
  ## Events
package/components/snk-simple-crud/readme.md CHANGED
@@ -26,14 +26,16 @@
26
26
  | `gridConfig` | -- | | `IGridConfig` | `undefined` |
27
27
  | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
28
28
  | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
29
+ | `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `false` |
29
30
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
30
31
  | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
32
+ | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
31
33
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
32
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` |
33
35
  | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
34
36
  | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
35
37
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
36
- | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
38
+ | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `false` |
37
39
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
38
40
  | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
39
41
  | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
@@ -189,6 +191,7 @@ Type: `Promise<void>`
189
191
  - [snk-grid-config](../snk-grid-config)
190
192
  - [snk-data-exporter](../snk-data-exporter)
191
193
  - [snk-actions-button](../snk-actions-button)
194
+ - [taskbar-split-button](../snk-taskbar/elements/taskbar-split-button)
192
195
  - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
193
196
 
194
197
  ### Graph
@@ -201,11 +204,15 @@ graph TD;
201
204
  snk-simple-crud --> snk-grid-config
202
205
  snk-simple-crud --> snk-data-exporter
203
206
  snk-simple-crud --> snk-actions-button
207
+ snk-simple-crud --> taskbar-split-button
204
208
  snk-simple-crud --> taskbar-actions-button
205
209
  snk-taskbar --> snk-data-exporter
206
210
  snk-taskbar --> snk-actions-button
211
+ snk-taskbar --> taskbar-split-button
207
212
  snk-taskbar --> taskbar-actions-button
208
213
  snk-data-exporter --> snk-exporter-email-sender
214
+ snk-configurator --> snk-layout-form-config
215
+ snk-layout-form-config --> snk-view-representation
209
216
  snk-grid-config --> snk-select-box
210
217
  snk-attach --> snk-simple-crud
211
218
  style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
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
+