@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-kb-105837.0 → 0.0.0-hotfix-ga-kb-106013.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.
@@ -7,55 +7,54 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description
|
11
|
-
| ------------------------------- | ----------------------------------- |
|
12
|
-
| `actionsList` | -- |
|
13
|
-
| `autoFocus` | `auto-focus` | Define se a
|
14
|
-
| `autoLoad` | `auto-load` | Define se
|
15
|
-
| `configName` | `config-name` |
|
16
|
-
| `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na
|
17
|
-
| `domainMessagesBuilder` | `domain-messages-builder` | Define
|
18
|
-
| `enableGridInsert` | `enable-grid-insert` | Ativa
|
19
|
-
| `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para
|
20
|
-
| `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade
|
21
|
-
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração
|
22
|
-
| `filterBarTitle` | `filter-bar-title` | Título
|
23
|
-
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração
|
24
|
-
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração
|
25
|
-
| `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos
|
26
|
-
| `layoutFormConfig` | `layout-form-config` | Define se
|
27
|
-
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
|
28
|
-
| `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição
|
29
|
-
| `multipleSelection` | `multiple-selection` | Determina se
|
30
|
-
| `paginationCounterMode` | `pagination-counter-mode` | Define
|
31
|
-
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do
|
32
|
-
| `recordsValidator` | -- | Validador responsável por
|
33
|
-
| `selectionToastConfig` | -- | Configuração
|
34
|
-
| `setCustomFormTitle` | -- | Define uma função para configurar um título
|
35
|
-
| `showActionButtons` | `show-action-buttons` |
|
36
|
-
| `statusResolver` | -- |
|
37
|
-
| `strategyExporter` | `strategy-exporter` |
|
38
|
-
| `taskbarManager` | -- | Gerenciador das barras de tarefas.
|
39
|
-
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro,
|
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
|
+
| `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
|
+
| `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
|
18
|
+
| `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
|
19
|
+
| `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
|
20
|
+
| `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
|
21
|
+
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
22
|
+
| `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
23
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
24
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
25
|
+
| `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
|
26
|
+
| `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `false` |
|
27
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
28
|
+
| `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
|
29
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
|
30
|
+
| `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
|
31
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
32
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
33
|
+
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
|
34
|
+
| `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
|
35
|
+
| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
|
36
|
+
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
37
|
+
| `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
|
38
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
39
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
40
40
|
|
41
41
|
|
42
42
|
## Events
|
43
43
|
|
44
|
-
| Event | Description
|
45
|
-
| -------------------- |
|
46
|
-
| `actionClick` | Emitido pela
|
47
|
-
| `configuratorCancel` | Emitido quando o salvamento da configuração
|
48
|
-
| `configuratorSave` | Emitido quando a configuração
|
49
|
-
| `formItemsReady` |
|
50
|
-
| `viewModeChanged` |
|
44
|
+
| Event | Description | Type |
|
45
|
+
| -------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
46
|
+
| `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
47
|
+
| `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
|
48
|
+
| `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
|
49
|
+
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
50
|
+
| `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
|
51
51
|
|
52
52
|
|
53
53
|
## Methods
|
54
54
|
|
55
55
|
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
56
56
|
|
57
|
-
Registra um editor customizado para
|
58
|
-
tanto na grade principal (`snk-grid`) quanto no formulário (`snk-guides-viewer`).
|
57
|
+
Registra um editor customizado para campos da grade e formulário.
|
59
58
|
|
60
59
|
#### Returns
|
61
60
|
|
@@ -65,7 +64,7 @@ Type: `Promise<void>`
|
|
65
64
|
|
66
65
|
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
67
66
|
|
68
|
-
Registra um formatador de valores
|
67
|
+
Registra um formatador de valores para uma coluna da grid.
|
69
68
|
|
70
69
|
#### Returns
|
71
70
|
|
@@ -75,8 +74,7 @@ Type: `Promise<void>`
|
|
75
74
|
|
76
75
|
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
77
76
|
|
78
|
-
Registra um
|
79
|
-
Permite substituir a renderização padrão de uma célula por um conteúdo HTML customizado.
|
77
|
+
Registra um render customizado para colunas da grid.
|
80
78
|
|
81
79
|
#### Returns
|
82
80
|
|
@@ -86,7 +84,7 @@ Type: `Promise<void>`
|
|
86
84
|
|
87
85
|
### `closeConfigurator() => Promise<void>`
|
88
86
|
|
89
|
-
|
87
|
+
Usado para fechar o configurator do CRUD
|
90
88
|
|
91
89
|
#### Returns
|
92
90
|
|
@@ -96,17 +94,17 @@ Type: `Promise<void>`
|
|
96
94
|
|
97
95
|
### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
|
98
96
|
|
99
|
-
Retorna o elemento da
|
97
|
+
Retorna o elemento da filter-bar da grade.
|
100
98
|
|
101
99
|
#### Returns
|
102
100
|
|
103
101
|
Type: `Promise<HTMLSnkFilterBarElement>`
|
104
102
|
|
105
|
-
|
103
|
+
|
106
104
|
|
107
105
|
### `goToView(mode: string) => Promise<void>`
|
108
106
|
|
109
|
-
|
107
|
+
Usado para alternar a visão entre GRID e FORM externamente.
|
110
108
|
|
111
109
|
#### Returns
|
112
110
|
|
@@ -116,7 +114,7 @@ Type: `Promise<void>`
|
|
116
114
|
|
117
115
|
### `openConfigurator() => Promise<void>`
|
118
116
|
|
119
|
-
|
117
|
+
Usado para abrir o configurator do CRUD
|
120
118
|
|
121
119
|
#### Returns
|
122
120
|
|
@@ -126,7 +124,7 @@ Type: `Promise<void>`
|
|
126
124
|
|
127
125
|
### `reloadFilterBar() => Promise<void>`
|
128
126
|
|
129
|
-
|
127
|
+
Faz o recarregamento da filter-bar do crud, buscando o state no servidor.
|
130
128
|
|
131
129
|
#### Returns
|
132
130
|
|
@@ -136,7 +134,7 @@ Type: `Promise<void>`
|
|
136
134
|
|
137
135
|
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
138
136
|
|
139
|
-
Remove
|
137
|
+
Remove o formatador de valores de uma coluna da grid.
|
140
138
|
|
141
139
|
#### Returns
|
142
140
|
|
@@ -146,8 +144,7 @@ Type: `Promise<void>`
|
|
146
144
|
|
147
145
|
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
148
146
|
|
149
|
-
Altera
|
150
|
-
Isso pode ser usado para modificar o comportamento ou a aparência de um campo em tempo de execução.
|
147
|
+
Altera/adiciona uma propriedade nos metadados do campo.
|
151
148
|
|
152
149
|
#### Returns
|
153
150
|
|
@@ -10,7 +10,7 @@
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
11
11
|
| ---------------------- | ------------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
12
12
|
| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
|
13
|
-
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração
|
13
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legada do formulário. | `string` | `undefined` |
|
14
14
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
15
15
|
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
16
16
|
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
@@ -18,18 +18,24 @@
|
|
18
18
|
|
19
19
|
## Events
|
20
20
|
|
21
|
-
| Event | Description
|
22
|
-
| ---------------- |
|
23
|
-
| `actionClick` |
|
24
|
-
|
25
|
-
|
21
|
+
| Event | Description | Type |
|
22
|
+
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
|
23
|
+
| `actionClick` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
|
24
|
+
|
25
|
+
| `CustomEvent<string>` |
|
26
|
+
| `exit` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
|
27
|
+
|
28
|
+
| `CustomEvent<void>` |
|
29
|
+
| `formItemsReady` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
|
30
|
+
|
31
|
+
| `CustomEvent<HTMLElement[]>` |
|
26
32
|
|
27
33
|
|
28
34
|
## Methods
|
29
35
|
|
30
36
|
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
31
37
|
|
32
|
-
Registra um editor customizado para campos
|
38
|
+
Registra um editor customizado para campos do formulário.
|
33
39
|
|
34
40
|
#### Returns
|
35
41
|
|
@@ -67,6 +73,16 @@ Type: `Promise<void>`
|
|
67
73
|
|
68
74
|
|
69
75
|
|
76
|
+
### `validate() => Promise<void>`
|
77
|
+
|
78
|
+
Valida o formulário.
|
79
|
+
|
80
|
+
#### Returns
|
81
|
+
|
82
|
+
Type: `Promise<void>`
|
83
|
+
|
84
|
+
|
85
|
+
|
70
86
|
|
71
87
|
## Dependencies
|
72
88
|
|