@sankhyalabs/ezui-docs 5.21.0-dev.2 → 5.21.0-dev.21

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 (7) hide show
  1. package/components/ez-chart/readme.md +32 -0
  2. package/components/ez-form/readme.md +28 -6
  3. package/components/ez-form-view/custom-input/readme.md +67 -0
  4. package/components/ez-form-view/readme.md +22 -0
  5. package/components/ez-grid/readme.md +70 -0
  6. package/components/ez-modal/readme.md +5 -4
  7. package/package.json +1 -1
package/components/ez-chart/readme.md ADDED
@@ -0,0 +1,32 @@
1
+ # ez-chart
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------- | ----------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
12
+ | `chartSubTitle` | `chart-sub-title` | Define o sub titulo a ser apresentado no gráfico | `string` | `""` |
13
+ | `chartTitle` | `chart-title` | Define o titulo a ser apresentado no gráfico | `string` | `""` |
14
+ | `height` | `height` | Define a altura do gráfico | `number` | `undefined` |
15
+ | `legendEnabled` | `legend-enabled` | Define se a legenda do gráfico deve ser apresentada ou não. | `boolean` | `true` |
16
+ | `series` | -- | Define as series a serem apresentadas no gráfico | `ChartSerie[] \| ({ data: (number \| ChartSerieData)[]; name?: string; color?: string; type?: "line" \| "column" \| "bar"; yAxis?: number; toolTipFormatter?: (serieName: string, xAxis: string \| number, yAxis: number, dataName: string, percentage: number) => string; showDataLabel?: boolean; })` | `undefined` |
17
+ | `type` | `type` | Define o tipo de gráfico apresentado pelo componente | `ChartType.BAR \| ChartType.COLUMN \| ChartType.DONUT \| ChartType.LINE \| ChartType.PIE` | `ChartType.LINE` |
18
+ | `width` | `width` | Define uma largura do gráfico | `number` | `undefined` |
19
+ | `xAxis` | -- | Definições do eixo X do gráfico | `ChartAxis[] \| ({ color?: string; categories?: string[]; formatter?: (value: string \| number) => string; text?: string; invertedPosition?: boolean; })` | `undefined` |
20
+ | `yAxis` | -- | Definições do eixo Y do gráfico | `ChartAxis[] \| ({ color?: string; categories?: string[]; formatter?: (value: string \| number) => string; text?: string; invertedPosition?: boolean; })` | `undefined` |
21
+
22
+
23
+ ## Events
24
+
25
+ | Event | Description | Type |
26
+ | -------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------- |
27
+ | `ezSerieClick` | Evento emitido quando ocorre um click em uma serie do gráfico | `CustomEvent<{ name: string; data: number[]; type: string; yAxis: number; }>` |
28
+
29
+
30
+ ----------------------------------------------
31
+
32
+
package/components/ez-form/readme.md CHANGED
@@ -7,12 +7,13 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------ | ---------------- | --------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
12
- | `config` | -- | Configuração do formulário. | `IFormConfig` | `undefined` |
13
- | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
14
- | `fieldToFocus` | `field-to-focus` | Determina o campo que deve ficar em evidência. | `string` | `undefined` |
15
- | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
12
+ | `config` | -- | Configuração do formulário. | `IFormConfig` | `undefined` |
13
+ | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
14
+ | `fieldToFocus` | `field-to-focus` | Determina o campo que deve ficar em evidência. | `string` | `undefined` |
15
+ | `onlyStaticFields` | `only-static-fields` | Define se os campos que serão apresentados são todos estáticos. Quando verdadeira, ocorrerá no DataBinder o bind dos campos com o DataUnit. | `boolean` | `false` |
16
+ | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
16
17
 
17
18
 
18
19
  ## Events
@@ -27,6 +28,26 @@
27
28
 
28
29
  ## Methods
29
30
 
31
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
32
+
33
+ Registra um editor customizado para campos da grade e formulário.
34
+
35
+ #### Returns
36
+
37
+ Type: `Promise<void>`
38
+
39
+
40
+
41
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
42
+
43
+ Altera/adiciona uma propriedade nos metadados do campo.
44
+
45
+ #### Returns
46
+
47
+ Type: `Promise<void>`
48
+
49
+
50
+
30
51
  ### `validate() => Promise<void>`
31
52
 
32
53
  Realiza validação no conteúdo de todos os campos.
@@ -51,6 +72,7 @@ graph TD;
51
72
  ez-form --> ez-tabselector
52
73
  ez-form --> ez-form-view
53
74
  ez-tabselector --> ez-icon
75
+ ez-form-view --> ez-custom-form-input
54
76
  ez-form-view --> ez-collapsible-box
55
77
  ez-form-view --> ez-check
56
78
  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,6 +22,26 @@
22
22
 
23
23
  ## Methods
24
24
 
25
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
26
+
27
+ Registra um editor customizado para campos da grade e formulário.
28
+
29
+ #### Returns
30
+
31
+ Type: `Promise<void>`
32
+
33
+
34
+
35
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
36
+
37
+ Altera/adiciona uma propriedade nos metados do campo.
38
+
39
+ #### Returns
40
+
41
+ Type: `Promise<void>`
42
+
43
+
44
+
25
45
  ### `showUp() => Promise<void>`
26
46
 
27
47
 
@@ -41,6 +61,7 @@ Type: `Promise<void>`
41
61
 
42
62
  ### Depends on
43
63
 
64
+ - [ez-custom-form-input](custom-input)
44
65
  - [ez-collapsible-box](../ez-collapsible-box)
45
66
  - [ez-check](../ez-check)
46
67
  - [ez-combo-box](../ez-combo-box)
@@ -56,6 +77,7 @@ Type: `Promise<void>`
56
77
  ### Graph
57
78
  ```mermaid
58
79
  graph TD;
80
+ ez-form-view --> ez-custom-form-input
59
81
  ez-form-view --> ez-collapsible-box
60
82
  ez-form-view --> ez-check
61
83
  ez-form-view --> ez-combo-box
package/components/ez-grid/readme.md CHANGED
@@ -44,6 +44,36 @@ Type: `Promise<void>`
44
44
 
45
45
 
46
46
 
47
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
48
+
49
+ Registra um editor customizado para campos da grade e formulário.
50
+
51
+ #### Returns
52
+
53
+ Type: `Promise<void>`
54
+
55
+
56
+
57
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
58
+
59
+ Registra um formatador de valores para uma coluna da grid.
60
+
61
+ #### Returns
62
+
63
+ Type: `Promise<void>`
64
+
65
+
66
+
67
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
68
+
69
+ Registra um render customizado para colunas da grid.
70
+
71
+ #### Returns
72
+
73
+ Type: `Promise<void>`
74
+
75
+
76
+
47
77
  ### `filterColumns(search: string) => Promise<Array<EzGridColumn>>`
48
78
 
49
79
  Usa um argumento para filtrar as colunas po label
@@ -74,6 +104,16 @@ Type: `Promise<EzGridColumn[]>`
74
104
 
75
105
 
76
106
 
107
+ ### `getCustomValueFormatter(columnName: string) => Promise<ICustomFormatter | undefined>`
108
+
109
+ Retorna o formatador customizado da coluna caso exista.
110
+
111
+ #### Returns
112
+
113
+ Type: `Promise<ICustomFormatter>`
114
+
115
+
116
+
77
117
  ### `getSelection() => Promise<Array<any>>`
78
118
 
79
119
  Obtém as linhas selecionadas.
@@ -104,6 +144,26 @@ Type: `Promise<void>`
104
144
 
105
145
 
106
146
 
147
+ ### `refreshSelectedRows() => Promise<void>`
148
+
149
+ Atualiza linhas da grade.
150
+
151
+ #### Returns
152
+
153
+ Type: `Promise<void>`
154
+
155
+
156
+
157
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
158
+
159
+ Remove o formatador de valores de uma coluna da grid.
160
+
161
+ #### Returns
162
+
163
+ Type: `Promise<void>`
164
+
165
+
166
+
107
167
  ### `setColumnsDef(cols: Array<EzGridColumn>) => Promise<void>`
108
168
 
109
169
  Aplica a definição de colunas.
@@ -134,6 +194,16 @@ Type: `Promise<void>`
134
194
 
135
195
 
136
196
 
197
+ ### `setFocus() => Promise<void>`
198
+
199
+ Atribui o foco para a grade.
200
+
201
+ #### Returns
202
+
203
+ Type: `Promise<void>`
204
+
205
+
206
+
137
207
 
138
208
  ## Dependencies
139
209
 
package/components/ez-modal/readme.md CHANGED
@@ -20,10 +20,11 @@
20
20
 
21
21
  ## Events
22
22
 
23
- | Event | Description | Type |
24
- | -------------- | --------------------------------- | ---------------------- |
25
- | `ezCloseModal` | Emitido quando o modal é fechado. | `CustomEvent<boolean>` |
26
- | `ezOpenModal` | Emitido quando o modal é aberto. | `CustomEvent<any>` |
23
+ | Event | Description | Type |
24
+ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------- |
25
+ | `ezCloseModal` | Emitido quando o modal é fechado. | `CustomEvent<boolean>` |
26
+ | `ezModalAction` | Representa a interação com o usuário. OK - Quando o botão é acionado CANCEL - Quando o botão de cancelar é acionado CLOSE - Quando o botão de fechar é acionado. LOAD - Quando o modal é carregado (eventualmente pode ser usado para dar foco a um elemento específico) | `CustomEvent<string>` |
27
+ | `ezOpenModal` | Emitido quando o modal é aberto. | `CustomEvent<any>` |
27
28
 
28
29
 
29
30
  ----------------------------------------------
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "5.21.0-dev.2",
3
+ "version": "5.21.0-dev.21",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [