@sankhyalabs/ezui-docs 0.0.0-feat-dev-KB-46477.9 → 0.0.0-feat-dev-KB-52390.3

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.
@@ -27,9 +27,9 @@
27
27
 
28
28
  ## Methods
29
29
 
30
- ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
30
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
31
31
 
32
- Altera/adiciona uma propriedade nos metadados do campo.
32
+ Registra um editor customizado para campos da grade e formulário.
33
33
 
34
34
  #### Returns
35
35
 
@@ -61,6 +61,7 @@ graph TD;
61
61
  ez-form --> ez-tabselector
62
62
  ez-form --> ez-form-view
63
63
  ez-tabselector --> ez-icon
64
+ ez-form-view --> ez-custom-form-input
64
65
  ez-form-view --> ez-collapsible-box
65
66
  ez-form-view --> ez-check
66
67
  ez-form-view --> ez-combo-box
@@ -0,0 +1,67 @@
1
+ # ez-custom-form-input
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ---------------- | ------------------------------------------------------------------------------------- | ---------------------------------------- | ----------- |
12
+ | `builderFallback` | -- | Builder original do FormView que será chamado caso o custom não retorne nenhum valor. | `(field: IFormViewField) => HTMLElement` | `undefined` |
13
+ | `customEditor` | -- | Instância do editor customizado. | `ICustomEditor` | `undefined` |
14
+ | `detailContext` | `detail-context` | Define de qual contexto o editor está sendo acionado. | `string` | `undefined` |
15
+ | `formViewField` | -- | Campo que o elemento customizado representa. | `IFormViewField` | `undefined` |
16
+ | `value` | `value` | Valores dos campos do formulário. | `any` | `undefined` |
17
+
18
+
19
+ ## Methods
20
+
21
+ ### `isInvalid() => Promise<boolean>`
22
+
23
+ Retorna se o conteúdo é inválido.
24
+
25
+ #### Returns
26
+
27
+ Type: `Promise<boolean>`
28
+
29
+
30
+
31
+ ### `setBlur() => Promise<void>`
32
+
33
+ Remove o foco do campo.
34
+
35
+ #### Returns
36
+
37
+ Type: `Promise<void>`
38
+
39
+
40
+
41
+ ### `setFocus() => Promise<void>`
42
+
43
+ Aplica foco no campo.
44
+
45
+ #### Returns
46
+
47
+ Type: `Promise<void>`
48
+
49
+
50
+
51
+
52
+ ## Dependencies
53
+
54
+ ### Used by
55
+
56
+ - [ez-form-view](..)
57
+
58
+ ### Graph
59
+ ```mermaid
60
+ graph TD;
61
+ ez-form-view --> ez-custom-form-input
62
+ style ez-custom-form-input fill:#f9f,stroke:#333,stroke-width:4px
63
+ ```
64
+
65
+ ----------------------------------------------
66
+
67
+
@@ -22,9 +22,9 @@
22
22
 
23
23
  ## Methods
24
24
 
25
- ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
25
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
26
26
 
27
- Altera/adiciona uma propriedade nos metados do campo.
27
+ Registra um editor customizado para campos da grade e formulário.
28
28
 
29
29
  #### Returns
30
30
 
@@ -51,6 +51,7 @@ Type: `Promise<void>`
51
51
 
52
52
  ### Depends on
53
53
 
54
+ - [ez-custom-form-input](custom-input)
54
55
  - [ez-collapsible-box](../ez-collapsible-box)
55
56
  - [ez-check](../ez-check)
56
57
  - [ez-combo-box](../ez-combo-box)
@@ -66,6 +67,7 @@ Type: `Promise<void>`
66
67
  ### Graph
67
68
  ```mermaid
68
69
  graph TD;
70
+ ez-form-view --> ez-custom-form-input
69
71
  ez-form-view --> ez-collapsible-box
70
72
  ez-form-view --> ez-check
71
73
  ez-form-view --> ez-combo-box
@@ -44,9 +44,9 @@ Type: `Promise<void>`
44
44
 
45
45
 
46
46
 
47
- ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
47
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
48
48
 
49
- Registra um formatador de valores para uma coluna da grid.
49
+ Registra um editor customizado para campos da grade e formulário.
50
50
 
51
51
  #### Returns
52
52
 
@@ -54,19 +54,19 @@ Type: `Promise<void>`
54
54
 
55
55
 
56
56
 
57
- ### `filterColumns(search: string) => Promise<Array<EzGridColumn>>`
57
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
58
58
 
59
- Usa um argumento para filtrar as colunas po label
59
+ Registra um render customizado para colunas da grid.
60
60
 
61
61
  #### Returns
62
62
 
63
- Type: `Promise<EzGridColumn[]>`
63
+ Type: `Promise<void>`
64
64
 
65
65
 
66
66
 
67
- ### `getColumns() => Promise<Array<EzGridColumn>>`
67
+ ### `filterColumns(search: string) => Promise<Array<EzGridColumn>>`
68
68
 
69
- Obtém a lista de definição de colunas.
69
+ Usa um argumento para filtrar as colunas po label
70
70
 
71
71
  #### Returns
72
72
 
@@ -74,9 +74,9 @@ Type: `Promise<EzGridColumn[]>`
74
74
 
75
75
 
76
76
 
77
- ### `getColumnsState() => Promise<Array<EzGridColumn>>`
77
+ ### `getColumns() => Promise<Array<EzGridColumn>>`
78
78
 
79
- Obtém o estado atual das colunas.
79
+ Obtém a lista de definição de colunas.
80
80
 
81
81
  #### Returns
82
82
 
@@ -84,13 +84,13 @@ Type: `Promise<EzGridColumn[]>`
84
84
 
85
85
 
86
86
 
87
- ### `getCustomValueFormatter(columnName: string) => Promise<ICustomFormatter | undefined>`
87
+ ### `getColumnsState() => Promise<Array<EzGridColumn>>`
88
88
 
89
- Retorna o formatador customizado da coluna caso exista.
89
+ Obtém o estado atual das colunas.
90
90
 
91
91
  #### Returns
92
92
 
93
- Type: `Promise<ICustomFormatter>`
93
+ Type: `Promise<EzGridColumn[]>`
94
94
 
95
95
 
96
96
 
@@ -124,26 +124,6 @@ Type: `Promise<void>`
124
124
 
125
125
 
126
126
 
127
- ### `refreshSelectedRows() => Promise<void>`
128
-
129
- Atualiza linhas da grade.
130
-
131
- #### Returns
132
-
133
- Type: `Promise<void>`
134
-
135
-
136
-
137
- ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
138
-
139
- Remove o formatador de valores de uma coluna da grid.
140
-
141
- #### Returns
142
-
143
- Type: `Promise<void>`
144
-
145
-
146
-
147
127
  ### `setColumnsDef(cols: Array<EzGridColumn>) => Promise<void>`
148
128
 
149
129
  Aplica a definição de colunas.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "0.0.0-feat-dev-KB-46477.9",
3
+ "version": "0.0.0-feat-dev-KB-52390.3",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [