@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-rc-KB-42443.1 → 0.0.0-hotfix-ga-5335021.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 +2 -12
- package/components/snk-attach/readme.md +5 -11
- package/components/snk-crud/readme.md +13 -20
- package/components/snk-crud/subcomponents/readme.md +16 -22
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +0 -5
- package/components/snk-filter-bar/filter-modal/readme.md +11 -12
- package/components/snk-filter-bar/readme.md +7 -8
- package/components/snk-grid/readme.md +19 -22
- package/components/snk-simple-crud/readme.md +0 -5
- package/components/snk-taskbar/readme.md +14 -16
- package/package.json +1 -1
- package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +0 -84
@@ -132,7 +132,7 @@ Ex.: snk-config-options
|
|
132
132
|
|
133
133
|
#### Returns
|
134
134
|
|
135
|
-
Type: `Promise<
|
135
|
+
Type: `Promise<IOption | IOption[]>`
|
136
136
|
|
137
137
|
|
138
138
|
|
@@ -143,7 +143,7 @@ Ex.: snk-config-options
|
|
143
143
|
|
144
144
|
#### Returns
|
145
145
|
|
146
|
-
Type: `Promise<
|
146
|
+
Type: `Promise<IOption | IOption[]>`
|
147
147
|
|
148
148
|
|
149
149
|
|
@@ -439,16 +439,6 @@ Type: `Promise<any>`
|
|
439
439
|
|
440
440
|
|
441
441
|
|
442
|
-
### `setSearchFilterContext(name: string, value: string) => Promise<void>`
|
443
|
-
|
444
|
-
Atribui valor para parâmetros de contexto no componente de pesquisa.
|
445
|
-
|
446
|
-
#### Returns
|
447
|
-
|
448
|
-
Type: `Promise<void>`
|
449
|
-
|
450
|
-
|
451
|
-
|
452
442
|
### `showAlerts(alerts: Array<AlertItem>) => Promise<void>`
|
453
443
|
|
454
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"` | `"AnexoSistema"` |
|
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
|
@@ -46,10 +42,8 @@ graph TD;
|
|
46
42
|
snk-simple-crud --> snk-taskbar
|
47
43
|
snk-simple-crud --> snk-data-exporter
|
48
44
|
snk-simple-crud --> snk-actions-button
|
49
|
-
snk-simple-crud --> taskbar-actions-button
|
50
45
|
snk-taskbar --> snk-data-exporter
|
51
46
|
snk-taskbar --> snk-actions-button
|
52
|
-
snk-taskbar --> taskbar-actions-button
|
53
47
|
snk-data-exporter --> snk-exporter-email-sender
|
54
48
|
snk-crud --> snk-attach
|
55
49
|
snk-detail-view --> snk-attach
|
@@ -7,19 +7,19 @@
|
|
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
|
-
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string`
|
14
|
-
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder`
|
15
|
-
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean`
|
16
|
-
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY
|
17
|
-
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator`
|
18
|
-
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig`
|
19
|
-
| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean`
|
20
|
-
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver`
|
21
|
-
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager`
|
22
|
-
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean`
|
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` |
|
23
23
|
|
24
24
|
|
25
25
|
## Events
|
@@ -95,7 +95,6 @@ Type: `Promise<void>`
|
|
95
95
|
- [snk-configurator](../snk-configurator)
|
96
96
|
- [snk-data-exporter](../snk-data-exporter)
|
97
97
|
- [snk-actions-button](../snk-actions-button)
|
98
|
-
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
99
98
|
|
100
99
|
### Graph
|
101
100
|
```mermaid
|
@@ -106,13 +105,11 @@ graph TD;
|
|
106
105
|
snk-crud --> snk-configurator
|
107
106
|
snk-crud --> snk-data-exporter
|
108
107
|
snk-crud --> snk-actions-button
|
109
|
-
snk-crud --> taskbar-actions-button
|
110
108
|
snk-grid --> snk-filter-bar
|
111
109
|
snk-grid --> snk-taskbar
|
112
110
|
snk-grid --> snk-grid-config
|
113
111
|
snk-grid --> snk-data-exporter
|
114
112
|
snk-grid --> snk-actions-button
|
115
|
-
snk-grid --> taskbar-actions-button
|
116
113
|
snk-filter-bar --> snk-filter-item
|
117
114
|
snk-filter-bar --> snk-personalized-filter
|
118
115
|
snk-filter-item --> snk-filter-detail
|
@@ -127,7 +124,6 @@ graph TD;
|
|
127
124
|
snk-expression-item --> snk-filter-param-config
|
128
125
|
snk-taskbar --> snk-data-exporter
|
129
126
|
snk-taskbar --> snk-actions-button
|
130
|
-
snk-taskbar --> taskbar-actions-button
|
131
127
|
snk-data-exporter --> snk-exporter-email-sender
|
132
128
|
snk-grid-config --> snk-select-box
|
133
129
|
snk-guides-viewer --> snk-form-view
|
@@ -138,7 +134,6 @@ graph TD;
|
|
138
134
|
snk-guides-viewer --> snk-configurator
|
139
135
|
snk-guides-viewer --> snk-data-exporter
|
140
136
|
snk-guides-viewer --> snk-actions-button
|
141
|
-
snk-guides-viewer --> taskbar-actions-button
|
142
137
|
snk-form-view --> snk-form-summary
|
143
138
|
snk-detail-view --> snk-data-unit
|
144
139
|
snk-detail-view --> snk-grid
|
@@ -147,14 +142,12 @@ graph TD;
|
|
147
142
|
snk-detail-view --> snk-attach
|
148
143
|
snk-detail-view --> snk-data-exporter
|
149
144
|
snk-detail-view --> snk-actions-button
|
150
|
-
snk-detail-view --> taskbar-actions-button
|
151
145
|
snk-attach --> snk-simple-bar
|
152
146
|
snk-attach --> snk-simple-crud
|
153
147
|
snk-simple-crud --> snk-data-unit
|
154
148
|
snk-simple-crud --> snk-taskbar
|
155
149
|
snk-simple-crud --> snk-data-exporter
|
156
150
|
snk-simple-crud --> snk-actions-button
|
157
|
-
snk-simple-crud --> taskbar-actions-button
|
158
151
|
snk-form-config --> snk-field-config
|
159
152
|
snk-form-config --> snk-config-options
|
160
153
|
snk-form-config --> snk-tab-config
|
@@ -7,22 +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
|
-
| `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig`
|
20
|
-
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder`
|
21
|
-
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY
|
22
|
-
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator`
|
23
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string`
|
24
|
-
| `selectedGuide` | -- | Guia selecionada. | `IGuideItem`
|
25
|
-
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager`
|
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` |
|
26
26
|
|
27
27
|
|
28
28
|
## Events
|
@@ -73,7 +73,6 @@ Type: `Promise<void>`
|
|
73
73
|
- [snk-configurator](../../snk-configurator)
|
74
74
|
- [snk-data-exporter](../../snk-data-exporter)
|
75
75
|
- [snk-actions-button](../../snk-actions-button)
|
76
|
-
- [taskbar-actions-button](../../snk-taskbar/elements/taskbar-actions-button)
|
77
76
|
|
78
77
|
### Graph
|
79
78
|
```mermaid
|
@@ -86,7 +85,6 @@ graph TD;
|
|
86
85
|
snk-guides-viewer --> snk-configurator
|
87
86
|
snk-guides-viewer --> snk-data-exporter
|
88
87
|
snk-guides-viewer --> snk-actions-button
|
89
|
-
snk-guides-viewer --> taskbar-actions-button
|
90
88
|
snk-form-view --> snk-form-summary
|
91
89
|
snk-detail-view --> snk-data-unit
|
92
90
|
snk-detail-view --> snk-grid
|
@@ -95,13 +93,11 @@ graph TD;
|
|
95
93
|
snk-detail-view --> snk-attach
|
96
94
|
snk-detail-view --> snk-data-exporter
|
97
95
|
snk-detail-view --> snk-actions-button
|
98
|
-
snk-detail-view --> taskbar-actions-button
|
99
96
|
snk-grid --> snk-filter-bar
|
100
97
|
snk-grid --> snk-taskbar
|
101
98
|
snk-grid --> snk-grid-config
|
102
99
|
snk-grid --> snk-data-exporter
|
103
100
|
snk-grid --> snk-actions-button
|
104
|
-
snk-grid --> taskbar-actions-button
|
105
101
|
snk-filter-bar --> snk-filter-item
|
106
102
|
snk-filter-bar --> snk-personalized-filter
|
107
103
|
snk-filter-item --> snk-filter-detail
|
@@ -116,7 +112,6 @@ graph TD;
|
|
116
112
|
snk-expression-item --> snk-filter-param-config
|
117
113
|
snk-taskbar --> snk-data-exporter
|
118
114
|
snk-taskbar --> snk-actions-button
|
119
|
-
snk-taskbar --> taskbar-actions-button
|
120
115
|
snk-data-exporter --> snk-exporter-email-sender
|
121
116
|
snk-grid-config --> snk-select-box
|
122
117
|
snk-attach --> snk-simple-bar
|
@@ -125,7 +120,6 @@ graph TD;
|
|
125
120
|
snk-simple-crud --> snk-taskbar
|
126
121
|
snk-simple-crud --> snk-data-exporter
|
127
122
|
snk-simple-crud --> snk-actions-button
|
128
|
-
snk-simple-crud --> taskbar-actions-button
|
129
123
|
snk-form-config --> snk-field-config
|
130
124
|
snk-form-config --> snk-config-options
|
131
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
|
@@ -124,7 +120,6 @@ graph TD;
|
|
124
120
|
snk-simple-crud --> snk-taskbar
|
125
121
|
snk-simple-crud --> snk-data-exporter
|
126
122
|
snk-simple-crud --> snk-actions-button
|
127
|
-
snk-simple-crud --> taskbar-actions-button
|
128
123
|
snk-guides-viewer --> snk-detail-view
|
129
124
|
style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
|
130
125
|
```
|
@@ -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,14 +7,13 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `configName`
|
13
|
-
| `dataUnit`
|
14
|
-
| `
|
15
|
-
| `
|
16
|
-
| `
|
17
|
-
| `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
|
+
| `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` |
|
18
17
|
|
19
18
|
|
20
19
|
## Events
|
@@ -7,25 +7,25 @@
|
|
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
|
-
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean`
|
14
|
-
| `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource`
|
15
|
-
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string`
|
16
|
-
| `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string`
|
17
|
-
| `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean`
|
18
|
-
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder`
|
19
|
-
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean`
|
20
|
-
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY
|
21
|
-
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator`
|
22
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string`
|
23
|
-
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig`
|
24
|
-
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver`
|
25
|
-
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string`
|
26
|
-
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager`
|
27
|
-
| `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string`
|
28
|
-
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean`
|
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` |
|
29
29
|
|
30
30
|
|
31
31
|
## Events
|
@@ -113,7 +113,6 @@ Type: `Promise<void>`
|
|
113
113
|
- [snk-grid-config](./subcomponents/snk-grid-config)
|
114
114
|
- [snk-data-exporter](../snk-data-exporter)
|
115
115
|
- [snk-actions-button](../snk-actions-button)
|
116
|
-
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
117
116
|
|
118
117
|
### Graph
|
119
118
|
```mermaid
|
@@ -123,7 +122,6 @@ graph TD;
|
|
123
122
|
snk-grid --> snk-grid-config
|
124
123
|
snk-grid --> snk-data-exporter
|
125
124
|
snk-grid --> snk-actions-button
|
126
|
-
snk-grid --> taskbar-actions-button
|
127
125
|
snk-filter-bar --> snk-filter-item
|
128
126
|
snk-filter-bar --> snk-personalized-filter
|
129
127
|
snk-filter-item --> snk-filter-detail
|
@@ -138,7 +136,6 @@ graph TD;
|
|
138
136
|
snk-expression-item --> snk-filter-param-config
|
139
137
|
snk-taskbar --> snk-data-exporter
|
140
138
|
snk-taskbar --> snk-actions-button
|
141
|
-
snk-taskbar --> taskbar-actions-button
|
142
139
|
snk-data-exporter --> snk-exporter-email-sender
|
143
140
|
snk-grid-config --> snk-select-box
|
144
141
|
snk-crud --> snk-grid
|
@@ -9,8 +9,6 @@
|
|
9
9
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
11
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
12
|
| `dataState` | -- | | `DataState` | `undefined` |
|
15
13
|
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
16
14
|
| `formConfig` | -- | | `IFormConfig` | `undefined` |
|
@@ -88,7 +86,6 @@ Type: `Promise<void>`
|
|
88
86
|
- [snk-taskbar](../snk-taskbar)
|
89
87
|
- [snk-data-exporter](../snk-data-exporter)
|
90
88
|
- [snk-actions-button](../snk-actions-button)
|
91
|
-
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
92
89
|
|
93
90
|
### Graph
|
94
91
|
```mermaid
|
@@ -97,10 +94,8 @@ graph TD;
|
|
97
94
|
snk-simple-crud --> snk-taskbar
|
98
95
|
snk-simple-crud --> snk-data-exporter
|
99
96
|
snk-simple-crud --> snk-actions-button
|
100
|
-
snk-simple-crud --> taskbar-actions-button
|
101
97
|
snk-taskbar --> snk-data-exporter
|
102
98
|
snk-taskbar --> snk-actions-button
|
103
|
-
snk-taskbar --> taskbar-actions-button
|
104
99
|
snk-data-exporter --> snk-exporter-email-sender
|
105
100
|
snk-attach --> snk-simple-crud
|
106
101
|
style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
|
@@ -7,20 +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
|
-
| `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string`
|
14
|
-
| `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string`
|
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>`
|
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`
|
17
|
-
| `customSlotId` | `custom-slot-id` | Usado para determinar o identificador do slot que recebe elementos personalizados. | `string`
|
18
|
-
| `dataUnit` | -- | Instância do DataUnit. | `DataUnit`
|
19
|
-
| `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]`
|
20
|
-
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder`
|
21
|
-
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY
|
22
|
-
| `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string`
|
23
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string`
|
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` |
|
24
24
|
|
25
25
|
|
26
26
|
## Events
|
@@ -43,14 +43,12 @@
|
|
43
43
|
|
44
44
|
- [snk-data-exporter](../snk-data-exporter)
|
45
45
|
- [snk-actions-button](../snk-actions-button)
|
46
|
-
- [taskbar-actions-button](./elements/taskbar-actions-button)
|
47
46
|
|
48
47
|
### Graph
|
49
48
|
```mermaid
|
50
49
|
graph TD;
|
51
50
|
snk-taskbar --> snk-data-exporter
|
52
51
|
snk-taskbar --> snk-actions-button
|
53
|
-
snk-taskbar --> taskbar-actions-button
|
54
52
|
snk-data-exporter --> snk-exporter-email-sender
|
55
53
|
snk-detail-view --> snk-taskbar
|
56
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
|
-
|