@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-rc-KB-67982.1 → 0.0.0-hotfix-ga-5531422.0
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.
- package/components/snk-application/readme.md +7 -7
- package/components/snk-crud/readme.md +0 -53
- package/components/snk-crud/subcomponents/readme.md +0 -30
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +0 -22
- package/components/snk-data-unit/readme.md +21 -53
- package/components/snk-filter-bar/readme.md +0 -1
- package/components/snk-form/readme.md +0 -20
- package/components/snk-grid/readme.md +0 -42
- package/components/snk-simple-crud/readme.md +19 -74
- package/package.json +1 -1
@@ -7,13 +7,13 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description | Type
|
11
|
-
| ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
12
|
-
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string`
|
13
|
-
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string`
|
14
|
-
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string`
|
15
|
-
| `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: Record<string, any>; }
|
16
|
-
| `messagesBuilder` | -- | | `SnkMessageBuilder`
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
|
12
|
+
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
13
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
14
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
15
|
+
| `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: Record<string, any>; }) => void` | `undefined` |
|
16
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
17
17
|
|
18
18
|
|
19
19
|
## Events
|
@@ -10,11 +10,8 @@
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
11
11
|
| --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -------------------------- |
|
12
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
13
|
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
16
14
|
| `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
15
|
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
19
16
|
| `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
20
17
|
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
@@ -42,36 +39,6 @@
|
|
42
39
|
|
43
40
|
## Methods
|
44
41
|
|
45
|
-
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
46
|
-
|
47
|
-
Registra um editor customizado para campos da grade e formulário.
|
48
|
-
|
49
|
-
#### Returns
|
50
|
-
|
51
|
-
Type: `Promise<void>`
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
56
|
-
|
57
|
-
Registra um formatador de valores para uma coluna da grid.
|
58
|
-
|
59
|
-
#### Returns
|
60
|
-
|
61
|
-
Type: `Promise<void>`
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
66
|
-
|
67
|
-
Registra um render customizado para colunas da grid.
|
68
|
-
|
69
|
-
#### Returns
|
70
|
-
|
71
|
-
Type: `Promise<void>`
|
72
|
-
|
73
|
-
|
74
|
-
|
75
42
|
### `closeConfigurator() => Promise<void>`
|
76
43
|
|
77
44
|
Usado para fechar o configurator do CRUD
|
@@ -122,26 +89,6 @@ Type: `Promise<void>`
|
|
122
89
|
|
123
90
|
|
124
91
|
|
125
|
-
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
126
|
-
|
127
|
-
Remove o formatador de valores de uma coluna da grid.
|
128
|
-
|
129
|
-
#### Returns
|
130
|
-
|
131
|
-
Type: `Promise<void>`
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
136
|
-
|
137
|
-
Altera/adiciona uma propriedade nos metadados do campo.
|
138
|
-
|
139
|
-
#### Returns
|
140
|
-
|
141
|
-
Type: `Promise<void>`
|
142
|
-
|
143
|
-
|
144
|
-
|
145
92
|
|
146
93
|
## Dependencies
|
147
94
|
|
@@ -37,26 +37,6 @@
|
|
37
37
|
|
38
38
|
## Methods
|
39
39
|
|
40
|
-
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
41
|
-
|
42
|
-
Registra um editor customizado para campos da grade e formulário
|
43
|
-
|
44
|
-
#### Returns
|
45
|
-
|
46
|
-
Type: `Promise<void>`
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
51
|
-
|
52
|
-
Registra um render customizado para colunas da grid.
|
53
|
-
|
54
|
-
#### Returns
|
55
|
-
|
56
|
-
Type: `Promise<void>`
|
57
|
-
|
58
|
-
|
59
|
-
|
60
40
|
### `findField() => Promise<void>`
|
61
41
|
|
62
42
|
Abre o localizador de campos
|
@@ -67,16 +47,6 @@ Type: `Promise<void>`
|
|
67
47
|
|
68
48
|
|
69
49
|
|
70
|
-
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
71
|
-
|
72
|
-
Altera/adiciona uma propriedade nos metadados do campo.
|
73
|
-
|
74
|
-
#### Returns
|
75
|
-
|
76
|
-
Type: `Promise<void>`
|
77
|
-
|
78
|
-
|
79
|
-
|
80
50
|
### `setFocus() => Promise<void>`
|
81
51
|
|
82
52
|
Atribui o foco para o componente.
|
@@ -11,8 +11,6 @@
|
|
11
11
|
| -------------------------- | ----------------------------- | ------------------------------------------------------------------------- | ---------------------- | ----------- |
|
12
12
|
| `branchGuide` | -- | | `IGuideItem` | `undefined` |
|
13
13
|
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
14
|
-
| `customEditors` | -- | Registra um editor customizado para campos da grade e formulário. | `PropsCustomEditor` | `undefined` |
|
15
|
-
| `customRenders` | -- | Render customizados da grade. | `PropsCustomRender` | `undefined` |
|
16
14
|
| `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
|
17
15
|
| `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
|
18
16
|
| `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
|
@@ -37,26 +35,6 @@
|
|
37
35
|
|
38
36
|
## Methods
|
39
37
|
|
40
|
-
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
41
|
-
|
42
|
-
Registra um editor customizado para campos da grade e formulário.
|
43
|
-
|
44
|
-
#### Returns
|
45
|
-
|
46
|
-
Type: `Promise<void>`
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
51
|
-
|
52
|
-
Registra um render customizado para colunas da grid.
|
53
|
-
|
54
|
-
#### Returns
|
55
|
-
|
56
|
-
Type: `Promise<void>`
|
57
|
-
|
58
|
-
|
59
|
-
|
60
38
|
### `changeViewMode(mode: VIEW_MODE) => Promise<void>`
|
61
39
|
|
62
40
|
Muda o modo de visualização do componente entre VIEW_MODE.GRID e VIEW_MODE.FORM
|
@@ -7,33 +7,31 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `afterSave`
|
13
|
-
| `beforeSave`
|
14
|
-
| `configName`
|
15
|
-
| `dataState`
|
16
|
-
| `dataUnit`
|
17
|
-
| `dataUnitName`
|
18
|
-
| `
|
19
|
-
| `
|
20
|
-
| `
|
21
|
-
| `
|
22
|
-
| `
|
23
|
-
| `
|
24
|
-
| `useCancelConfirm` | `use-cancel-confirm` | Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. | `boolean` | `true` |
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------- |
|
12
|
+
| `afterSave` | -- | Executado após a ação de salvar. | `(dataUnit: DataUnit) => void` | `undefined` |
|
13
|
+
| `beforeSave` | -- | Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação. | `(dataUnit: DataUnit) => boolean \| Promise<boolean>` | `undefined` |
|
14
|
+
| `configName` | `config-name` | Usado para obter configuração de metadados. | `string` | `undefined` |
|
15
|
+
| `dataState` | -- | Controla o estado atual dos dados. | `DataState` | `undefined` |
|
16
|
+
| `dataUnit` | -- | Uma vez instanciado, pode-se obter o dataUnit por esta propriedade. | `DataUnit` | `undefined` |
|
17
|
+
| `dataUnitName` | `data-unit-name` | Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade. | `string` | `undefined` |
|
18
|
+
| `entityName` | `entity-name` | Determina qual a entidade que representa os dados em questão. | `string` | `undefined` |
|
19
|
+
| `ignoreSaveMessage` | `ignore-save-message` | Responsável por evitar a mensagem de sucesso ao salvar. | `boolean` | `undefined` |
|
20
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
21
|
+
| `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
|
22
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
23
|
+
| `useCancelConfirm` | `use-cancel-confirm` | Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. | `boolean` | `true` |
|
25
24
|
|
26
25
|
|
27
26
|
## Events
|
28
27
|
|
29
|
-
| Event | Description
|
30
|
-
| ------------------------ |
|
31
|
-
| `cancelEdition` | Emitido quando se cancela uma inserção ou cópia.
|
32
|
-
| `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit.
|
33
|
-
| `
|
34
|
-
| `
|
35
|
-
| `
|
36
|
-
| `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
|
28
|
+
| Event | Description | Type |
|
29
|
+
| ------------------------ | --------------------------------------------------------- | -------------------------------- |
|
30
|
+
| `cancelEdition` | Emitido quando se cancela uma inserção ou cópia. | `CustomEvent<void>` |
|
31
|
+
| `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
|
32
|
+
| `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
|
33
|
+
| `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
|
34
|
+
| `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
|
37
35
|
|
38
36
|
|
39
37
|
## Methods
|
@@ -48,36 +46,6 @@ Type: `Promise<DataUnit>`
|
|
48
46
|
|
49
47
|
|
50
48
|
|
51
|
-
### `getFieldsWithRmPrecision() => Promise<string[]>`
|
52
|
-
|
53
|
-
Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
|
54
|
-
|
55
|
-
#### Returns
|
56
|
-
|
57
|
-
Type: `Promise<string[]>`
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
### `getFieldsWithRmp() => Promise<string[]>`
|
62
|
-
|
63
|
-
Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
|
64
|
-
|
65
|
-
#### Returns
|
66
|
-
|
67
|
-
Type: `Promise<string[]>`
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
|
72
|
-
|
73
|
-
Busca os metadados da linha selecionada.
|
74
|
-
|
75
|
-
#### Returns
|
76
|
-
|
77
|
-
Type: `Promise<RowMetadata>`
|
78
|
-
|
79
|
-
|
80
|
-
|
81
49
|
### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
|
82
50
|
|
83
51
|
Método que retorna a lista de IDs dos registros selecionados.
|
@@ -9,7 +9,6 @@
|
|
9
9
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
11
11
|
| --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ----------- |
|
12
|
-
| `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
|
13
12
|
| `configName` | `config-name` | Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. | `string` | `undefined` |
|
14
13
|
| `dataUnit` | -- | Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. | `DataUnit` | `undefined` |
|
15
14
|
| `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` |
|
@@ -27,16 +27,6 @@
|
|
27
27
|
|
28
28
|
## Methods
|
29
29
|
|
30
|
-
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
31
|
-
|
32
|
-
Registra um editor customizado para campos da grade e formulário.
|
33
|
-
|
34
|
-
#### Returns
|
35
|
-
|
36
|
-
Type: `Promise<void>`
|
37
|
-
|
38
|
-
|
39
|
-
|
40
30
|
### `hideConfig() => Promise<void>`
|
41
31
|
|
42
32
|
Fecha a janela de configurações do formulário.
|
@@ -47,16 +37,6 @@ Type: `Promise<void>`
|
|
47
37
|
|
48
38
|
|
49
39
|
|
50
|
-
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
51
|
-
|
52
|
-
Altera/adiciona uma propriedade nos metadados do campo.
|
53
|
-
|
54
|
-
#### Returns
|
55
|
-
|
56
|
-
Type: `Promise<void>`
|
57
|
-
|
58
|
-
|
59
|
-
|
60
40
|
### `showConfig() => Promise<void>`
|
61
41
|
|
62
42
|
Exibe a janela de configurações do formulário.
|
@@ -10,8 +10,6 @@
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
11
11
|
| --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------- |
|
12
12
|
| `actionsList` | -- | Lista de ações que devem ser usadas 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
13
|
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
16
14
|
| `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
|
17
15
|
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
@@ -44,36 +42,6 @@
|
|
44
42
|
|
45
43
|
## Methods
|
46
44
|
|
47
|
-
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
|
48
|
-
|
49
|
-
Registra um editor customizado para campos da grade e formulário
|
50
|
-
|
51
|
-
#### Returns
|
52
|
-
|
53
|
-
Type: `Promise<void>`
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
58
|
-
|
59
|
-
Registra um formatador de valores para uma coluna da grid.
|
60
|
-
|
61
|
-
#### Returns
|
62
|
-
|
63
|
-
Type: `Promise<void>`
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
|
68
|
-
|
69
|
-
Registra um render customizado para colunas da grid.
|
70
|
-
|
71
|
-
#### Returns
|
72
|
-
|
73
|
-
Type: `Promise<void>`
|
74
|
-
|
75
|
-
|
76
|
-
|
77
45
|
### `findColumn() => Promise<void>`
|
78
46
|
|
79
47
|
Abre o localizador de colunas
|
@@ -114,16 +82,6 @@ Type: `Promise<void>`
|
|
114
82
|
|
115
83
|
|
116
84
|
|
117
|
-
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
118
|
-
|
119
|
-
Remove o formatador de valores de uma coluna da grid.
|
120
|
-
|
121
|
-
#### Returns
|
122
|
-
|
123
|
-
Type: `Promise<void>`
|
124
|
-
|
125
|
-
|
126
|
-
|
127
85
|
### `setConfig(config: IGridConfig) => Promise<void>`
|
128
86
|
|
129
87
|
Atribui o valor da configuração da grade.
|
@@ -7,30 +7,25 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description
|
11
|
-
| -------------------------- | ------------------------------ |
|
12
|
-
| `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
|
13
|
-
| `
|
14
|
-
| `
|
15
|
-
| `
|
16
|
-
| `
|
17
|
-
| `
|
18
|
-
| `
|
19
|
-
| `
|
20
|
-
| `
|
21
|
-
| `
|
22
|
-
| `
|
23
|
-
| `
|
24
|
-
| `
|
25
|
-
| `
|
26
|
-
| `
|
27
|
-
| `
|
28
|
-
| `
|
29
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
30
|
-
| `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
|
31
|
-
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
32
|
-
| `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
|
33
|
-
| `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` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
13
|
+
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
14
|
+
| `dataState` | -- | | `DataState` | `undefined` |
|
15
|
+
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
16
|
+
| `formConfig` | -- | | `IFormConfig` | `undefined` |
|
17
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
18
|
+
| `gridConfig` | -- | | `IGridConfig` | `undefined` |
|
19
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
20
|
+
| `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
|
21
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
22
|
+
| `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
|
23
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
|
24
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
25
|
+
| `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
|
26
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
27
|
+
| `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
|
28
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
34
29
|
|
35
30
|
|
36
31
|
## Events
|
@@ -47,36 +42,6 @@
|
|
47
42
|
|
48
43
|
## Methods
|
49
44
|
|
50
|
-
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
51
|
-
|
52
|
-
Registra um editor customizado para campos da grade e formulário.
|
53
|
-
|
54
|
-
#### Returns
|
55
|
-
|
56
|
-
Type: `Promise<void>`
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
61
|
-
|
62
|
-
Registra um formatador de valores para uma coluna da grid.
|
63
|
-
|
64
|
-
#### Returns
|
65
|
-
|
66
|
-
Type: `Promise<void>`
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
71
|
-
|
72
|
-
Registra um render customizado para colunas da grid.
|
73
|
-
|
74
|
-
#### Returns
|
75
|
-
|
76
|
-
Type: `Promise<void>`
|
77
|
-
|
78
|
-
|
79
|
-
|
80
45
|
### `closeConfigurator() => Promise<void>`
|
81
46
|
|
82
47
|
Usado para fechar o configurator do CRUD
|
@@ -117,26 +82,6 @@ Type: `Promise<void>`
|
|
117
82
|
|
118
83
|
|
119
84
|
|
120
|
-
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
121
|
-
|
122
|
-
Remove o formatador de valores de uma coluna da grid.
|
123
|
-
|
124
|
-
#### Returns
|
125
|
-
|
126
|
-
Type: `Promise<void>`
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
131
|
-
|
132
|
-
Altera/adiciona uma propriedade nos metadados do campo.
|
133
|
-
|
134
|
-
#### Returns
|
135
|
-
|
136
|
-
Type: `Promise<void>`
|
137
|
-
|
138
|
-
|
139
|
-
|
140
85
|
### `setMetadata(metadata: UnitMetadata) => Promise<void>`
|
141
86
|
|
142
87
|
|