@sankhyalabs/sankhyablocks-docs 0.0.0-bugfix-dev-KB-57523.0 → 0.0.0-bugfix-dev-59880.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 +2 -2
- package/components/snk-crud/readme.md +51 -0
- package/components/snk-crud/subcomponents/readme.md +30 -0
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +22 -0
- package/components/snk-data-unit/readme.md +38 -7
- package/components/snk-filter-bar/readme.md +1 -0
- package/components/snk-form/readme.md +20 -0
- package/components/snk-grid/readme.md +41 -0
- package/components/snk-simple-crud/readme.md +51 -0
- package/package.json +1 -1
|
@@ -106,7 +106,7 @@ Type: `Promise<boolean>`
|
|
|
106
106
|
|
|
107
107
|
|
|
108
108
|
|
|
109
|
-
### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
|
|
109
|
+
### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string, options?: GetDataUnitOptions) => Promise<DataUnit>`
|
|
110
110
|
|
|
111
111
|
Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
|
|
112
112
|
passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado.
|
|
@@ -231,7 +231,7 @@ Type: `Promise<DataFetcher>`
|
|
|
231
231
|
|
|
232
232
|
DataFetcher do application
|
|
233
233
|
|
|
234
|
-
### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
|
|
234
|
+
### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string, options?: GetDataUnitOptions) => Promise<DataUnit>`
|
|
235
235
|
|
|
236
236
|
Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
|
|
237
237
|
|
|
@@ -10,6 +10,7 @@
|
|
|
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
|
+
| `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
|
|
13
14
|
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
|
14
15
|
| `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` |
|
|
15
16
|
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
|
@@ -39,6 +40,36 @@
|
|
|
39
40
|
|
|
40
41
|
## Methods
|
|
41
42
|
|
|
43
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
|
44
|
+
|
|
45
|
+
Registra um editor customizado para campos da grade e formulário.
|
|
46
|
+
|
|
47
|
+
#### Returns
|
|
48
|
+
|
|
49
|
+
Type: `Promise<void>`
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
|
54
|
+
|
|
55
|
+
Registra um formatador de valores para uma coluna da grid.
|
|
56
|
+
|
|
57
|
+
#### Returns
|
|
58
|
+
|
|
59
|
+
Type: `Promise<void>`
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
|
64
|
+
|
|
65
|
+
Registra um render customizado para colunas da grid.
|
|
66
|
+
|
|
67
|
+
#### Returns
|
|
68
|
+
|
|
69
|
+
Type: `Promise<void>`
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
42
73
|
### `closeConfigurator() => Promise<void>`
|
|
43
74
|
|
|
44
75
|
Usado para fechar o configurator do CRUD
|
|
@@ -89,6 +120,26 @@ Type: `Promise<void>`
|
|
|
89
120
|
|
|
90
121
|
|
|
91
122
|
|
|
123
|
+
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
|
124
|
+
|
|
125
|
+
Remove o formatador de valores de uma coluna da grid.
|
|
126
|
+
|
|
127
|
+
#### Returns
|
|
128
|
+
|
|
129
|
+
Type: `Promise<void>`
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
134
|
+
|
|
135
|
+
Altera/adiciona uma propriedade nos metadados do campo.
|
|
136
|
+
|
|
137
|
+
#### Returns
|
|
138
|
+
|
|
139
|
+
Type: `Promise<void>`
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
92
143
|
|
|
93
144
|
## Dependencies
|
|
94
145
|
|
|
@@ -37,6 +37,26 @@
|
|
|
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
|
+
|
|
40
60
|
### `findField() => Promise<void>`
|
|
41
61
|
|
|
42
62
|
Abre o localizador de campos
|
|
@@ -47,6 +67,16 @@ Type: `Promise<void>`
|
|
|
47
67
|
|
|
48
68
|
|
|
49
69
|
|
|
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
|
+
|
|
50
80
|
### `showFormConfig(detail?: boolean) => Promise<void>`
|
|
51
81
|
|
|
52
82
|
Abre o configurador do formulário
|
|
@@ -11,6 +11,8 @@
|
|
|
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` |
|
|
14
16
|
| `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
|
|
15
17
|
| `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
|
|
16
18
|
| `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
|
|
@@ -35,6 +37,26 @@
|
|
|
35
37
|
|
|
36
38
|
## Methods
|
|
37
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
|
+
|
|
38
60
|
### `changeViewMode(mode: VIEW_MODE) => Promise<void>`
|
|
39
61
|
|
|
40
62
|
Muda o modo de visualização do componente entre VIEW_MODE.GRID e VIEW_MODE.FORM
|
|
@@ -25,13 +25,14 @@
|
|
|
25
25
|
|
|
26
26
|
## Events
|
|
27
27
|
|
|
28
|
-
| Event | Description
|
|
29
|
-
| ------------------------ |
|
|
30
|
-
| `cancelEdition` | Emitido quando se cancela uma inserção ou cópia.
|
|
31
|
-
| `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit.
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
34
|
-
| `
|
|
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
|
+
| `dataUnitFieldsHidded` | Emitido quando há campos no DataUnit que devem ser ocultados. | `CustomEvent<void>` |
|
|
33
|
+
| `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
|
|
34
|
+
| `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
|
|
35
|
+
| `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
|
|
35
36
|
|
|
36
37
|
|
|
37
38
|
## Methods
|
|
@@ -46,6 +47,36 @@ Type: `Promise<DataUnit>`
|
|
|
46
47
|
|
|
47
48
|
|
|
48
49
|
|
|
50
|
+
### `getFieldsWithRmPrecision() => Promise<string[]>`
|
|
51
|
+
|
|
52
|
+
Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
|
|
53
|
+
|
|
54
|
+
#### Returns
|
|
55
|
+
|
|
56
|
+
Type: `Promise<string[]>`
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### `getFieldsWithRmp() => Promise<string[]>`
|
|
61
|
+
|
|
62
|
+
Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
|
|
63
|
+
|
|
64
|
+
#### Returns
|
|
65
|
+
|
|
66
|
+
Type: `Promise<string[]>`
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
|
|
71
|
+
|
|
72
|
+
Busca os metadados da linha selecionada.
|
|
73
|
+
|
|
74
|
+
#### Returns
|
|
75
|
+
|
|
76
|
+
Type: `Promise<RowMetadata>`
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
49
80
|
### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
|
|
50
81
|
|
|
51
82
|
Método que retorna a lista de IDs dos registros selecionados.
|
|
@@ -9,6 +9,7 @@
|
|
|
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` |
|
|
12
13
|
| `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` |
|
|
13
14
|
| `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` |
|
|
14
15
|
| `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,6 +27,16 @@
|
|
|
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
|
+
|
|
30
40
|
### `hideConfig() => Promise<void>`
|
|
31
41
|
|
|
32
42
|
Fecha a janela de configurações do formulário.
|
|
@@ -37,6 +47,16 @@ Type: `Promise<void>`
|
|
|
37
47
|
|
|
38
48
|
|
|
39
49
|
|
|
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
|
+
|
|
40
60
|
### `showConfig() => Promise<void>`
|
|
41
61
|
|
|
42
62
|
Exibe a janela de configurações do formulário.
|
|
@@ -10,6 +10,7 @@
|
|
|
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
|
+
| `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
|
|
13
14
|
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
|
14
15
|
| `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
|
|
15
16
|
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
|
@@ -42,6 +43,36 @@
|
|
|
42
43
|
|
|
43
44
|
## Methods
|
|
44
45
|
|
|
46
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
|
|
47
|
+
|
|
48
|
+
Registra um editor customizado para campos da grade e formulário
|
|
49
|
+
|
|
50
|
+
#### Returns
|
|
51
|
+
|
|
52
|
+
Type: `Promise<void>`
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
|
57
|
+
|
|
58
|
+
Registra um formatador de valores para uma coluna da grid.
|
|
59
|
+
|
|
60
|
+
#### Returns
|
|
61
|
+
|
|
62
|
+
Type: `Promise<void>`
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
|
|
67
|
+
|
|
68
|
+
Registra um render customizado para colunas da grid.
|
|
69
|
+
|
|
70
|
+
#### Returns
|
|
71
|
+
|
|
72
|
+
Type: `Promise<void>`
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
45
76
|
### `findColumn() => Promise<void>`
|
|
46
77
|
|
|
47
78
|
Abre o localizador de colunas
|
|
@@ -82,6 +113,16 @@ Type: `Promise<void>`
|
|
|
82
113
|
|
|
83
114
|
|
|
84
115
|
|
|
116
|
+
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
|
117
|
+
|
|
118
|
+
Remove o formatador de valores de uma coluna da grid.
|
|
119
|
+
|
|
120
|
+
#### Returns
|
|
121
|
+
|
|
122
|
+
Type: `Promise<void>`
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
85
126
|
### `setConfig(config: IGridConfig) => Promise<void>`
|
|
86
127
|
|
|
87
128
|
Atribui o valor da configuração da grade.
|
|
@@ -10,6 +10,7 @@
|
|
|
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
|
+
| `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
|
|
13
14
|
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
|
14
15
|
| `dataState` | -- | | `DataState` | `undefined` |
|
|
15
16
|
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
|
@@ -44,6 +45,36 @@
|
|
|
44
45
|
|
|
45
46
|
## Methods
|
|
46
47
|
|
|
48
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
|
49
|
+
|
|
50
|
+
Registra um editor customizado para campos da grade e formulário.
|
|
51
|
+
|
|
52
|
+
#### Returns
|
|
53
|
+
|
|
54
|
+
Type: `Promise<void>`
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
|
59
|
+
|
|
60
|
+
Registra um formatador de valores para uma coluna da grid.
|
|
61
|
+
|
|
62
|
+
#### Returns
|
|
63
|
+
|
|
64
|
+
Type: `Promise<void>`
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
|
69
|
+
|
|
70
|
+
Registra um render customizado para colunas da grid.
|
|
71
|
+
|
|
72
|
+
#### Returns
|
|
73
|
+
|
|
74
|
+
Type: `Promise<void>`
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
47
78
|
### `closeConfigurator() => Promise<void>`
|
|
48
79
|
|
|
49
80
|
Usado para fechar o configurator do CRUD
|
|
@@ -84,6 +115,26 @@ Type: `Promise<void>`
|
|
|
84
115
|
|
|
85
116
|
|
|
86
117
|
|
|
118
|
+
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
|
119
|
+
|
|
120
|
+
Remove o formatador de valores de uma coluna da grid.
|
|
121
|
+
|
|
122
|
+
#### Returns
|
|
123
|
+
|
|
124
|
+
Type: `Promise<void>`
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
129
|
+
|
|
130
|
+
Altera/adiciona uma propriedade nos metadados do campo.
|
|
131
|
+
|
|
132
|
+
#### Returns
|
|
133
|
+
|
|
134
|
+
Type: `Promise<void>`
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
87
138
|
### `setMetadata(metadata: UnitMetadata) => Promise<void>`
|
|
88
139
|
|
|
89
140
|
|