@sankhyalabs/sankhyablocks-docs 9.2.0-ms.9 → 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 (13) 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 +31 -15
  8. package/components/snk-grid/readme.md +20 -5
  9. package/components/snk-personalized-filter/readme.md +11 -11
  10. package/components/snk-pesquisa/readme.md +9 -9
  11. package/components/snk-simple-bar/readme.md +6 -6
  12. package/components/snk-simple-crud/readme.md +50 -48
  13. 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
@@ -57,6 +59,16 @@ O item de filtro correspondente ou undefined se não for encontrado.
57
59
 
58
60
  ---
59
61
 
62
+ ### `getFilters() => Promise<Filter[]>`
63
+
64
+
65
+
66
+ #### Returns
67
+
68
+ Type: `Promise<Filter[]>`
69
+
70
+ ---
71
+
60
72
  ### `reload() => Promise<void>`
61
73
 
62
74
 
@@ -112,12 +124,14 @@ Retorna uma Promise que resolve quando a atualização for concluída.
112
124
 
113
125
  - [snk-filter-item](filter-item)
114
126
  - [snk-personalized-filter](../snk-personalized-filter)
127
+ - [snk-filter-modal](filter-modal)
115
128
 
116
129
  ### Graph
117
130
  ```mermaid
118
131
  graph TD;
119
132
  snk-filter-bar --> snk-filter-item
120
133
  snk-filter-bar --> snk-personalized-filter
134
+ snk-filter-bar --> snk-filter-modal
121
135
  snk-filter-item --> snk-filter-detail
122
136
  snk-personalized-filter --> snk-filter-field-search
123
137
  snk-personalized-filter --> snk-filter-assistent-mode
@@ -128,6 +142,8 @@ graph TD;
128
142
  snk-expression-group --> snk-expression-group
129
143
  snk-expression-item --> snk-filter-field-search
130
144
  snk-expression-item --> snk-filter-param-config
145
+ snk-filter-modal --> snk-filter-modal-item
146
+ snk-filter-modal --> snk-default-filter
131
147
  snk-grid --> snk-filter-bar
132
148
  style snk-filter-bar fill:#f9f,stroke:#333,stroke-width:4px
133
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
@@ -117,6 +119,16 @@ Uma promessa que é resolvida quando a janela de configuração é fechada.
117
119
 
118
120
  ---
119
121
 
122
+ ### `refreshColumnFilterDataSource() => Promise<void>`
123
+
124
+
125
+
126
+ #### Returns
127
+
128
+ Type: `Promise<void>`
129
+
130
+ ---
131
+
120
132
  ### `reloadConfig() => Promise<void>`
121
133
 
122
134
  Recarrega a configuração da grade.
@@ -215,6 +227,7 @@ graph TD;
215
227
  snk-grid --> taskbar-actions-button
216
228
  snk-filter-bar --> snk-filter-item
217
229
  snk-filter-bar --> snk-personalized-filter
230
+ snk-filter-bar --> snk-filter-modal
218
231
  snk-filter-item --> snk-filter-detail
219
232
  snk-personalized-filter --> snk-filter-field-search
220
233
  snk-personalized-filter --> snk-filter-assistent-mode
@@ -225,6 +238,8 @@ graph TD;
225
238
  snk-expression-group --> snk-expression-group
226
239
  snk-expression-item --> snk-filter-field-search
227
240
  snk-expression-item --> snk-filter-param-config
241
+ snk-filter-modal --> snk-filter-modal-item
242
+ snk-filter-modal --> snk-default-filter
228
243
  snk-taskbar --> snk-data-exporter
229
244
  snk-taskbar --> snk-actions-button
230
245
  snk-taskbar --> taskbar-split-button
package/components/snk-personalized-filter/readme.md CHANGED
@@ -9,28 +9,28 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ----------------- | ------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
13
- | `entityUri` | `entity-uri` | Responsável por receber a URI da entidade. | `string` | `undefined` |
14
- | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
15
- | `isDefaultFilter` | `is-default-filter` | Define se o filtro em questão é um filtro padrão. | `boolean` | `false` |
12
+ | `configName` | `config-name` | Nome da configuração, utilizado para distinguir múltiplas instâncias do componente. | `string` | `undefined` |
13
+ | `entityUri` | `entity-uri` | URI da entidade utilizada para buscar os campos disponíveis para filtro. | `string` | `undefined` |
14
+ | `filterId` | `filter-id` | Identificador do filtro a ser carregado. | `string` | `undefined` |
15
+ | `isDefaultFilter` | `is-default-filter` | Indica se o filtro é o filtro padrão do sistema. | `boolean` | `false` |
16
16
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
- | `resourceID` | `resource-i-d` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
17
+ | `resourceID` | `resource-i-d` | Identificador do recurso utilizado para salvar e recuperar filtros. | `string` | `undefined` |
18
18
 
19
19
 
20
20
  ## Events
21
21
 
22
- | Event | Description | Type |
23
- | ------------- | ----------- | --------------------- |
24
- | `ezAfterSave` | | `CustomEvent<void>` |
25
- | `ezCancel` | | `CustomEvent<void>` |
26
- | `ezSave` | | `CustomEvent<string>` |
22
+ | Event | Description | Type |
23
+ | ------------- | ----------------------------------------------------------------- | --------------------- |
24
+ | `ezAfterSave` | Evento emitido após salvar as alterações do filtro personalizado. | `CustomEvent<void>` |
25
+ | `ezCancel` | Evento emitido ao cancelar a personalização do filtro. | `CustomEvent<void>` |
26
+ | `ezSave` | Evento emitido ao salvar as alterações do filtro personalizado. | `CustomEvent<string>` |
27
27
 
28
28
 
29
29
  ## Methods
30
30
 
31
31
  ### `createPersonalizedFilter() => Promise<void>`
32
32
 
33
-
33
+ Cria um novo filtro personalizado caso não exista nenhum.
34
34
 
35
35
  #### Returns
36
36
 
package/components/snk-pesquisa/readme.md CHANGED
@@ -7,15 +7,15 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------- | --------------------- | ------------------------------------------------------------------- | -------------------------------- | ----------- |
12
- | `allowsNonAnalytic` | `allows-non-analytic` | Define se permite seleção de items não analíticos | `boolean` | `false` |
13
- | `argument` | `argument` | Argumentos que serão usados ao chamar a função searchLoader. | `string` | `undefined` |
14
- | `entityName` | `entity-name` | Nome da entidade onde a pesquisa é aplicada. | `string` | `undefined` |
15
- | `isHierarchyEntity` | `is-hierarchy-entity` | Define se a popup de pesquisa possuirá ou não modo Hierarquico. | `boolean` | `false` |
16
- | `searchLoader` | -- | Função responsável em carregar os itens do componente snk-pesquisa. | `(text: string) => Promise<any>` | `undefined` |
17
- | `selectItem` | -- | Função disparada ao selecionar um item. | `(option: IOption) => void` | `undefined` |
18
- | `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente | `(text: string) => Promise<any>` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ----------- |
12
+ | `allowsNonAnalytic` | `allows-non-analytic` | Define se permite a seleção de itens não analíticos. | `boolean` | `false` |
13
+ | `argument` | `argument` | Argumento utilizado ao chamar a função searchLoader. Pode ser alterado externamente. | `string` | `undefined` |
14
+ | `entityName` | `entity-name` | Nome da entidade sobre a qual a pesquisa será realizada. | `string` | `undefined` |
15
+ | `isHierarchyEntity` | `is-hierarchy-entity` | Define se a popup de pesquisa terá ou não modo hierárquico. | `boolean` | `false` |
16
+ | `searchLoader` | -- | Função responsável em carregar os itens do componente snk-pesquisa. Deve retornar uma Promise com os dados encontrados. | `(text: string) => Promise<any>` | `undefined` |
17
+ | `selectItem` | -- | Função disparada ao selecionar um item da pesquisa. | `(option: IOption) => void` | `undefined` |
18
+ | `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível. | `(text: string) => Promise<any>` | `undefined` |
19
19
 
20
20
 
21
21
  ## Dependencies
package/components/snk-simple-bar/readme.md CHANGED
@@ -9,17 +9,17 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ----------------- | --------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `breadcrumbItens` | -- | Define os itens que serão apresentados pelo breadcrumb | `IBreadcrumbItem[]` | `undefined` |
13
- | `label` | `label` | Define o título do header | `string` | `undefined` |
12
+ | `breadcrumbItens` | -- | Define os itens que serão apresentados no breadcrumb. | `IBreadcrumbItem[]` | `undefined` |
13
+ | `label` | `label` | Define o título do header. | `string` | `undefined` |
14
14
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
15
 
16
16
 
17
17
  ## Events
18
18
 
19
- | Event | Description | Type |
20
- | --------------------- | ------------------------------------------------- | ------------------------------ |
21
- | `clickBreadcrumbItem` | Emitido quando algum item do breadcrumb é clicado | `CustomEvent<IBreadcrumbItem>` |
22
- | `exit` | Emitido quando o botão voltar é acionado | `CustomEvent<void>` |
19
+ | Event | Description | Type |
20
+ | --------------------- | -------------------------------------------------- | ------------------------------ |
21
+ | `clickBreadcrumbItem` | Emitido quando algum item do breadcrumb é clicado. | `CustomEvent<IBreadcrumbItem>` |
22
+ | `exit` | Emitido quando o botão "voltar" é acionado. | `CustomEvent<void>` |
23
23
 
24
24
 
25
25
  ## Dependencies
package/components/snk-simple-crud/readme.md CHANGED
@@ -7,57 +7,57 @@
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
- | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
14
- | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
15
- | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
16
- | `dataState` | -- | | `DataState` | `undefined` |
17
- | `dataUnit` | -- | | `DataUnit` | `undefined` |
18
- | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
19
- | `enableContinuousInsert` | `enable-continuous-insert` | | `boolean` | `false` |
20
- | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
21
- | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
22
- | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
23
- | `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
24
- | `formConfig` | -- | | `IFormConfig` | `undefined` |
25
- | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
26
- | `gridConfig` | -- | | `IGridConfig` | `undefined` |
27
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
28
- | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
29
- | `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `false` |
30
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
31
- | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
32
- | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
33
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
34
- | `outlineMode` | `outline-mode` | Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up) | `boolean` | `false` |
35
- | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
36
- | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
37
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
38
- | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `false` |
39
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
40
- | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
41
- | `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` | -- | | `Action[]` | `undefined` |
13
+ | `autoFocus` | `auto-focus` | | `boolean` | `true` |
14
+ | `autoLoad` | `auto-load` | | `boolean` | `undefined` |
15
+ | `configName` | `config-name` | | `string` | `undefined` |
16
+ | `dataState` | -- | | `DataState` | `undefined` |
17
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
18
+ | `domainMessagesBuilder` | `domain-messages-builder` | | `string` | `undefined` |
19
+ | `enableContinuousInsert` | `enable-continuous-insert` | | `boolean` | `false` |
20
+ | `enableGridInsert` | `enable-grid-insert` | | `boolean` | `false` |
21
+ | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | | `boolean` | `false` |
22
+ | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | | `boolean` | `false` |
23
+ | `entityName` | `entity-name` | | `string` | `undefined` |
24
+ | `formConfig` | -- | | `IFormConfig` | `undefined` |
25
+ | `formLegacyConfigName` | `form-legacy-config-name` | | `string` | `undefined` |
26
+ | `gridConfig` | -- | | `IGridConfig` | `undefined` |
27
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | | `string` | `undefined` |
28
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | | `boolean` | `false` |
29
+ | `layoutFormConfig` | `layout-form-config` | | `boolean` | `false` |
30
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
31
+ | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
32
+ | `multipleEditionEnabled` | `multiple-edition-enabled` | | `boolean` | `true` |
33
+ | `multipleSelection` | `multiple-selection` | | `boolean` | `undefined` |
34
+ | `outlineMode` | `outline-mode` | | `boolean` | `false` |
35
+ | `pageSize` | `page-size` | | `number` | `150` |
36
+ | `paginationCounterMode` | `pagination-counter-mode` | | `"auto" \| "hidden" \| "show"` | `'auto'` |
37
+ | `resourceID` | `resource-i-d` | | `string` | `undefined` |
38
+ | `showConfiguratorButtons` | `show-configurator-buttons` | | `boolean` | `false` |
39
+ | `taskbarManager` | -- | | `TaskbarManager` | `undefined` |
40
+ | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
41
+ | `useEnterLikeTab` | `use-enter-like-tab` | | `boolean` | `false` |
42
42
 
43
43
 
44
44
  ## Events
45
45
 
46
- | Event | Description | Type |
47
- | -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
48
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
49
- | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
50
- | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
51
- | `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
52
- | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
53
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
46
+ | Event | Description | Type |
47
+ | -------------------- | ----------- | ---------------------------- |
48
+ | `actionClick` | | `CustomEvent<string>` |
49
+ | `configuratorCancel` | | `CustomEvent<any>` |
50
+ | `configuratorSave` | | `CustomEvent<any>` |
51
+ | `dataStateChange` | | `CustomEvent<DataState>` |
52
+ | `dataUnitReady` | | `CustomEvent<DataUnit>` |
53
+ | `formItemsReady` | | `CustomEvent<HTMLElement[]>` |
54
54
 
55
55
 
56
56
  ## Methods
57
57
 
58
58
  ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
59
59
 
60
- Registra um editor customizado para campos da grade e formulário.
60
+
61
61
 
62
62
  #### Returns
63
63
 
@@ -67,7 +67,7 @@ Type: `Promise<void>`
67
67
 
68
68
  ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
69
69
 
70
- Registra um formatador de valores para uma coluna da grid.
70
+
71
71
 
72
72
  #### Returns
73
73
 
@@ -77,7 +77,7 @@ Type: `Promise<void>`
77
77
 
78
78
  ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
79
79
 
80
- Registra um render customizado para colunas da grid.
80
+
81
81
 
82
82
  #### Returns
83
83
 
@@ -87,7 +87,7 @@ Type: `Promise<void>`
87
87
 
88
88
  ### `closeConfigurator() => Promise<void>`
89
89
 
90
- Usado para fechar o configurator do CRUD
90
+
91
91
 
92
92
  #### Returns
93
93
 
@@ -103,11 +103,13 @@ Type: `Promise<void>`
103
103
 
104
104
  Type: `Promise<Record[]>`
105
105
 
106
+ Uma promessa que resolve com a lista de registros.
107
+
106
108
  ---
107
109
 
108
110
  ### `goToView(view: VIEW_MODE) => Promise<void>`
109
111
 
110
- Usado para alternar a visão entre GRID e FORM externamente.
112
+
111
113
 
112
114
  #### Returns
113
115
 
@@ -117,7 +119,7 @@ Type: `Promise<void>`
117
119
 
118
120
  ### `openConfigurator() => Promise<void>`
119
121
 
120
- Usado para abrir o configurator do CRUD
122
+
121
123
 
122
124
  #### Returns
123
125
 
@@ -127,7 +129,7 @@ Type: `Promise<void>`
127
129
 
128
130
  ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
129
131
 
130
- Remove o formatador de valores de uma coluna da grid.
132
+
131
133
 
132
134
  #### Returns
133
135
 
@@ -137,7 +139,7 @@ Type: `Promise<void>`
137
139
 
138
140
  ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
139
141
 
140
- Altera/adiciona uma propriedade nos metadados do campo.
142
+
141
143
 
142
144
  #### Returns
143
145
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "9.2.0-ms.9",
3
+ "version": "9.2.0-rc.2",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [