@sankhyalabs/sankhyablocks-docs 9.2.0-dev.12 → 9.2.0-dev.14

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 (5) hide show
  1. package/components/snk-filter-bar/readme.md +10 -0
  2. package/components/snk-grid/readme.md +10 -0
  3. package/components/snk-personalized-filter/readme.md +11 -11
  4. package/components/snk-simple-crud/readme.md +50 -48
  5. package/package.json +1 -1
package/components/snk-filter-bar/readme.md CHANGED
@@ -57,6 +57,16 @@ O item de filtro correspondente ou undefined se não for encontrado.
57
57
 
58
58
  ---
59
59
 
60
+ ### `getFilters() => Promise<Filter[]>`
61
+
62
+
63
+
64
+ #### Returns
65
+
66
+ Type: `Promise<Filter[]>`
67
+
68
+ ---
69
+
60
70
  ### `reload() => Promise<void>`
61
71
 
62
72
 
package/components/snk-grid/readme.md CHANGED
@@ -117,6 +117,16 @@ Uma promessa que é resolvida quando a janela de configuração é fechada.
117
117
 
118
118
  ---
119
119
 
120
+ ### `refreshColumnFilterDataSource() => Promise<void>`
121
+
122
+
123
+
124
+ #### Returns
125
+
126
+ Type: `Promise<void>`
127
+
128
+ ---
129
+
120
130
  ### `reloadConfig() => Promise<void>`
121
131
 
122
132
  Recarrega a configuração da grade.
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-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-dev.12",
3
+ "version": "9.2.0-dev.14",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [