@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-5321704.1 → 0.0.0-hotfix-rc-KB-46291.1

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 (12) hide show
  1. package/components/snk-application/readme.md +10 -0
  2. package/components/snk-attach/readme.md +11 -5
  3. package/components/snk-crud/readme.md +22 -13
  4. package/components/snk-crud/subcomponents/readme.md +22 -16
  5. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +5 -0
  6. package/components/snk-filter-bar/filter-modal/readme.md +12 -11
  7. package/components/snk-filter-bar/readme.md +20 -7
  8. package/components/snk-grid/readme.md +24 -19
  9. package/components/snk-simple-crud/readme.md +5 -0
  10. package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +84 -0
  11. package/components/snk-taskbar/readme.md +18 -14
  12. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -439,6 +439,16 @@ 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
+
442
452
  ### `showAlerts(alerts: Array<AlertItem>) => Promise<void>`
443
453
 
444
454
  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"` | `"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` |
15
19
 
16
20
 
17
21
  ## Events
@@ -42,8 +46,10 @@ graph TD;
42
46
  snk-simple-crud --> snk-taskbar
43
47
  snk-simple-crud --> snk-data-exporter
44
48
  snk-simple-crud --> snk-actions-button
49
+ snk-simple-crud --> taskbar-actions-button
45
50
  snk-taskbar --> snk-data-exporter
46
51
  snk-taskbar --> snk-actions-button
52
+ snk-taskbar --> taskbar-actions-button
47
53
  snk-data-exporter --> snk-exporter-email-sender
48
54
  snk-crud --> snk-attach
49
55
  snk-detail-view --> snk-attach
package/components/snk-crud/readme.md CHANGED
@@ -7,19 +7,21 @@
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
+ | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
16
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
18
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
19
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
20
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
21
+ | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
22
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
23
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
24
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
23
25
 
24
26
 
25
27
  ## Events
@@ -95,6 +97,7 @@ Type: `Promise<void>`
95
97
  - [snk-configurator](../snk-configurator)
96
98
  - [snk-data-exporter](../snk-data-exporter)
97
99
  - [snk-actions-button](../snk-actions-button)
100
+ - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
98
101
 
99
102
  ### Graph
100
103
  ```mermaid
@@ -105,11 +108,13 @@ graph TD;
105
108
  snk-crud --> snk-configurator
106
109
  snk-crud --> snk-data-exporter
107
110
  snk-crud --> snk-actions-button
111
+ snk-crud --> taskbar-actions-button
108
112
  snk-grid --> snk-filter-bar
109
113
  snk-grid --> snk-taskbar
110
114
  snk-grid --> snk-grid-config
111
115
  snk-grid --> snk-data-exporter
112
116
  snk-grid --> snk-actions-button
117
+ snk-grid --> taskbar-actions-button
113
118
  snk-filter-bar --> snk-filter-item
114
119
  snk-filter-bar --> snk-personalized-filter
115
120
  snk-filter-item --> snk-filter-detail
@@ -124,6 +129,7 @@ graph TD;
124
129
  snk-expression-item --> snk-filter-param-config
125
130
  snk-taskbar --> snk-data-exporter
126
131
  snk-taskbar --> snk-actions-button
132
+ snk-taskbar --> taskbar-actions-button
127
133
  snk-data-exporter --> snk-exporter-email-sender
128
134
  snk-grid-config --> snk-select-box
129
135
  snk-guides-viewer --> snk-form-view
@@ -134,6 +140,7 @@ graph TD;
134
140
  snk-guides-viewer --> snk-configurator
135
141
  snk-guides-viewer --> snk-data-exporter
136
142
  snk-guides-viewer --> snk-actions-button
143
+ snk-guides-viewer --> taskbar-actions-button
137
144
  snk-form-view --> snk-form-summary
138
145
  snk-detail-view --> snk-data-unit
139
146
  snk-detail-view --> snk-grid
@@ -142,12 +149,14 @@ graph TD;
142
149
  snk-detail-view --> snk-attach
143
150
  snk-detail-view --> snk-data-exporter
144
151
  snk-detail-view --> snk-actions-button
152
+ snk-detail-view --> taskbar-actions-button
145
153
  snk-attach --> snk-simple-bar
146
154
  snk-attach --> snk-simple-crud
147
155
  snk-simple-crud --> snk-data-unit
148
156
  snk-simple-crud --> snk-taskbar
149
157
  snk-simple-crud --> snk-data-exporter
150
158
  snk-simple-crud --> snk-actions-button
159
+ snk-simple-crud --> taskbar-actions-button
151
160
  snk-form-config --> snk-field-config
152
161
  snk-form-config --> snk-config-options
153
162
  snk-form-config --> snk-tab-config
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -7,22 +7,22 @@
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
+ | `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 \| PresentationMode.SINGLE_TASKBAR` | `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,6 +73,7 @@ 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)
76
77
 
77
78
  ### Graph
78
79
  ```mermaid
@@ -85,6 +86,7 @@ graph TD;
85
86
  snk-guides-viewer --> snk-configurator
86
87
  snk-guides-viewer --> snk-data-exporter
87
88
  snk-guides-viewer --> snk-actions-button
89
+ snk-guides-viewer --> taskbar-actions-button
88
90
  snk-form-view --> snk-form-summary
89
91
  snk-detail-view --> snk-data-unit
90
92
  snk-detail-view --> snk-grid
@@ -93,11 +95,13 @@ graph TD;
93
95
  snk-detail-view --> snk-attach
94
96
  snk-detail-view --> snk-data-exporter
95
97
  snk-detail-view --> snk-actions-button
98
+ snk-detail-view --> taskbar-actions-button
96
99
  snk-grid --> snk-filter-bar
97
100
  snk-grid --> snk-taskbar
98
101
  snk-grid --> snk-grid-config
99
102
  snk-grid --> snk-data-exporter
100
103
  snk-grid --> snk-actions-button
104
+ snk-grid --> taskbar-actions-button
101
105
  snk-filter-bar --> snk-filter-item
102
106
  snk-filter-bar --> snk-personalized-filter
103
107
  snk-filter-item --> snk-filter-detail
@@ -112,6 +116,7 @@ graph TD;
112
116
  snk-expression-item --> snk-filter-param-config
113
117
  snk-taskbar --> snk-data-exporter
114
118
  snk-taskbar --> snk-actions-button
119
+ snk-taskbar --> taskbar-actions-button
115
120
  snk-data-exporter --> snk-exporter-email-sender
116
121
  snk-grid-config --> snk-select-box
117
122
  snk-attach --> snk-simple-bar
@@ -120,6 +125,7 @@ graph TD;
120
125
  snk-simple-crud --> snk-taskbar
121
126
  snk-simple-crud --> snk-data-exporter
122
127
  snk-simple-crud --> snk-actions-button
128
+ snk-simple-crud --> taskbar-actions-button
123
129
  snk-form-config --> snk-field-config
124
130
  snk-form-config --> snk-config-options
125
131
  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
@@ -120,6 +124,7 @@ graph TD;
120
124
  snk-simple-crud --> snk-taskbar
121
125
  snk-simple-crud --> snk-data-exporter
122
126
  snk-simple-crud --> snk-actions-button
127
+ snk-simple-crud --> taskbar-actions-button
123
128
  snk-guides-viewer --> snk-detail-view
124
129
  style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
125
130
  ```
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,16 @@
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
+ | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
16
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
+ | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
18
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
19
+ | `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
17
20
 
18
21
 
19
22
  ## Events
@@ -65,6 +68,16 @@ Type: `Promise<SnkFilterItemConfig>`
65
68
 
66
69
  - Retorna o item de filtro removido, ou undefined caso não encontrado.
67
70
 
71
+ ### `showFilterModal() => Promise<void>`
72
+
73
+ Abre o modal de filtros
74
+
75
+ #### Returns
76
+
77
+ Type: `Promise<void>`
78
+
79
+
80
+
68
81
  ### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
69
82
 
70
83
  Atualiza um item do filtro.
package/components/snk-grid/readme.md CHANGED
@@ -7,25 +7,27 @@
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
+ | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
18
+ | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
19
+ | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
20
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
22
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
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
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
26
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
27
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
28
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
29
+ | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
30
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
29
31
 
30
32
 
31
33
  ## Events
@@ -113,6 +115,7 @@ Type: `Promise<void>`
113
115
  - [snk-grid-config](./subcomponents/snk-grid-config)
114
116
  - [snk-data-exporter](../snk-data-exporter)
115
117
  - [snk-actions-button](../snk-actions-button)
118
+ - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
116
119
 
117
120
  ### Graph
118
121
  ```mermaid
@@ -122,6 +125,7 @@ graph TD;
122
125
  snk-grid --> snk-grid-config
123
126
  snk-grid --> snk-data-exporter
124
127
  snk-grid --> snk-actions-button
128
+ snk-grid --> taskbar-actions-button
125
129
  snk-filter-bar --> snk-filter-item
126
130
  snk-filter-bar --> snk-personalized-filter
127
131
  snk-filter-item --> snk-filter-detail
@@ -136,6 +140,7 @@ graph TD;
136
140
  snk-expression-item --> snk-filter-param-config
137
141
  snk-taskbar --> snk-data-exporter
138
142
  snk-taskbar --> snk-actions-button
143
+ snk-taskbar --> taskbar-actions-button
139
144
  snk-data-exporter --> snk-exporter-email-sender
140
145
  snk-grid-config --> snk-select-box
141
146
  snk-crud --> snk-grid
package/components/snk-simple-crud/readme.md CHANGED
@@ -9,6 +9,8 @@
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` |
12
14
  | `dataState` | -- | | `DataState` | `undefined` |
13
15
  | `dataUnit` | -- | | `DataUnit` | `undefined` |
14
16
  | `formConfig` | -- | | `IFormConfig` | `undefined` |
@@ -86,6 +88,7 @@ Type: `Promise<void>`
86
88
  - [snk-taskbar](../snk-taskbar)
87
89
  - [snk-data-exporter](../snk-data-exporter)
88
90
  - [snk-actions-button](../snk-actions-button)
91
+ - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
89
92
 
90
93
  ### Graph
91
94
  ```mermaid
@@ -94,8 +97,10 @@ graph TD;
94
97
  snk-simple-crud --> snk-taskbar
95
98
  snk-simple-crud --> snk-data-exporter
96
99
  snk-simple-crud --> snk-actions-button
100
+ snk-simple-crud --> taskbar-actions-button
97
101
  snk-taskbar --> snk-data-exporter
98
102
  snk-taskbar --> snk-actions-button
103
+ snk-taskbar --> taskbar-actions-button
99
104
  snk-data-exporter --> snk-exporter-email-sender
100
105
  snk-attach --> snk-simple-crud
101
106
  style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
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-5321704.1",
3
+ "version": "0.0.0-hotfix-rc-KB-46291.1",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [