@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-rc-KB-54816.0 → 0.0.0-hotfix-ga-5400312.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.
- package/components/snk-application/readme.md +5 -17
- package/components/snk-attach/readme.md +5 -18
- package/components/snk-configurator/readme.md +0 -2
- package/components/snk-crud/readme.md +13 -28
- package/components/snk-crud/subcomponents/readme.md +17 -27
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +0 -11
- package/components/snk-filter-bar/filter-item/readme.md +4 -5
- package/components/snk-filter-bar/filter-modal/readme.md +11 -12
- package/components/snk-filter-bar/readme.md +7 -21
- package/components/snk-form/readme.md +7 -8
- package/components/{snk-form-config → snk-form}/subcomponents/snk-config-options/readme.md +1 -1
- package/components/{snk-form-config → snk-form}/subcomponents/snk-field-config/readme.md +1 -1
- package/components/{snk-form-config → snk-form/subcomponents/snk-form-config}/readme.md +5 -7
- package/components/{snk-form-config → snk-form}/subcomponents/snk-tab-config/readme.md +1 -1
- package/components/snk-grid/readme.md +20 -27
- package/components/{snk-grid-config → snk-grid/subcomponents/snk-grid-config}/readme.md +3 -4
- package/components/{snk-grid-config → snk-grid/subcomponents}/snk-select-box/readme.md +1 -1
- package/components/snk-simple-crud/readme.md +18 -70
- package/components/snk-taskbar/readme.md +14 -18
- package/package.json +1 -1
- package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +0 -84
|
@@ -7,13 +7,11 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `configName`
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
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` |
|
|
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` |
|
|
17
15
|
|
|
18
16
|
|
|
19
17
|
## Events
|
|
@@ -441,16 +439,6 @@ Type: `Promise<any>`
|
|
|
441
439
|
|
|
442
440
|
|
|
443
441
|
|
|
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
|
-
|
|
454
442
|
### `showAlerts(alerts: Array<AlertItem>) => Promise<void>`
|
|
455
443
|
|
|
456
444
|
Apresenta uma lista de alertas,
|
|
@@ -7,15 +7,11 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description | Type
|
|
11
|
-
| -------------------------- | -------------- | -------------------------------------------------------------------------------------- |
|
|
12
|
-
| `
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
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` |
|
|
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` |
|
|
19
15
|
|
|
20
16
|
|
|
21
17
|
## Events
|
|
@@ -44,20 +40,11 @@ graph TD;
|
|
|
44
40
|
snk-attach --> snk-simple-crud
|
|
45
41
|
snk-simple-crud --> snk-data-unit
|
|
46
42
|
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
|
|
50
43
|
snk-simple-crud --> snk-data-exporter
|
|
51
44
|
snk-simple-crud --> snk-actions-button
|
|
52
|
-
snk-simple-crud --> taskbar-actions-button
|
|
53
45
|
snk-taskbar --> snk-data-exporter
|
|
54
46
|
snk-taskbar --> snk-actions-button
|
|
55
|
-
snk-taskbar --> taskbar-actions-button
|
|
56
47
|
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
|
|
61
48
|
snk-crud --> snk-attach
|
|
62
49
|
snk-detail-view --> snk-attach
|
|
63
50
|
style snk-attach fill:#f9f,stroke:#333,stroke-width:4px
|
|
@@ -56,14 +56,12 @@ 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)
|
|
60
59
|
|
|
61
60
|
### Graph
|
|
62
61
|
```mermaid
|
|
63
62
|
graph TD;
|
|
64
63
|
snk-crud --> snk-configurator
|
|
65
64
|
snk-guides-viewer --> snk-configurator
|
|
66
|
-
snk-simple-crud --> snk-configurator
|
|
67
65
|
style snk-configurator fill:#f9f,stroke:#333,stroke-width:4px
|
|
68
66
|
```
|
|
69
67
|
|
|
@@ -7,24 +7,19 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `actionsList`
|
|
13
|
-
| `configName`
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
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` |
|
|
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` |
|
|
28
23
|
|
|
29
24
|
|
|
30
25
|
## Events
|
|
@@ -100,7 +95,6 @@ Type: `Promise<void>`
|
|
|
100
95
|
- [snk-configurator](../snk-configurator)
|
|
101
96
|
- [snk-data-exporter](../snk-data-exporter)
|
|
102
97
|
- [snk-actions-button](../snk-actions-button)
|
|
103
|
-
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
|
104
98
|
|
|
105
99
|
### Graph
|
|
106
100
|
```mermaid
|
|
@@ -111,13 +105,11 @@ graph TD;
|
|
|
111
105
|
snk-crud --> snk-configurator
|
|
112
106
|
snk-crud --> snk-data-exporter
|
|
113
107
|
snk-crud --> snk-actions-button
|
|
114
|
-
snk-crud --> taskbar-actions-button
|
|
115
108
|
snk-grid --> snk-filter-bar
|
|
116
109
|
snk-grid --> snk-taskbar
|
|
117
110
|
snk-grid --> snk-grid-config
|
|
118
111
|
snk-grid --> snk-data-exporter
|
|
119
112
|
snk-grid --> snk-actions-button
|
|
120
|
-
snk-grid --> taskbar-actions-button
|
|
121
113
|
snk-filter-bar --> snk-filter-item
|
|
122
114
|
snk-filter-bar --> snk-personalized-filter
|
|
123
115
|
snk-filter-item --> snk-filter-detail
|
|
@@ -132,7 +124,6 @@ graph TD;
|
|
|
132
124
|
snk-expression-item --> snk-filter-param-config
|
|
133
125
|
snk-taskbar --> snk-data-exporter
|
|
134
126
|
snk-taskbar --> snk-actions-button
|
|
135
|
-
snk-taskbar --> taskbar-actions-button
|
|
136
127
|
snk-data-exporter --> snk-exporter-email-sender
|
|
137
128
|
snk-grid-config --> snk-select-box
|
|
138
129
|
snk-guides-viewer --> snk-form-view
|
|
@@ -143,7 +134,6 @@ graph TD;
|
|
|
143
134
|
snk-guides-viewer --> snk-configurator
|
|
144
135
|
snk-guides-viewer --> snk-data-exporter
|
|
145
136
|
snk-guides-viewer --> snk-actions-button
|
|
146
|
-
snk-guides-viewer --> taskbar-actions-button
|
|
147
137
|
snk-form-view --> snk-form-summary
|
|
148
138
|
snk-detail-view --> snk-data-unit
|
|
149
139
|
snk-detail-view --> snk-grid
|
|
@@ -152,17 +142,12 @@ graph TD;
|
|
|
152
142
|
snk-detail-view --> snk-attach
|
|
153
143
|
snk-detail-view --> snk-data-exporter
|
|
154
144
|
snk-detail-view --> snk-actions-button
|
|
155
|
-
snk-detail-view --> taskbar-actions-button
|
|
156
145
|
snk-attach --> snk-simple-bar
|
|
157
146
|
snk-attach --> snk-simple-crud
|
|
158
147
|
snk-simple-crud --> snk-data-unit
|
|
159
148
|
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
|
|
163
149
|
snk-simple-crud --> snk-data-exporter
|
|
164
150
|
snk-simple-crud --> snk-actions-button
|
|
165
|
-
snk-simple-crud --> taskbar-actions-button
|
|
166
151
|
snk-form-config --> snk-field-config
|
|
167
152
|
snk-form-config --> snk-config-options
|
|
168
153
|
snk-form-config --> snk-tab-config
|
|
@@ -7,23 +7,22 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description | Type
|
|
11
|
-
| -------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------- |
|
|
12
|
-
| `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]`
|
|
13
|
-
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean`
|
|
14
|
-
| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string`
|
|
15
|
-
| `dataState` | -- | Representa o estado do dataUnit master. | `DataState`
|
|
16
|
-
| `dataUnit` | -- | Instância do DataUnit master. | `DataUnit`
|
|
17
|
-
| `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string`
|
|
18
|
-
| `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string`
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | ----------- |
|
|
12
|
+
| `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
|
13
|
+
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
|
14
|
+
| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
|
|
15
|
+
| `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
|
|
16
|
+
| `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
|
|
17
|
+
| `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
|
|
18
|
+
| `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
|
|
19
|
+
| `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
|
|
20
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
21
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `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` |
|
|
27
26
|
|
|
28
27
|
|
|
29
28
|
## Events
|
|
@@ -70,11 +69,10 @@ Type: `Promise<void>`
|
|
|
70
69
|
- [snk-data-unit](../../snk-data-unit)
|
|
71
70
|
- [snk-detail-view](snk-detail-view)
|
|
72
71
|
- [snk-taskbar](../../snk-taskbar)
|
|
73
|
-
- [snk-form-config](../../snk-form-config)
|
|
72
|
+
- [snk-form-config](../../snk-form/subcomponents/snk-form-config)
|
|
74
73
|
- [snk-configurator](../../snk-configurator)
|
|
75
74
|
- [snk-data-exporter](../../snk-data-exporter)
|
|
76
75
|
- [snk-actions-button](../../snk-actions-button)
|
|
77
|
-
- [taskbar-actions-button](../../snk-taskbar/elements/taskbar-actions-button)
|
|
78
76
|
|
|
79
77
|
### Graph
|
|
80
78
|
```mermaid
|
|
@@ -87,7 +85,6 @@ graph TD;
|
|
|
87
85
|
snk-guides-viewer --> snk-configurator
|
|
88
86
|
snk-guides-viewer --> snk-data-exporter
|
|
89
87
|
snk-guides-viewer --> snk-actions-button
|
|
90
|
-
snk-guides-viewer --> taskbar-actions-button
|
|
91
88
|
snk-form-view --> snk-form-summary
|
|
92
89
|
snk-detail-view --> snk-data-unit
|
|
93
90
|
snk-detail-view --> snk-grid
|
|
@@ -96,13 +93,11 @@ graph TD;
|
|
|
96
93
|
snk-detail-view --> snk-attach
|
|
97
94
|
snk-detail-view --> snk-data-exporter
|
|
98
95
|
snk-detail-view --> snk-actions-button
|
|
99
|
-
snk-detail-view --> taskbar-actions-button
|
|
100
96
|
snk-grid --> snk-filter-bar
|
|
101
97
|
snk-grid --> snk-taskbar
|
|
102
98
|
snk-grid --> snk-grid-config
|
|
103
99
|
snk-grid --> snk-data-exporter
|
|
104
100
|
snk-grid --> snk-actions-button
|
|
105
|
-
snk-grid --> taskbar-actions-button
|
|
106
101
|
snk-filter-bar --> snk-filter-item
|
|
107
102
|
snk-filter-bar --> snk-personalized-filter
|
|
108
103
|
snk-filter-item --> snk-filter-detail
|
|
@@ -117,19 +112,14 @@ graph TD;
|
|
|
117
112
|
snk-expression-item --> snk-filter-param-config
|
|
118
113
|
snk-taskbar --> snk-data-exporter
|
|
119
114
|
snk-taskbar --> snk-actions-button
|
|
120
|
-
snk-taskbar --> taskbar-actions-button
|
|
121
115
|
snk-data-exporter --> snk-exporter-email-sender
|
|
122
116
|
snk-grid-config --> snk-select-box
|
|
123
117
|
snk-attach --> snk-simple-bar
|
|
124
118
|
snk-attach --> snk-simple-crud
|
|
125
119
|
snk-simple-crud --> snk-data-unit
|
|
126
120
|
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
|
|
130
121
|
snk-simple-crud --> snk-data-exporter
|
|
131
122
|
snk-simple-crud --> snk-actions-button
|
|
132
|
-
snk-simple-crud --> taskbar-actions-button
|
|
133
123
|
snk-form-config --> snk-field-config
|
|
134
124
|
snk-form-config --> snk-config-options
|
|
135
125
|
snk-form-config --> snk-tab-config
|
|
@@ -81,7 +81,6 @@ 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)
|
|
85
84
|
|
|
86
85
|
### Graph
|
|
87
86
|
```mermaid
|
|
@@ -93,13 +92,11 @@ graph TD;
|
|
|
93
92
|
snk-detail-view --> snk-attach
|
|
94
93
|
snk-detail-view --> snk-data-exporter
|
|
95
94
|
snk-detail-view --> snk-actions-button
|
|
96
|
-
snk-detail-view --> taskbar-actions-button
|
|
97
95
|
snk-grid --> snk-filter-bar
|
|
98
96
|
snk-grid --> snk-taskbar
|
|
99
97
|
snk-grid --> snk-grid-config
|
|
100
98
|
snk-grid --> snk-data-exporter
|
|
101
99
|
snk-grid --> snk-actions-button
|
|
102
|
-
snk-grid --> taskbar-actions-button
|
|
103
100
|
snk-filter-bar --> snk-filter-item
|
|
104
101
|
snk-filter-bar --> snk-personalized-filter
|
|
105
102
|
snk-filter-item --> snk-filter-detail
|
|
@@ -114,7 +111,6 @@ graph TD;
|
|
|
114
111
|
snk-expression-item --> snk-filter-param-config
|
|
115
112
|
snk-taskbar --> snk-data-exporter
|
|
116
113
|
snk-taskbar --> snk-actions-button
|
|
117
|
-
snk-taskbar --> taskbar-actions-button
|
|
118
114
|
snk-data-exporter --> snk-exporter-email-sender
|
|
119
115
|
snk-grid-config --> snk-select-box
|
|
120
116
|
snk-form-view --> snk-form-summary
|
|
@@ -122,15 +118,8 @@ graph TD;
|
|
|
122
118
|
snk-attach --> snk-simple-crud
|
|
123
119
|
snk-simple-crud --> snk-data-unit
|
|
124
120
|
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
|
|
128
121
|
snk-simple-crud --> snk-data-exporter
|
|
129
122
|
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
|
|
134
123
|
snk-guides-viewer --> snk-detail-view
|
|
135
124
|
style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
|
|
136
125
|
```
|
|
@@ -7,11 +7,10 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute
|
|
11
|
-
| ------------ |
|
|
12
|
-
| `config` | --
|
|
13
|
-
| `getMessage` | --
|
|
14
|
-
| `showChips` | `show-chips` | Usado para controlar a visibilidade dos chips de filtros | `boolean` | `true` |
|
|
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` |
|
|
15
14
|
|
|
16
15
|
|
|
17
16
|
## Events
|
|
@@ -7,18 +7,17 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `addPersonalizedFilter`
|
|
13
|
-
| `applyFilters`
|
|
14
|
-
| `closeModal`
|
|
15
|
-
| `configName`
|
|
16
|
-
| `deletePersonalizedFilter`
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------------------------- | ------------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------- | ----------- |
|
|
12
|
+
| `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `() => void` | `undefined` |
|
|
13
|
+
| `applyFilters` | -- | Ação executada ao aplicar os filtros | `(updatedFilterConfig: SnkFilterItemConfig[]) => void` | `undefined` |
|
|
14
|
+
| `closeModal` | -- | Ação disparada ao fechar o modal | `() => void` | `undefined` |
|
|
15
|
+
| `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
|
|
16
|
+
| `deletePersonalizedFilter` | -- | Ação executada ao deletar um filtro personalizado | `(filter: IPersonalizedFilter, configName: string) => void` | `undefined` |
|
|
17
|
+
| `editPersonalizedFilter` | -- | Ação executada ao editar um filtro personalizado | `(id: string) => void` | `undefined` |
|
|
18
|
+
| `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
|
|
19
|
+
| `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
|
|
20
|
+
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
|
22
21
|
|
|
23
22
|
|
|
24
23
|
## Dependencies
|
|
@@ -7,17 +7,13 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `configName`
|
|
13
|
-
| `dataUnit`
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
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` |
|
|
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` |
|
|
21
17
|
|
|
22
18
|
|
|
23
19
|
## Events
|
|
@@ -69,16 +65,6 @@ Type: `Promise<SnkFilterItemConfig>`
|
|
|
69
65
|
|
|
70
66
|
- Retorna o item de filtro removido, ou undefined caso não encontrado.
|
|
71
67
|
|
|
72
|
-
### `showFilterModal() => Promise<void>`
|
|
73
|
-
|
|
74
|
-
Abre o modal de filtros
|
|
75
|
-
|
|
76
|
-
#### Returns
|
|
77
|
-
|
|
78
|
-
Type: `Promise<void>`
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
68
|
### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
|
|
83
69
|
|
|
84
70
|
Atualiza um item do filtro.
|
|
@@ -7,13 +7,12 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `configName`
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
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` | 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` |
|
|
17
16
|
|
|
18
17
|
|
|
19
18
|
## Events
|
|
@@ -52,7 +51,7 @@ Type: `Promise<void>`
|
|
|
52
51
|
|
|
53
52
|
### Depends on
|
|
54
53
|
|
|
55
|
-
- [snk-form-config](
|
|
54
|
+
- [snk-form-config](./subcomponents/snk-form-config)
|
|
56
55
|
|
|
57
56
|
### Graph
|
|
58
57
|
```mermaid
|
|
@@ -26,15 +26,14 @@
|
|
|
26
26
|
|
|
27
27
|
### Used by
|
|
28
28
|
|
|
29
|
-
- [snk-form](
|
|
30
|
-
- [snk-guides-viewer](
|
|
31
|
-
- [snk-simple-crud](../snk-simple-crud)
|
|
29
|
+
- [snk-form](../..)
|
|
30
|
+
- [snk-guides-viewer](../../../snk-crud/subcomponents)
|
|
32
31
|
|
|
33
32
|
### Depends on
|
|
34
33
|
|
|
35
|
-
- [snk-field-config](
|
|
36
|
-
- [snk-config-options](
|
|
37
|
-
- [snk-tab-config](
|
|
34
|
+
- [snk-field-config](../snk-field-config)
|
|
35
|
+
- [snk-config-options](../snk-config-options)
|
|
36
|
+
- [snk-tab-config](../snk-tab-config)
|
|
38
37
|
|
|
39
38
|
### Graph
|
|
40
39
|
```mermaid
|
|
@@ -44,7 +43,6 @@ graph TD;
|
|
|
44
43
|
snk-form-config --> snk-tab-config
|
|
45
44
|
snk-form --> snk-form-config
|
|
46
45
|
snk-guides-viewer --> snk-form-config
|
|
47
|
-
snk-simple-crud --> snk-form-config
|
|
48
46
|
style snk-form-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
49
47
|
```
|
|
50
48
|
|
|
@@ -7,29 +7,25 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `actionsList`
|
|
13
|
-
| `canEdit`
|
|
14
|
-
| `columnFilterDataSource`
|
|
15
|
-
| `configName`
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
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` |
|
|
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` |
|
|
33
29
|
|
|
34
30
|
|
|
35
31
|
## Events
|
|
@@ -114,10 +110,9 @@ Type: `Promise<void>`
|
|
|
114
110
|
|
|
115
111
|
- [snk-filter-bar](../snk-filter-bar)
|
|
116
112
|
- [snk-taskbar](../snk-taskbar)
|
|
117
|
-
- [snk-grid-config](
|
|
113
|
+
- [snk-grid-config](./subcomponents/snk-grid-config)
|
|
118
114
|
- [snk-data-exporter](../snk-data-exporter)
|
|
119
115
|
- [snk-actions-button](../snk-actions-button)
|
|
120
|
-
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
|
121
116
|
|
|
122
117
|
### Graph
|
|
123
118
|
```mermaid
|
|
@@ -127,7 +122,6 @@ graph TD;
|
|
|
127
122
|
snk-grid --> snk-grid-config
|
|
128
123
|
snk-grid --> snk-data-exporter
|
|
129
124
|
snk-grid --> snk-actions-button
|
|
130
|
-
snk-grid --> taskbar-actions-button
|
|
131
125
|
snk-filter-bar --> snk-filter-item
|
|
132
126
|
snk-filter-bar --> snk-personalized-filter
|
|
133
127
|
snk-filter-item --> snk-filter-detail
|
|
@@ -142,7 +136,6 @@ graph TD;
|
|
|
142
136
|
snk-expression-item --> snk-filter-param-config
|
|
143
137
|
snk-taskbar --> snk-data-exporter
|
|
144
138
|
snk-taskbar --> snk-actions-button
|
|
145
|
-
snk-taskbar --> taskbar-actions-button
|
|
146
139
|
snk-data-exporter --> snk-exporter-email-sender
|
|
147
140
|
snk-grid-config --> snk-select-box
|
|
148
141
|
snk-crud --> snk-grid
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
|
11
11
|
| --------------- | ---------------- | ------------------------------------------------ | ---------------- | ----------- |
|
|
12
|
+
| `application` | -- | Referência para o SnkApplication | `SnkApplication` | `undefined` |
|
|
12
13
|
| `columns` | -- | Colunas da grade. | `EzGridColumn[]` | `undefined` |
|
|
13
14
|
| `config` | -- | Configurações da grade. | `IGridConfig` | `undefined` |
|
|
14
15
|
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
|
@@ -28,19 +29,17 @@
|
|
|
28
29
|
|
|
29
30
|
### Used by
|
|
30
31
|
|
|
31
|
-
- [snk-grid](
|
|
32
|
-
- [snk-simple-crud](../snk-simple-crud)
|
|
32
|
+
- [snk-grid](../..)
|
|
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
|
|
44
43
|
style snk-grid-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
45
44
|
```
|
|
46
45
|
|
|
@@ -7,51 +7,32 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
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` |
|
|
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` |
|
|
29
22
|
|
|
30
23
|
|
|
31
24
|
## Events
|
|
32
25
|
|
|
33
|
-
| Event
|
|
34
|
-
|
|
|
35
|
-
| `actionClick`
|
|
36
|
-
| `
|
|
37
|
-
| `
|
|
38
|
-
| `
|
|
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[]>` |
|
|
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[]>` |
|
|
41
32
|
|
|
42
33
|
|
|
43
34
|
## Methods
|
|
44
35
|
|
|
45
|
-
### `closeConfigurator() => Promise<void>`
|
|
46
|
-
|
|
47
|
-
Usado para fechar o configurator do CRUD
|
|
48
|
-
|
|
49
|
-
#### Returns
|
|
50
|
-
|
|
51
|
-
Type: `Promise<void>`
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
36
|
### `getRecords() => Promise<Array<Record>>`
|
|
56
37
|
|
|
57
38
|
|
|
@@ -72,16 +53,6 @@ Type: `Promise<void>`
|
|
|
72
53
|
|
|
73
54
|
|
|
74
55
|
|
|
75
|
-
### `openConfigurator() => Promise<void>`
|
|
76
|
-
|
|
77
|
-
Usado para abrir o configurator do CRUD
|
|
78
|
-
|
|
79
|
-
#### Returns
|
|
80
|
-
|
|
81
|
-
Type: `Promise<void>`
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
56
|
### `setMetadata(metadata: UnitMetadata) => Promise<void>`
|
|
86
57
|
|
|
87
58
|
|
|
@@ -102,16 +73,6 @@ Type: `Promise<void>`
|
|
|
102
73
|
|
|
103
74
|
|
|
104
75
|
|
|
105
|
-
### `updateConfig() => Promise<void>`
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
#### Returns
|
|
110
|
-
|
|
111
|
-
Type: `Promise<void>`
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
76
|
|
|
116
77
|
## Dependencies
|
|
117
78
|
|
|
@@ -123,32 +84,19 @@ Type: `Promise<void>`
|
|
|
123
84
|
|
|
124
85
|
- [snk-data-unit](../snk-data-unit)
|
|
125
86
|
- [snk-taskbar](../snk-taskbar)
|
|
126
|
-
- [snk-form-config](../snk-form-config)
|
|
127
|
-
- [snk-configurator](../snk-configurator)
|
|
128
|
-
- [snk-grid-config](../snk-grid-config)
|
|
129
87
|
- [snk-data-exporter](../snk-data-exporter)
|
|
130
88
|
- [snk-actions-button](../snk-actions-button)
|
|
131
|
-
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
|
132
89
|
|
|
133
90
|
### Graph
|
|
134
91
|
```mermaid
|
|
135
92
|
graph TD;
|
|
136
93
|
snk-simple-crud --> snk-data-unit
|
|
137
94
|
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
|
|
141
95
|
snk-simple-crud --> snk-data-exporter
|
|
142
96
|
snk-simple-crud --> snk-actions-button
|
|
143
|
-
snk-simple-crud --> taskbar-actions-button
|
|
144
97
|
snk-taskbar --> snk-data-exporter
|
|
145
98
|
snk-taskbar --> snk-actions-button
|
|
146
|
-
snk-taskbar --> taskbar-actions-button
|
|
147
99
|
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
|
|
152
100
|
snk-attach --> snk-simple-crud
|
|
153
101
|
style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
|
|
154
102
|
```
|
|
@@ -7,22 +7,20 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description | Type
|
|
11
|
-
| ------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
12
|
-
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]`
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
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
|
+
| `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` |
|
|
26
24
|
|
|
27
25
|
|
|
28
26
|
## Events
|
|
@@ -45,14 +43,12 @@
|
|
|
45
43
|
|
|
46
44
|
- [snk-data-exporter](../snk-data-exporter)
|
|
47
45
|
- [snk-actions-button](../snk-actions-button)
|
|
48
|
-
- [taskbar-actions-button](./elements/taskbar-actions-button)
|
|
49
46
|
|
|
50
47
|
### Graph
|
|
51
48
|
```mermaid
|
|
52
49
|
graph TD;
|
|
53
50
|
snk-taskbar --> snk-data-exporter
|
|
54
51
|
snk-taskbar --> snk-actions-button
|
|
55
|
-
snk-taskbar --> taskbar-actions-button
|
|
56
52
|
snk-data-exporter --> snk-exporter-email-sender
|
|
57
53
|
snk-detail-view --> snk-taskbar
|
|
58
54
|
snk-grid --> snk-taskbar
|
package/package.json
CHANGED
|
@@ -1,84 +0,0 @@
|
|
|
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
|
-
|