@sankhyalabs/sankhyablocks-docs 9.2.0-rc.1 → 9.2.0-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/components/snk-crud/readme.md +3 -0
  2. package/components/snk-crud/subcomponents/readme.md +3 -0
  3. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +3 -0
  4. package/components/snk-entity-list/readme.md +1 -0
  5. package/components/snk-filter-bar/filter-item/editors/readme.md +28 -4
  6. package/components/snk-filter-bar/filter-modal/readme.md +20 -13
  7. package/components/snk-filter-bar/readme.md +21 -15
  8. package/components/snk-grid/readme.md +10 -5
  9. package/package.json +1 -1
package/components/snk-crud/readme.md CHANGED
@@ -186,6 +186,7 @@ graph TD;
186
186
  snk-grid --> taskbar-actions-button
187
187
  snk-filter-bar --> snk-filter-item
188
188
  snk-filter-bar --> snk-personalized-filter
189
+ snk-filter-bar --> snk-filter-modal
189
190
  snk-filter-item --> snk-filter-detail
190
191
  snk-personalized-filter --> snk-filter-field-search
191
192
  snk-personalized-filter --> snk-filter-assistent-mode
@@ -196,6 +197,8 @@ graph TD;
196
197
  snk-expression-group --> snk-expression-group
197
198
  snk-expression-item --> snk-filter-field-search
198
199
  snk-expression-item --> snk-filter-param-config
200
+ snk-filter-modal --> snk-filter-modal-item
201
+ snk-filter-modal --> snk-default-filter
199
202
  snk-taskbar --> snk-data-exporter
200
203
  snk-taskbar --> snk-actions-button
201
204
  snk-taskbar --> taskbar-split-button
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -143,6 +143,7 @@ graph TD;
143
143
  snk-grid --> taskbar-actions-button
144
144
  snk-filter-bar --> snk-filter-item
145
145
  snk-filter-bar --> snk-personalized-filter
146
+ snk-filter-bar --> snk-filter-modal
146
147
  snk-filter-item --> snk-filter-detail
147
148
  snk-personalized-filter --> snk-filter-field-search
148
149
  snk-personalized-filter --> snk-filter-assistent-mode
@@ -153,6 +154,8 @@ graph TD;
153
154
  snk-expression-group --> snk-expression-group
154
155
  snk-expression-item --> snk-filter-field-search
155
156
  snk-expression-item --> snk-filter-param-config
157
+ snk-filter-modal --> snk-filter-modal-item
158
+ snk-filter-modal --> snk-default-filter
156
159
  snk-taskbar --> snk-data-exporter
157
160
  snk-taskbar --> snk-actions-button
158
161
  snk-taskbar --> taskbar-split-button
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -128,6 +128,7 @@ graph TD;
128
128
  snk-grid --> taskbar-actions-button
129
129
  snk-filter-bar --> snk-filter-item
130
130
  snk-filter-bar --> snk-personalized-filter
131
+ snk-filter-bar --> snk-filter-modal
131
132
  snk-filter-item --> snk-filter-detail
132
133
  snk-personalized-filter --> snk-filter-field-search
133
134
  snk-personalized-filter --> snk-filter-assistent-mode
@@ -138,6 +139,8 @@ graph TD;
138
139
  snk-expression-group --> snk-expression-group
139
140
  snk-expression-item --> snk-filter-field-search
140
141
  snk-expression-item --> snk-filter-param-config
142
+ snk-filter-modal --> snk-filter-modal-item
143
+ snk-filter-modal --> snk-default-filter
141
144
  snk-taskbar --> snk-data-exporter
142
145
  snk-taskbar --> snk-actions-button
143
146
  snk-taskbar --> taskbar-split-button
package/components/snk-entity-list/readme.md CHANGED
@@ -10,6 +10,7 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ---------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----------- |
12
12
  | `config` | -- | Configurações para carregar os dados do componente | `SnkFilterItemConfig` | `undefined` |
13
+ | `errorMessage` | `error-message` | Usado para exibir mensagens de erro. | `string` | `undefined` |
13
14
  | `maxHeightList` | `max-height-list` | Permite definir uma altura máxima para o ez-list, adicionando um scroll ao atingir esta medida | `string` | `""` |
14
15
  | `rightListSlotBuilder` | -- | Método que possibilita alterar como o item da lista vai ser apresentado. Observação: No React ele se transforma em VNode e não HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
15
16
  | `value` | -- | Define o valor do componente | `IOption` | `undefined` |
package/components/snk-filter-bar/filter-item/editors/readme.md CHANGED
@@ -7,10 +7,11 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------- | --------- | ------------------------------------------------------ | --------------------- | ----------- |
12
- | `config` | -- | Define as configurações do componente snk-filter-text. | `SnkFilterItemConfig` | `undefined` |
13
- | `value` | `value` | Define o valor do componente snk-filter-text. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | --------------- | ------------------------------------------------------ | --------------------- | ----------- |
12
+ | `config` | -- | Define as configurações do componente snk-filter-text. | `SnkFilterItemConfig` | `undefined` |
13
+ | `errorMessage` | `error-message` | Usado para exibir mensagens de erro. | `string` | `undefined` |
14
+ | `value` | `value` | Define o valor do componente snk-filter-text. | `string` | `undefined` |
14
15
 
15
16
 
16
17
  ## Events
@@ -20,6 +21,29 @@
20
21
  | `valueChanged` | Emitido quando o valor do filtro é alterado. | `CustomEvent<any>` |
21
22
 
22
23
 
24
+ ## Methods
25
+
26
+ ### `clearValue() => Promise<void>`
27
+
28
+ Limpa o valor do componente restaurando o valor original da configuração.
29
+
30
+ #### Returns
31
+
32
+ Type: `Promise<void>`
33
+
34
+ ---
35
+
36
+ ### `setFocus() => Promise<void>`
37
+
38
+ Define o foco no componente snk-filter-text.
39
+
40
+ #### Returns
41
+
42
+ Type: `Promise<void>`
43
+
44
+
45
+
46
+
23
47
  ----------------------------------------------
24
48
 
25
49
 
package/components/snk-filter-bar/filter-modal/readme.md CHANGED
@@ -7,23 +7,29 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | ----------- |
12
- | `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `(isDefault?: boolean) => 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, isDefault?: boolean) => 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, isDefault?: boolean) => void` | `undefined` |
19
- | `filterDefaultToDelete` | -- | Guarda o filtro a ser deletado no Apply do modal | `SnkFilterItemConfig` | `undefined` |
20
- | `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
21
- | `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
22
- | `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 | `(isDefault?: boolean) => 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, isDefault?: boolean) => 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, isDefault?: boolean) => void` | `undefined` |
19
+ | `filterConfig` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
20
+ | `filterCustomConfigInterceptor` | -- | | `(config: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
21
+ | `filterDefaultToDelete` | -- | Guarda o filtro a ser deletado no Apply do modal | `SnkFilterItemConfig` | `undefined` |
22
+ | `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
23
+ | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
24
+ | `opened` | `opened` | Define se o modal está aberto ou não. | `boolean` | `false` |
23
25
 
24
26
 
25
27
  ## Dependencies
26
28
 
29
+ ### Used by
30
+
31
+ - [snk-filter-bar](..)
32
+
27
33
  ### Depends on
28
34
 
29
35
  - [snk-filter-modal-item](subcomponents)
@@ -34,6 +40,7 @@
34
40
  graph TD;
35
41
  snk-filter-modal --> snk-filter-modal-item
36
42
  snk-filter-modal --> snk-default-filter
43
+ snk-filter-bar --> snk-filter-modal
37
44
  style snk-filter-modal fill:#f9f,stroke:#333,stroke-width:4px
38
45
  ```
39
46
 
package/components/snk-filter-bar/readme.md CHANGED
@@ -7,21 +7,23 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------------ | ---------------------------------- | ----------- | ------------------------------------------------------------------------------------------ | ----------- |
12
- | `afterApplyConfig` | -- | | `() => void` | `undefined` |
13
- | `autoLoad` | `auto-load` | | `boolean` | `undefined` |
14
- | `configName` | `config-name` | | `string` | `undefined` |
15
- | `customFilterBarConfig` | -- | | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
16
- | `dataUnit` | -- | | `DataUnit` | `undefined` |
17
- | `disablePersonalizedFilter` | `disable-personalized-filter` | | `boolean` | `undefined` |
18
- | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | | `boolean` | `false` |
19
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | | `string` | `undefined` |
20
- | `filterConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
21
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
22
- | `mode` | `mode` | | `"button" \| "hidden" \| "regular"` | `"regular"` |
23
- | `resourceID` | `resource-i-d` | | `string` | `undefined` |
24
- | `title` | `title` | | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------------- | ---------------------------------- | ----------- | ------------------------------------------------------------------------------------------ | ----------- |
12
+ | `afterApplyConfig` | -- | | `() => void` | `undefined` |
13
+ | `autoLoad` | `auto-load` | | `boolean` | `undefined` |
14
+ | `configName` | `config-name` | | `string` | `undefined` |
15
+ | `customFilterBarConfig` | -- | | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
16
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
17
+ | `disablePersonalizedFilter` | `disable-personalized-filter` | | `boolean` | `undefined` |
18
+ | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | | `boolean` | `false` |
19
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | | `string` | `undefined` |
20
+ | `filterConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
21
+ | `filterCustomConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
22
+ | `filterCustomConfigInterceptor` | -- | | `(config: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
23
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
24
+ | `mode` | `mode` | | `"button" \| "hidden" \| "regular"` | `"regular"` |
25
+ | `resourceID` | `resource-i-d` | | `string` | `undefined` |
26
+ | `title` | `title` | | `string` | `undefined` |
25
27
 
26
28
 
27
29
  ## Events
@@ -122,12 +124,14 @@ Retorna uma Promise que resolve quando a atualização for concluída.
122
124
 
123
125
  - [snk-filter-item](filter-item)
124
126
  - [snk-personalized-filter](../snk-personalized-filter)
127
+ - [snk-filter-modal](filter-modal)
125
128
 
126
129
  ### Graph
127
130
  ```mermaid
128
131
  graph TD;
129
132
  snk-filter-bar --> snk-filter-item
130
133
  snk-filter-bar --> snk-personalized-filter
134
+ snk-filter-bar --> snk-filter-modal
131
135
  snk-filter-item --> snk-filter-detail
132
136
  snk-personalized-filter --> snk-filter-field-search
133
137
  snk-personalized-filter --> snk-filter-assistent-mode
@@ -138,6 +142,8 @@ graph TD;
138
142
  snk-expression-group --> snk-expression-group
139
143
  snk-expression-item --> snk-filter-field-search
140
144
  snk-expression-item --> snk-filter-param-config
145
+ snk-filter-modal --> snk-filter-modal-item
146
+ snk-filter-modal --> snk-default-filter
141
147
  snk-grid --> snk-filter-bar
142
148
  style snk-filter-bar fill:#f9f,stroke:#333,stroke-width:4px
143
149
  ```
package/components/snk-grid/readme.md CHANGED
@@ -22,6 +22,8 @@
22
22
  | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
23
23
  | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legada da barra de filtros. | `string` | `undefined` |
24
24
  | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros. | `string` | `undefined` |
25
+ | `filterCustomConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
26
+ | `filterCustomConfigInterceptor` | -- | | `(config: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
25
27
  | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
26
28
  | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade. | `string` | `undefined` |
27
29
  | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe de outra tela. | `boolean` | `undefined` |
@@ -48,11 +50,11 @@
48
50
 
49
51
  ## Events
50
52
 
51
- | Event | Description | Type |
52
- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
53
- | `actionClick` | Emitido ao clicar em um botão de ação ou item de menu. | `CustomEvent<string>` |
54
- | `componentReady` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<void>` |
55
- | `gridDoubleClick` | Emitido ao realizar um duplo clique em uma linha da grade. | `CustomEvent<any>` |
53
+ | Event | Description | Type |
54
+ | ----------------- | ------------------------------------------------------------ | --------------------- |
55
+ | `actionClick` | Emitido ao clicar em um botão de ação ou item de menu. | `CustomEvent<string>` |
56
+ | `componentReady` | Emitido quando o componente estiver completamente carregado. | `CustomEvent<void>` |
57
+ | `gridDoubleClick` | Emitido ao realizar um duplo clique em uma linha da grade. | `CustomEvent<any>` |
56
58
 
57
59
 
58
60
  ## Methods
@@ -225,6 +227,7 @@ graph TD;
225
227
  snk-grid --> taskbar-actions-button
226
228
  snk-filter-bar --> snk-filter-item
227
229
  snk-filter-bar --> snk-personalized-filter
230
+ snk-filter-bar --> snk-filter-modal
228
231
  snk-filter-item --> snk-filter-detail
229
232
  snk-personalized-filter --> snk-filter-field-search
230
233
  snk-personalized-filter --> snk-filter-assistent-mode
@@ -235,6 +238,8 @@ graph TD;
235
238
  snk-expression-group --> snk-expression-group
236
239
  snk-expression-item --> snk-filter-field-search
237
240
  snk-expression-item --> snk-filter-param-config
241
+ snk-filter-modal --> snk-filter-modal-item
242
+ snk-filter-modal --> snk-default-filter
238
243
  snk-taskbar --> snk-data-exporter
239
244
  snk-taskbar --> snk-actions-button
240
245
  snk-taskbar --> taskbar-split-button
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "9.2.0-rc.1",
3
+ "version": "9.2.0-rc.2",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [