@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-5400312.0 → 0.0.0-hotfix-rc-KB-54837.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 (21) hide show
  1. package/components/snk-application/readme.md +17 -5
  2. package/components/snk-attach/readme.md +18 -5
  3. package/components/snk-configurator/readme.md +2 -0
  4. package/components/snk-crud/readme.md +28 -13
  5. package/components/snk-crud/subcomponents/readme.md +27 -17
  6. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +11 -0
  7. package/components/snk-filter-bar/filter-item/readme.md +5 -4
  8. package/components/snk-filter-bar/filter-modal/readme.md +12 -11
  9. package/components/snk-filter-bar/readme.md +21 -7
  10. package/components/snk-form/readme.md +8 -7
  11. package/components/{snk-form/subcomponents/snk-form-config → snk-form-config}/readme.md +7 -5
  12. package/components/{snk-form → snk-form-config}/subcomponents/snk-config-options/readme.md +1 -1
  13. package/components/{snk-form → snk-form-config}/subcomponents/snk-field-config/readme.md +1 -1
  14. package/components/{snk-form → snk-form-config}/subcomponents/snk-tab-config/readme.md +1 -1
  15. package/components/snk-grid/readme.md +27 -20
  16. package/components/{snk-grid/subcomponents/snk-grid-config → snk-grid-config}/readme.md +4 -3
  17. package/components/{snk-grid/subcomponents → snk-grid-config}/snk-select-box/readme.md +1 -1
  18. package/components/snk-simple-crud/readme.md +70 -18
  19. package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +84 -0
  20. package/components/snk-taskbar/readme.md +18 -14
  21. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -7,11 +7,13 @@
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
- | `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` |
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
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
14
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
15
+ | `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` |
16
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
15
17
 
16
18
 
17
19
  ## Events
@@ -439,6 +441,16 @@ Type: `Promise<any>`
439
441
 
440
442
 
441
443
 
444
+ ### `setSearchFilterContext(name: string, value: string) => Promise<void>`
445
+
446
+ Atribui valor para parâmetros de contexto no componente de pesquisa.
447
+
448
+ #### Returns
449
+
450
+ Type: `Promise<void>`
451
+
452
+
453
+
442
454
  ### `showAlerts(alerts: Array<AlertItem>) => Promise<void>`
443
455
 
444
456
  Apresenta uma lista de alertas,
package/components/snk-attach/readme.md CHANGED
@@ -7,11 +7,15 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------------------- | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `entityName` _(required)_ | `entity-name` | Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai. | `string` | `undefined` |
13
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
14
- | `registerKey` _(required)_ | `register-key` | Identificação do registro pai. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------------- | -------------- | -------------------------------------------------------------------------------------- | ----------------------------------------- | ----------- |
12
+ | `dataUnit` | -- | DataUnit responsável por carregar os dados. | `DataUnit` | `undefined` |
13
+ | `dataUnitBuilder` | -- | DataUnitBuilder responsável por implementar dados a serem utilizados no DataUnit. | `FetcherFacade` | `undefined` |
14
+ | `entityName` | `entity-name` | Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai. | `string` | `undefined` |
15
+ | `fetcher` | -- | Fetcher responsável por carregar os dados do DataUnit. | `AttachFetcherFacadeInterface` | `undefined` |
16
+ | `fetcherType` | `fetcher-type` | FetcherType define o tipo de fetcher responsável por carregar os dados do DataUnit. | `"AnexoSistema" \| "Another" \| "Attach"` | `undefined` |
17
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
18
+ | `registerKey` _(required)_ | `register-key` | Identificação do registro pai. | `string` | `undefined` |
15
19
 
16
20
 
17
21
  ## Events
@@ -40,11 +44,20 @@ graph TD;
40
44
  snk-attach --> snk-simple-crud
41
45
  snk-simple-crud --> snk-data-unit
42
46
  snk-simple-crud --> snk-taskbar
47
+ snk-simple-crud --> snk-form-config
48
+ snk-simple-crud --> snk-configurator
49
+ snk-simple-crud --> snk-grid-config
43
50
  snk-simple-crud --> snk-data-exporter
44
51
  snk-simple-crud --> snk-actions-button
52
+ snk-simple-crud --> taskbar-actions-button
45
53
  snk-taskbar --> snk-data-exporter
46
54
  snk-taskbar --> snk-actions-button
55
+ snk-taskbar --> taskbar-actions-button
47
56
  snk-data-exporter --> snk-exporter-email-sender
57
+ snk-form-config --> snk-field-config
58
+ snk-form-config --> snk-config-options
59
+ snk-form-config --> snk-tab-config
60
+ snk-grid-config --> snk-select-box
48
61
  snk-crud --> snk-attach
49
62
  snk-detail-view --> snk-attach
50
63
  style snk-attach fill:#f9f,stroke:#333,stroke-width:4px
package/components/snk-configurator/readme.md CHANGED
@@ -56,12 +56,14 @@ Type: `Promise<void>`
56
56
 
57
57
  - [snk-crud](../snk-crud)
58
58
  - [snk-guides-viewer](../snk-crud/subcomponents)
59
+ - [snk-simple-crud](../snk-simple-crud)
59
60
 
60
61
  ### Graph
61
62
  ```mermaid
62
63
  graph TD;
63
64
  snk-crud --> snk-configurator
64
65
  snk-guides-viewer --> snk-configurator
66
+ snk-simple-crud --> snk-configurator
65
67
  style snk-configurator fill:#f9f,stroke:#333,stroke-width:4px
66
68
  ```
67
69
 
package/components/snk-crud/readme.md CHANGED
@@ -7,19 +7,24 @@
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
+ | `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` |
15
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
16
+ | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
17
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
18
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
19
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
20
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
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
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
23
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
24
+ | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
25
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `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
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
23
28
 
24
29
 
25
30
  ## Events
@@ -95,6 +100,7 @@ Type: `Promise<void>`
95
100
  - [snk-configurator](../snk-configurator)
96
101
  - [snk-data-exporter](../snk-data-exporter)
97
102
  - [snk-actions-button](../snk-actions-button)
103
+ - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
98
104
 
99
105
  ### Graph
100
106
  ```mermaid
@@ -105,11 +111,13 @@ graph TD;
105
111
  snk-crud --> snk-configurator
106
112
  snk-crud --> snk-data-exporter
107
113
  snk-crud --> snk-actions-button
114
+ snk-crud --> taskbar-actions-button
108
115
  snk-grid --> snk-filter-bar
109
116
  snk-grid --> snk-taskbar
110
117
  snk-grid --> snk-grid-config
111
118
  snk-grid --> snk-data-exporter
112
119
  snk-grid --> snk-actions-button
120
+ snk-grid --> taskbar-actions-button
113
121
  snk-filter-bar --> snk-filter-item
114
122
  snk-filter-bar --> snk-personalized-filter
115
123
  snk-filter-item --> snk-filter-detail
@@ -124,6 +132,7 @@ graph TD;
124
132
  snk-expression-item --> snk-filter-param-config
125
133
  snk-taskbar --> snk-data-exporter
126
134
  snk-taskbar --> snk-actions-button
135
+ snk-taskbar --> taskbar-actions-button
127
136
  snk-data-exporter --> snk-exporter-email-sender
128
137
  snk-grid-config --> snk-select-box
129
138
  snk-guides-viewer --> snk-form-view
@@ -134,6 +143,7 @@ graph TD;
134
143
  snk-guides-viewer --> snk-configurator
135
144
  snk-guides-viewer --> snk-data-exporter
136
145
  snk-guides-viewer --> snk-actions-button
146
+ snk-guides-viewer --> taskbar-actions-button
137
147
  snk-form-view --> snk-form-summary
138
148
  snk-detail-view --> snk-data-unit
139
149
  snk-detail-view --> snk-grid
@@ -142,12 +152,17 @@ graph TD;
142
152
  snk-detail-view --> snk-attach
143
153
  snk-detail-view --> snk-data-exporter
144
154
  snk-detail-view --> snk-actions-button
155
+ snk-detail-view --> taskbar-actions-button
145
156
  snk-attach --> snk-simple-bar
146
157
  snk-attach --> snk-simple-crud
147
158
  snk-simple-crud --> snk-data-unit
148
159
  snk-simple-crud --> snk-taskbar
160
+ snk-simple-crud --> snk-form-config
161
+ snk-simple-crud --> snk-configurator
162
+ snk-simple-crud --> snk-grid-config
149
163
  snk-simple-crud --> snk-data-exporter
150
164
  snk-simple-crud --> snk-actions-button
165
+ snk-simple-crud --> taskbar-actions-button
151
166
  snk-form-config --> snk-field-config
152
167
  snk-form-config --> snk-config-options
153
168
  snk-form-config --> snk-tab-config
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -7,22 +7,23 @@
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
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
20
+ | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
21
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
23
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
24
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
25
+ | `selectedGuide` | -- | Guia selecionada. | `IGuideItem` | `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` |
26
27
 
27
28
 
28
29
  ## Events
@@ -69,10 +70,11 @@ Type: `Promise<void>`
69
70
  - [snk-data-unit](../../snk-data-unit)
70
71
  - [snk-detail-view](snk-detail-view)
71
72
  - [snk-taskbar](../../snk-taskbar)
72
- - [snk-form-config](../../snk-form/subcomponents/snk-form-config)
73
+ - [snk-form-config](../../snk-form-config)
73
74
  - [snk-configurator](../../snk-configurator)
74
75
  - [snk-data-exporter](../../snk-data-exporter)
75
76
  - [snk-actions-button](../../snk-actions-button)
77
+ - [taskbar-actions-button](../../snk-taskbar/elements/taskbar-actions-button)
76
78
 
77
79
  ### Graph
78
80
  ```mermaid
@@ -85,6 +87,7 @@ graph TD;
85
87
  snk-guides-viewer --> snk-configurator
86
88
  snk-guides-viewer --> snk-data-exporter
87
89
  snk-guides-viewer --> snk-actions-button
90
+ snk-guides-viewer --> taskbar-actions-button
88
91
  snk-form-view --> snk-form-summary
89
92
  snk-detail-view --> snk-data-unit
90
93
  snk-detail-view --> snk-grid
@@ -93,11 +96,13 @@ graph TD;
93
96
  snk-detail-view --> snk-attach
94
97
  snk-detail-view --> snk-data-exporter
95
98
  snk-detail-view --> snk-actions-button
99
+ snk-detail-view --> taskbar-actions-button
96
100
  snk-grid --> snk-filter-bar
97
101
  snk-grid --> snk-taskbar
98
102
  snk-grid --> snk-grid-config
99
103
  snk-grid --> snk-data-exporter
100
104
  snk-grid --> snk-actions-button
105
+ snk-grid --> taskbar-actions-button
101
106
  snk-filter-bar --> snk-filter-item
102
107
  snk-filter-bar --> snk-personalized-filter
103
108
  snk-filter-item --> snk-filter-detail
@@ -112,14 +117,19 @@ graph TD;
112
117
  snk-expression-item --> snk-filter-param-config
113
118
  snk-taskbar --> snk-data-exporter
114
119
  snk-taskbar --> snk-actions-button
120
+ snk-taskbar --> taskbar-actions-button
115
121
  snk-data-exporter --> snk-exporter-email-sender
116
122
  snk-grid-config --> snk-select-box
117
123
  snk-attach --> snk-simple-bar
118
124
  snk-attach --> snk-simple-crud
119
125
  snk-simple-crud --> snk-data-unit
120
126
  snk-simple-crud --> snk-taskbar
127
+ snk-simple-crud --> snk-form-config
128
+ snk-simple-crud --> snk-configurator
129
+ snk-simple-crud --> snk-grid-config
121
130
  snk-simple-crud --> snk-data-exporter
122
131
  snk-simple-crud --> snk-actions-button
132
+ snk-simple-crud --> taskbar-actions-button
123
133
  snk-form-config --> snk-field-config
124
134
  snk-form-config --> snk-config-options
125
135
  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
@@ -118,8 +122,15 @@ graph TD;
118
122
  snk-attach --> snk-simple-crud
119
123
  snk-simple-crud --> snk-data-unit
120
124
  snk-simple-crud --> snk-taskbar
125
+ snk-simple-crud --> snk-form-config
126
+ snk-simple-crud --> snk-configurator
127
+ snk-simple-crud --> snk-grid-config
121
128
  snk-simple-crud --> snk-data-exporter
122
129
  snk-simple-crud --> snk-actions-button
130
+ snk-simple-crud --> taskbar-actions-button
131
+ snk-form-config --> snk-field-config
132
+ snk-form-config --> snk-config-options
133
+ snk-form-config --> snk-tab-config
123
134
  snk-guides-viewer --> snk-detail-view
124
135
  style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
125
136
  ```
package/components/snk-filter-bar/filter-item/readme.md CHANGED
@@ -7,10 +7,11 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------ | --------- | --------------------------------------------------------------------------------- | -------------------------------------- | ----------- |
12
- | `config` | -- | Define as configurações do componente snk-filter-item. | `SnkFilterItemConfig` | `undefined` |
13
- | `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
+ | `config` | -- | Define as configurações do componente snk-filter-item. | `SnkFilterItemConfig` | `undefined` |
13
+ | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
14
+ | `showChips` | `show-chips` | Usado para controlar a visibilidade dos chips de filtros | `boolean` | `true` |
14
15
 
15
16
 
16
17
  ## Events
package/components/snk-filter-bar/filter-modal/readme.md CHANGED
@@ -7,17 +7,18 @@
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
- | `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` |
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
+ | `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). | `boolean` | `undefined` |
18
+ | `editPersonalizedFilter` | -- | Ação executada ao editar um filtro personalizado | `(id: string) => void` | `undefined` |
19
+ | `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
20
+ | `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
21
+ | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
21
22
 
22
23
 
23
24
  ## Dependencies
package/components/snk-filter-bar/readme.md CHANGED
@@ -7,13 +7,17 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ----------- |
12
- | `configName` | `config-name` | Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. | `string` | `undefined` |
13
- | `dataUnit` | -- | Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. | `DataUnit` | `undefined` |
14
- | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `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` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ----------- |
12
+ | `configName` | `config-name` | Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. | `string` | `undefined` |
13
+ | `dataUnit` | -- | Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. | `DataUnit` | `undefined` |
14
+ | `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` |
15
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
16
+ | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
17
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
18
+ | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
19
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
20
+ | `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
17
21
 
18
22
 
19
23
  ## Events
@@ -65,6 +69,16 @@ Type: `Promise<SnkFilterItemConfig>`
65
69
 
66
70
  - Retorna o item de filtro removido, ou undefined caso não encontrado.
67
71
 
72
+ ### `showFilterModal() => Promise<void>`
73
+
74
+ Abre o modal de filtros
75
+
76
+ #### Returns
77
+
78
+ Type: `Promise<void>`
79
+
80
+
81
+
68
82
  ### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
69
83
 
70
84
  Atualiza um item do filtro.
package/components/snk-form/readme.md CHANGED
@@ -7,12 +7,13 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------ | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
13
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
14
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
15
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------------- | ------------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
+ | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
13
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
14
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
16
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
16
17
 
17
18
 
18
19
  ## Events
@@ -51,7 +52,7 @@ Type: `Promise<void>`
51
52
 
52
53
  ### Depends on
53
54
 
54
- - [snk-form-config](./subcomponents/snk-form-config)
55
+ - [snk-form-config](../snk-form-config)
55
56
 
56
57
  ### Graph
57
58
  ```mermaid
package/components/{snk-form/subcomponents/snk-form-config → snk-form-config}/readme.md RENAMED
@@ -26,14 +26,15 @@
26
26
 
27
27
  ### Used by
28
28
 
29
- - [snk-form](../..)
30
- - [snk-guides-viewer](../../../snk-crud/subcomponents)
29
+ - [snk-form](../snk-form)
30
+ - [snk-guides-viewer](../snk-crud/subcomponents)
31
+ - [snk-simple-crud](../snk-simple-crud)
31
32
 
32
33
  ### Depends on
33
34
 
34
- - [snk-field-config](../snk-field-config)
35
- - [snk-config-options](../snk-config-options)
36
- - [snk-tab-config](../snk-tab-config)
35
+ - [snk-field-config](./subcomponents/snk-field-config)
36
+ - [snk-config-options](./subcomponents/snk-config-options)
37
+ - [snk-tab-config](./subcomponents/snk-tab-config)
37
38
 
38
39
  ### Graph
39
40
  ```mermaid
@@ -43,6 +44,7 @@ graph TD;
43
44
  snk-form-config --> snk-tab-config
44
45
  snk-form --> snk-form-config
45
46
  snk-guides-viewer --> snk-form-config
47
+ snk-simple-crud --> snk-form-config
46
48
  style snk-form-config fill:#f9f,stroke:#333,stroke-width:4px
47
49
  ```
48
50
 
package/components/{snk-form → snk-form-config}/subcomponents/snk-config-options/readme.md RENAMED
@@ -26,7 +26,7 @@
26
26
 
27
27
  ### Used by
28
28
 
29
- - [snk-form-config](../snk-form-config)
29
+ - [snk-form-config](../..)
30
30
 
31
31
  ### Graph
32
32
  ```mermaid
package/components/{snk-form → snk-form-config}/subcomponents/snk-field-config/readme.md RENAMED
@@ -27,7 +27,7 @@
27
27
 
28
28
  ### Used by
29
29
 
30
- - [snk-form-config](../snk-form-config)
30
+ - [snk-form-config](../..)
31
31
 
32
32
  ### Graph
33
33
  ```mermaid
package/components/{snk-form → snk-form-config}/subcomponents/snk-tab-config/readme.md RENAMED
@@ -32,7 +32,7 @@
32
32
 
33
33
  ### Used by
34
34
 
35
- - [snk-form-config](../snk-form-config)
35
+ - [snk-form-config](../..)
36
36
 
37
37
  ### Graph
38
38
  ```mermaid
package/components/snk-grid/readme.md CHANGED
@@ -7,25 +7,29 @@
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` | -- | | `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.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
+ | `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` |
17
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
18
+ | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
19
+ | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
20
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
21
+ | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
22
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
23
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
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
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
26
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
27
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
28
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
29
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
30
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
31
+ | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
32
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
29
33
 
30
34
 
31
35
  ## Events
@@ -110,9 +114,10 @@ Type: `Promise<void>`
110
114
 
111
115
  - [snk-filter-bar](../snk-filter-bar)
112
116
  - [snk-taskbar](../snk-taskbar)
113
- - [snk-grid-config](./subcomponents/snk-grid-config)
117
+ - [snk-grid-config](../snk-grid-config)
114
118
  - [snk-data-exporter](../snk-data-exporter)
115
119
  - [snk-actions-button](../snk-actions-button)
120
+ - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
116
121
 
117
122
  ### Graph
118
123
  ```mermaid
@@ -122,6 +127,7 @@ graph TD;
122
127
  snk-grid --> snk-grid-config
123
128
  snk-grid --> snk-data-exporter
124
129
  snk-grid --> snk-actions-button
130
+ snk-grid --> taskbar-actions-button
125
131
  snk-filter-bar --> snk-filter-item
126
132
  snk-filter-bar --> snk-personalized-filter
127
133
  snk-filter-item --> snk-filter-detail
@@ -136,6 +142,7 @@ graph TD;
136
142
  snk-expression-item --> snk-filter-param-config
137
143
  snk-taskbar --> snk-data-exporter
138
144
  snk-taskbar --> snk-actions-button
145
+ snk-taskbar --> taskbar-actions-button
139
146
  snk-data-exporter --> snk-exporter-email-sender
140
147
  snk-grid-config --> snk-select-box
141
148
  snk-crud --> snk-grid
package/components/{snk-grid/subcomponents/snk-grid-config → snk-grid-config}/readme.md RENAMED
@@ -9,7 +9,6 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | --------------- | ---------------- | ------------------------------------------------ | ---------------- | ----------- |
12
- | `application` | -- | Referência para o SnkApplication | `SnkApplication` | `undefined` |
13
12
  | `columns` | -- | Colunas da grade. | `EzGridColumn[]` | `undefined` |
14
13
  | `config` | -- | Configurações da grade. | `IGridConfig` | `undefined` |
15
14
  | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
@@ -29,17 +28,19 @@
29
28
 
30
29
  ### Used by
31
30
 
32
- - [snk-grid](../..)
31
+ - [snk-grid](../snk-grid)
32
+ - [snk-simple-crud](../snk-simple-crud)
33
33
 
34
34
  ### Depends on
35
35
 
36
- - [snk-select-box](../snk-select-box)
36
+ - [snk-select-box](snk-select-box)
37
37
 
38
38
  ### Graph
39
39
  ```mermaid
40
40
  graph TD;
41
41
  snk-grid-config --> snk-select-box
42
42
  snk-grid --> snk-grid-config
43
+ snk-simple-crud --> snk-grid-config
43
44
  style snk-grid-config fill:#f9f,stroke:#333,stroke-width:4px
44
45
  ```
45
46
 
package/components/{snk-grid/subcomponents → snk-grid-config}/snk-select-box/readme.md RENAMED
@@ -23,7 +23,7 @@
23
23
 
24
24
  ### Used by
25
25
 
26
- - [snk-grid-config](../snk-grid-config)
26
+ - [snk-grid-config](..)
27
27
 
28
28
  ### Graph
29
29
  ```mermaid
package/components/snk-simple-crud/readme.md CHANGED
@@ -7,32 +7,51 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------- |
12
- | `dataState` | -- | | `DataState` | `undefined` |
13
- | `dataUnit` | -- | | `DataUnit` | `undefined` |
14
- | `formConfig` | -- | | `IFormConfig` | `undefined` |
15
- | `gridConfig` | -- | | `IGridConfig` | `undefined` |
16
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
- | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
18
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
19
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
20
- | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
21
- | `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
+ | `dataState` | -- | | `DataState` | `undefined` |
15
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
16
+ | `formConfig` | -- | | `IFormConfig` | `undefined` |
17
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
18
+ | `gridConfig` | -- | | `IGridConfig` | `undefined` |
19
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
20
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
21
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
+ | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
23
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
24
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
25
+ | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `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
+ | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
28
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
22
29
 
23
30
 
24
31
  ## Events
25
32
 
26
- | Event | Description | Type |
27
- | ----------------- | ------------------------------------------------------------------------------- | ---------------------------- |
28
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
29
- | `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
30
- | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
31
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
33
+ | Event | Description | Type |
34
+ | -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
35
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
36
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
37
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
38
+ | `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
39
+ | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
40
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
32
41
 
33
42
 
34
43
  ## Methods
35
44
 
45
+ ### `closeConfigurator() => Promise<void>`
46
+
47
+ Usado para fechar o configurator do CRUD
48
+
49
+ #### Returns
50
+
51
+ Type: `Promise<void>`
52
+
53
+
54
+
36
55
  ### `getRecords() => Promise<Array<Record>>`
37
56
 
38
57
 
@@ -53,6 +72,16 @@ Type: `Promise<void>`
53
72
 
54
73
 
55
74
 
75
+ ### `openConfigurator() => Promise<void>`
76
+
77
+ Usado para abrir o configurator do CRUD
78
+
79
+ #### Returns
80
+
81
+ Type: `Promise<void>`
82
+
83
+
84
+
56
85
  ### `setMetadata(metadata: UnitMetadata) => Promise<void>`
57
86
 
58
87
 
@@ -73,6 +102,16 @@ Type: `Promise<void>`
73
102
 
74
103
 
75
104
 
105
+ ### `updateConfig() => Promise<void>`
106
+
107
+
108
+
109
+ #### Returns
110
+
111
+ Type: `Promise<void>`
112
+
113
+
114
+
76
115
 
77
116
  ## Dependencies
78
117
 
@@ -84,19 +123,32 @@ Type: `Promise<void>`
84
123
 
85
124
  - [snk-data-unit](../snk-data-unit)
86
125
  - [snk-taskbar](../snk-taskbar)
126
+ - [snk-form-config](../snk-form-config)
127
+ - [snk-configurator](../snk-configurator)
128
+ - [snk-grid-config](../snk-grid-config)
87
129
  - [snk-data-exporter](../snk-data-exporter)
88
130
  - [snk-actions-button](../snk-actions-button)
131
+ - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
89
132
 
90
133
  ### Graph
91
134
  ```mermaid
92
135
  graph TD;
93
136
  snk-simple-crud --> snk-data-unit
94
137
  snk-simple-crud --> snk-taskbar
138
+ snk-simple-crud --> snk-form-config
139
+ snk-simple-crud --> snk-configurator
140
+ snk-simple-crud --> snk-grid-config
95
141
  snk-simple-crud --> snk-data-exporter
96
142
  snk-simple-crud --> snk-actions-button
143
+ snk-simple-crud --> taskbar-actions-button
97
144
  snk-taskbar --> snk-data-exporter
98
145
  snk-taskbar --> snk-actions-button
146
+ snk-taskbar --> taskbar-actions-button
99
147
  snk-data-exporter --> snk-exporter-email-sender
148
+ snk-form-config --> snk-field-config
149
+ snk-form-config --> snk-config-options
150
+ snk-form-config --> snk-tab-config
151
+ snk-grid-config --> snk-select-box
100
152
  snk-attach --> snk-simple-crud
101
153
  style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
102
154
  ```
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
@@ -7,20 +7,22 @@
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
- | `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.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` |
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` |
24
26
 
25
27
 
26
28
  ## Events
@@ -43,12 +45,14 @@
43
45
 
44
46
  - [snk-data-exporter](../snk-data-exporter)
45
47
  - [snk-actions-button](../snk-actions-button)
48
+ - [taskbar-actions-button](./elements/taskbar-actions-button)
46
49
 
47
50
  ### Graph
48
51
  ```mermaid
49
52
  graph TD;
50
53
  snk-taskbar --> snk-data-exporter
51
54
  snk-taskbar --> snk-actions-button
55
+ snk-taskbar --> taskbar-actions-button
52
56
  snk-data-exporter --> snk-exporter-email-sender
53
57
  snk-detail-view --> snk-taskbar
54
58
  snk-grid --> snk-taskbar
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "0.0.0-hotfix-ga-5400312.0",
3
+ "version": "0.0.0-hotfix-rc-KB-54837.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [