@sankhyalabs/sankhyablocks-docs 0.0.0-feat-dev-KB-34470.0 → 0.0.0-feat-dev-KB-46477.2
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-attach/readme.md +9 -9
- package/components/snk-crud/readme.md +30 -0
- package/components/snk-crud/subcomponents/readme.md +10 -0
- package/components/snk-data-unit/readme.md +20 -0
- package/components/snk-form/readme.md +10 -0
- package/components/snk-grid/readme.md +20 -0
- package/components/snk-simple-crud/readme.md +40 -0
- package/package.json +1 -1
|
@@ -7,15 +7,15 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description | Type | Default
|
|
11
|
-
| -------------------------- | -------------- | -------------------------------------------------------------------------------------- | ----------------------------------------- |
|
|
12
|
-
| `dataUnit` | -- | DataUnit responsável por carregar os dados. | `DataUnit` | `undefined`
|
|
13
|
-
| `dataUnitBuilder` | -- | DataUnitBuilder responsável por implementar dados a serem utilizados no DataUnit. | `FetcherFacade` | `undefined`
|
|
14
|
-
| `entityName` | `entity-name` | Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai. | `string` | `undefined`
|
|
15
|
-
| `fetcher` | -- | Fetcher responsável por carregar os dados do DataUnit. | `AttachFetcherFacadeInterface` | `undefined`
|
|
16
|
-
| `fetcherType` | `fetcher-type` | FetcherType define o tipo de fetcher responsável por carregar os dados do DataUnit. | `"AnexoSistema" \| "Another" \| "Attach"` | `
|
|
17
|
-
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined`
|
|
18
|
-
| `registerKey` _(required)_ | `register-key` | Identificação do registro pai. | `string` | `undefined`
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------------------------- | -------------- | -------------------------------------------------------------------------------------- | ----------------------------------------- | ----------- |
|
|
12
|
+
| `dataUnit` | -- | DataUnit responsável por carregar os dados. | `DataUnit` | `undefined` |
|
|
13
|
+
| `dataUnitBuilder` | -- | DataUnitBuilder responsável por implementar dados a serem utilizados no DataUnit. | `FetcherFacade` | `undefined` |
|
|
14
|
+
| `entityName` | `entity-name` | Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai. | `string` | `undefined` |
|
|
15
|
+
| `fetcher` | -- | Fetcher responsável por carregar os dados do DataUnit. | `AttachFetcherFacadeInterface` | `undefined` |
|
|
16
|
+
| `fetcherType` | `fetcher-type` | FetcherType define o tipo de fetcher responsável por carregar os dados do DataUnit. | `"AnexoSistema" \| "Another" \| "Attach"` | `undefined` |
|
|
17
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
18
|
+
| `registerKey` _(required)_ | `register-key` | Identificação do registro pai. | `string` | `undefined` |
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
## Events
|
|
@@ -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
|
|
|
@@ -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
|
|
@@ -46,6 +46,26 @@ 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
|
+
|
|
49
69
|
### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
|
|
50
70
|
|
|
51
71
|
Busca os metadados da linha selecionada.
|
|
@@ -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.
|
|
@@ -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.
|
|
@@ -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
|
### `closeConfigurator() => Promise<void>`
|
|
46
56
|
|
|
47
57
|
Usado para fechar o configurator do CRUD
|
|
@@ -82,6 +92,26 @@ 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
|
+
|
|
105
|
+
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
106
|
+
|
|
107
|
+
Altera/adiciona uma propriedade nos metadados do campo.
|
|
108
|
+
|
|
109
|
+
#### Returns
|
|
110
|
+
|
|
111
|
+
Type: `Promise<void>`
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
85
115
|
### `setMetadata(metadata: UnitMetadata) => Promise<void>`
|
|
86
116
|
|
|
87
117
|
|
|
@@ -102,6 +132,16 @@ Type: `Promise<void>`
|
|
|
102
132
|
|
|
103
133
|
|
|
104
134
|
|
|
135
|
+
### `updateConfig() => Promise<void>`
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
#### Returns
|
|
140
|
+
|
|
141
|
+
Type: `Promise<void>`
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
105
145
|
|
|
106
146
|
## Dependencies
|
|
107
147
|
|