@sankhyalabs/sankhyablocks-docs 9.2.0-rc.2 → 9.2.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 (9) hide show
  1. package/components/snk-crud/readme.md +0 -3
  2. package/components/snk-crud/subcomponents/readme.md +0 -3
  3. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +0 -3
  4. package/components/snk-entity-list/readme.md +0 -1
  5. package/components/snk-filter-bar/filter-item/editors/readme.md +4 -28
  6. package/components/snk-filter-bar/filter-modal/readme.md +13 -20
  7. package/components/snk-filter-bar/readme.md +15 -21
  8. package/components/snk-grid/readme.md +5 -10
  9. package/package.json +1 -1
package/components/snk-crud/readme.md CHANGED
@@ -186,7 +186,6 @@ 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
190
189
  snk-filter-item --> snk-filter-detail
191
190
  snk-personalized-filter --> snk-filter-field-search
192
191
  snk-personalized-filter --> snk-filter-assistent-mode
@@ -197,8 +196,6 @@ graph TD;
197
196
  snk-expression-group --> snk-expression-group
198
197
  snk-expression-item --> snk-filter-field-search
199
198
  snk-expression-item --> snk-filter-param-config
200
- snk-filter-modal --> snk-filter-modal-item
201
- snk-filter-modal --> snk-default-filter
202
199
  snk-taskbar --> snk-data-exporter
203
200
  snk-taskbar --> snk-actions-button
204
201
  snk-taskbar --> taskbar-split-button
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -143,7 +143,6 @@ 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
147
146
  snk-filter-item --> snk-filter-detail
148
147
  snk-personalized-filter --> snk-filter-field-search
149
148
  snk-personalized-filter --> snk-filter-assistent-mode
@@ -154,8 +153,6 @@ graph TD;
154
153
  snk-expression-group --> snk-expression-group
155
154
  snk-expression-item --> snk-filter-field-search
156
155
  snk-expression-item --> snk-filter-param-config
157
- snk-filter-modal --> snk-filter-modal-item
158
- snk-filter-modal --> snk-default-filter
159
156
  snk-taskbar --> snk-data-exporter
160
157
  snk-taskbar --> snk-actions-button
161
158
  snk-taskbar --> taskbar-split-button
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -128,7 +128,6 @@ 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
132
131
  snk-filter-item --> snk-filter-detail
133
132
  snk-personalized-filter --> snk-filter-field-search
134
133
  snk-personalized-filter --> snk-filter-assistent-mode
@@ -139,8 +138,6 @@ graph TD;
139
138
  snk-expression-group --> snk-expression-group
140
139
  snk-expression-item --> snk-filter-field-search
141
140
  snk-expression-item --> snk-filter-param-config
142
- snk-filter-modal --> snk-filter-modal-item
143
- snk-filter-modal --> snk-default-filter
144
141
  snk-taskbar --> snk-data-exporter
145
142
  snk-taskbar --> snk-actions-button
146
143
  snk-taskbar --> taskbar-split-button
package/components/snk-entity-list/readme.md CHANGED
@@ -10,7 +10,6 @@
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` |
14
13
  | `maxHeightList` | `max-height-list` | Permite definir uma altura máxima para o ez-list, adicionando um scroll ao atingir esta medida | `string` | `""` |
15
14
  | `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` |
16
15
  | `value` | -- | Define o valor do componente | `IOption` | `undefined` |
package/components/snk-filter-bar/filter-item/editors/readme.md CHANGED
@@ -7,11 +7,10 @@
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
- | `errorMessage` | `error-message` | Usado para exibir mensagens de erro. | `string` | `undefined` |
14
- | `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
+ | `value` | `value` | Define o valor do componente snk-filter-text. | `string` | `undefined` |
15
14
 
16
15
 
17
16
  ## Events
@@ -21,29 +20,6 @@
21
20
  | `valueChanged` | Emitido quando o valor do filtro é alterado. | `CustomEvent<any>` |
22
21
 
23
22
 
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
-
47
23
  ----------------------------------------------
48
24
 
49
25
 
package/components/snk-filter-bar/filter-modal/readme.md CHANGED
@@ -7,29 +7,23 @@
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
- | `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` |
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` |
25
23
 
26
24
 
27
25
  ## Dependencies
28
26
 
29
- ### Used by
30
-
31
- - [snk-filter-bar](..)
32
-
33
27
  ### Depends on
34
28
 
35
29
  - [snk-filter-modal-item](subcomponents)
@@ -40,7 +34,6 @@
40
34
  graph TD;
41
35
  snk-filter-modal --> snk-filter-modal-item
42
36
  snk-filter-modal --> snk-default-filter
43
- snk-filter-bar --> snk-filter-modal
44
37
  style snk-filter-modal fill:#f9f,stroke:#333,stroke-width:4px
45
38
  ```
46
39
 
package/components/snk-filter-bar/readme.md CHANGED
@@ -7,23 +7,21 @@
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
- | `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` |
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` |
27
25
 
28
26
 
29
27
  ## Events
@@ -124,14 +122,12 @@ Retorna uma Promise que resolve quando a atualização for concluída.
124
122
 
125
123
  - [snk-filter-item](filter-item)
126
124
  - [snk-personalized-filter](../snk-personalized-filter)
127
- - [snk-filter-modal](filter-modal)
128
125
 
129
126
  ### Graph
130
127
  ```mermaid
131
128
  graph TD;
132
129
  snk-filter-bar --> snk-filter-item
133
130
  snk-filter-bar --> snk-personalized-filter
134
- snk-filter-bar --> snk-filter-modal
135
131
  snk-filter-item --> snk-filter-detail
136
132
  snk-personalized-filter --> snk-filter-field-search
137
133
  snk-personalized-filter --> snk-filter-assistent-mode
@@ -142,8 +138,6 @@ graph TD;
142
138
  snk-expression-group --> snk-expression-group
143
139
  snk-expression-item --> snk-filter-field-search
144
140
  snk-expression-item --> snk-filter-param-config
145
- snk-filter-modal --> snk-filter-modal-item
146
- snk-filter-modal --> snk-default-filter
147
141
  snk-grid --> snk-filter-bar
148
142
  style snk-filter-bar fill:#f9f,stroke:#333,stroke-width:4px
149
143
  ```
package/components/snk-grid/readme.md CHANGED
@@ -22,8 +22,6 @@
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` |
27
25
  | `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'` |
28
26
  | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade. | `string` | `undefined` |
29
27
  | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe de outra tela. | `boolean` | `undefined` |
@@ -50,11 +48,11 @@
50
48
 
51
49
  ## Events
52
50
 
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>` |
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>` |
58
56
 
59
57
 
60
58
  ## Methods
@@ -227,7 +225,6 @@ graph TD;
227
225
  snk-grid --> taskbar-actions-button
228
226
  snk-filter-bar --> snk-filter-item
229
227
  snk-filter-bar --> snk-personalized-filter
230
- snk-filter-bar --> snk-filter-modal
231
228
  snk-filter-item --> snk-filter-detail
232
229
  snk-personalized-filter --> snk-filter-field-search
233
230
  snk-personalized-filter --> snk-filter-assistent-mode
@@ -238,8 +235,6 @@ graph TD;
238
235
  snk-expression-group --> snk-expression-group
239
236
  snk-expression-item --> snk-filter-field-search
240
237
  snk-expression-item --> snk-filter-param-config
241
- snk-filter-modal --> snk-filter-modal-item
242
- snk-filter-modal --> snk-default-filter
243
238
  snk-taskbar --> snk-data-exporter
244
239
  snk-taskbar --> snk-actions-button
245
240
  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.2",
3
+ "version": "9.2.1",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [