@sankhyalabs/ezui-docs 0.0.0-feat-dev-KB-46477.7 → 0.0.0-feat-dev-KB-52390.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.
Files changed (5) hide show
  1. package/components/ez-form/readme.md +3 -2
  2. package/components/ez-form-view/custom-input/readme.md +67 -0
  3. package/components/ez-form-view/readme.md +4 -2
  4. package/components/ez-grid/readme.md +12 -22
  5. package/package.json +1 -1
package/components/ez-form/readme.md CHANGED
@@ -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
package/components/ez-form-view/custom-input/readme.md ADDED
@@ -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
+
package/components/ez-form-view/readme.md CHANGED
@@ -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
package/components/ez-grid/readme.md CHANGED
@@ -44,9 +44,19 @@ 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
+
51
+ #### Returns
52
+
53
+ Type: `Promise<void>`
54
+
55
+
56
+
57
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
58
+
59
+ Registra um render customizado para colunas da grid.
50
60
 
51
61
  #### Returns
52
62
 
@@ -114,26 +124,6 @@ Type: `Promise<void>`
114
124
 
115
125
 
116
126
 
117
- ### `refreshSelectedRows() => Promise<void>`
118
-
119
- Atualiza linhas da grade.
120
-
121
- #### Returns
122
-
123
- Type: `Promise<void>`
124
-
125
-
126
-
127
- ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
128
-
129
- Remove o formatador de valores de uma coluna da grid.
130
-
131
- #### Returns
132
-
133
- Type: `Promise<void>`
134
-
135
-
136
-
137
127
  ### `setColumnsDef(cols: Array<EzGridColumn>) => Promise<void>`
138
128
 
139
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.7",
3
+ "version": "0.0.0-feat-dev-KB-52390.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [