@sankhyalabs/sankhyablocks-docs 0.0.0-feat-dev-kb-52609.13 → 0.0.0-feat-dev-KB-46477.12

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 (8) hide show
  1. package/components/snk-application/readme.md +9 -9
  2. package/components/snk-crud/readme.md +30 -0
  3. package/components/snk-crud/subcomponents/readme.md +10 -0
  4. package/components/snk-data-unit/readme.md +30 -0
  5. package/components/snk-form/readme.md +10 -0
  6. package/components/snk-grid/readme.md +20 -0
  7. package/components/snk-simple-crud/readme.md +32 -0
  8. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -7,13 +7,13 @@
7
7
 
8
8
  ## Properties
9
9
 
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>; }, redirectFrom?: string) => void` | `undefined` |
16
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
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
@@ -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
 
package/components/snk-crud/readme.md CHANGED
@@ -39,6 +39,16 @@
39
39
 
40
40
  ## Methods
41
41
 
42
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
43
+
44
+ Registra um formatador de valores para uma coluna da grid.
45
+
46
+ #### Returns
47
+
48
+ Type: `Promise<void>`
49
+
50
+
51
+
42
52
  ### `closeConfigurator() => Promise<void>`
43
53
 
44
54
  Usado para fechar o configurator do CRUD
@@ -89,6 +99,26 @@ Type: `Promise<void>`
89
99
 
90
100
 
91
101
 
102
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
103
+
104
+ Remove o formatador de valores de uma coluna da grid.
105
+
106
+ #### Returns
107
+
108
+ Type: `Promise<void>`
109
+
110
+
111
+
112
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
113
+
114
+ Altera/adiciona uma propriedade nos metadados do campo.
115
+
116
+ #### Returns
117
+
118
+ Type: `Promise<void>`
119
+
120
+
121
+
92
122
 
93
123
  ## Dependencies
94
124
 
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -47,6 +47,16 @@ Type: `Promise<void>`
47
47
 
48
48
 
49
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
+
50
60
  ### `showFormConfig(detail?: boolean) => Promise<void>`
51
61
 
52
62
  Abre o configurador do formulário
package/components/snk-data-unit/readme.md CHANGED
@@ -46,6 +46,36 @@ Type: `Promise<DataUnit>`
46
46
 
47
47
 
48
48
 
49
+ ### `getFieldsWithRmPrecision() => Promise<string[]>`
50
+
51
+ Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
52
+
53
+ #### Returns
54
+
55
+ Type: `Promise<string[]>`
56
+
57
+
58
+
59
+ ### `getFieldsWithRmp() => Promise<string[]>`
60
+
61
+ Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
62
+
63
+ #### Returns
64
+
65
+ Type: `Promise<string[]>`
66
+
67
+
68
+
69
+ ### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
70
+
71
+ Busca os metadados da linha selecionada.
72
+
73
+ #### Returns
74
+
75
+ Type: `Promise<RowMetadata>`
76
+
77
+
78
+
49
79
  ### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
50
80
 
51
81
  Método que retorna a lista de IDs dos registros selecionados.
package/components/snk-form/readme.md CHANGED
@@ -37,6 +37,16 @@ Type: `Promise<void>`
37
37
 
38
38
 
39
39
 
40
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
41
+
42
+ Altera/adiciona uma propriedade nos metadados do campo.
43
+
44
+ #### Returns
45
+
46
+ Type: `Promise<void>`
47
+
48
+
49
+
40
50
  ### `showConfig() => Promise<void>`
41
51
 
42
52
  Exibe a janela de configurações do formulário.
package/components/snk-grid/readme.md CHANGED
@@ -42,6 +42,16 @@
42
42
 
43
43
  ## Methods
44
44
 
45
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
46
+
47
+ Registra um formatador de valores para uma coluna da grid.
48
+
49
+ #### Returns
50
+
51
+ Type: `Promise<void>`
52
+
53
+
54
+
45
55
  ### `findColumn() => Promise<void>`
46
56
 
47
57
  Abre o localizador de colunas
@@ -82,6 +92,16 @@ Type: `Promise<void>`
82
92
 
83
93
 
84
94
 
95
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
96
+
97
+ Remove o formatador de valores de uma coluna da grid.
98
+
99
+ #### Returns
100
+
101
+ Type: `Promise<void>`
102
+
103
+
104
+
85
105
  ### `setConfig(config: IGridConfig) => Promise<void>`
86
106
 
87
107
  Atribui o valor da configuração da grade.
package/components/snk-simple-crud/readme.md CHANGED
@@ -13,6 +13,7 @@
13
13
  | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
14
14
  | `dataState` | -- | | `DataState` | `undefined` |
15
15
  | `dataUnit` | -- | | `DataUnit` | `undefined` |
16
+ | `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
16
17
  | `formConfig` | -- | | `IFormConfig` | `undefined` |
17
18
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
18
19
  | `gridConfig` | -- | | `IGridConfig` | `undefined` |
@@ -21,6 +22,7 @@
21
22
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
23
  | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
23
24
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
25
+ | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
24
26
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
25
27
  | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
26
28
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
@@ -42,6 +44,16 @@
42
44
 
43
45
  ## Methods
44
46
 
47
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
48
+
49
+ Registra um formatador de valores para uma coluna da grid.
50
+
51
+ #### Returns
52
+
53
+ Type: `Promise<void>`
54
+
55
+
56
+
45
57
  ### `closeConfigurator() => Promise<void>`
46
58
 
47
59
  Usado para fechar o configurator do CRUD
@@ -82,6 +94,26 @@ Type: `Promise<void>`
82
94
 
83
95
 
84
96
 
97
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
98
+
99
+ Remove o formatador de valores de uma coluna da grid.
100
+
101
+ #### Returns
102
+
103
+ Type: `Promise<void>`
104
+
105
+
106
+
107
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
108
+
109
+ Altera/adiciona uma propriedade nos metadados do campo.
110
+
111
+ #### Returns
112
+
113
+ Type: `Promise<void>`
114
+
115
+
116
+
85
117
  ### `setMetadata(metadata: UnitMetadata) => Promise<void>`
86
118
 
87
119
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "0.0.0-feat-dev-kb-52609.13",
3
+ "version": "0.0.0-feat-dev-KB-46477.12",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [