@sankhyalabs/ezui-docs 5.21.2 → 5.22.0-dev.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.
Files changed (13) hide show
  1. package/components/ez-button/readme.md +2 -0
  2. package/components/ez-chart/readme.md +32 -0
  3. package/components/ez-form/readme.md +28 -6
  4. package/components/ez-form-view/custom-input/readme.md +68 -0
  5. package/components/ez-form-view/readme.md +26 -3
  6. package/components/ez-grid/readme.md +61 -0
  7. package/components/ez-guide-navigator/readme.md +1 -0
  8. package/components/ez-icon/readme.md +2 -0
  9. package/components/ez-list/readme.md +1 -0
  10. package/components/ez-scroller/readme.md +2 -0
  11. package/components/ez-sidebar-button/readme.md +7 -0
  12. package/components/ez-sidebar-navigator/readme.md +82 -0
  13. package/package.json +1 -1
package/components/ez-button/readme.md CHANGED
@@ -50,6 +50,7 @@ Type: `Promise<void>`
50
50
  - [ez-grid](../ez-grid)
51
51
  - [ez-guide-navigator](../ez-guide-navigator)
52
52
  - [ez-modal-container](../ez-modal-container)
53
+ - [ez-sidebar-navigator](../ez-sidebar-navigator)
53
54
  - [ez-split-item](../ez-split-panel/structure/item)
54
55
  - [ez-text-edit](../ez-text-edit)
55
56
  - [filter-column](../ez-grid/subcomponents)
@@ -68,6 +69,7 @@ graph TD;
68
69
  ez-grid --> ez-button
69
70
  ez-guide-navigator --> ez-button
70
71
  ez-modal-container --> ez-button
72
+ ez-sidebar-navigator --> ez-button
71
73
  ez-split-item --> ez-button
72
74
  ez-text-edit --> ez-button
73
75
  filter-column --> ez-button
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,68 @@
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
+ | `selectedRecord` | -- | Define os registros da linha selecionada. | `Record` | `undefined` |
17
+ | `value` | `value` | Valores dos campos do formulário. | `any` | `undefined` |
18
+
19
+
20
+ ## Methods
21
+
22
+ ### `isInvalid() => Promise<boolean>`
23
+
24
+ Retorna se o conteúdo é inválido.
25
+
26
+ #### Returns
27
+
28
+ Type: `Promise<boolean>`
29
+
30
+
31
+
32
+ ### `setBlur() => Promise<void>`
33
+
34
+ Remove o foco do campo.
35
+
36
+ #### Returns
37
+
38
+ Type: `Promise<void>`
39
+
40
+
41
+
42
+ ### `setFocus() => Promise<void>`
43
+
44
+ Aplica foco no campo.
45
+
46
+ #### Returns
47
+
48
+ Type: `Promise<void>`
49
+
50
+
51
+
52
+
53
+ ## Dependencies
54
+
55
+ ### Used by
56
+
57
+ - [ez-form-view](..)
58
+
59
+ ### Graph
60
+ ```mermaid
61
+ graph TD;
62
+ ez-form-view --> ez-custom-form-input
63
+ style ez-custom-form-input fill:#f9f,stroke:#333,stroke-width:4px
64
+ ```
65
+
66
+ ----------------------------------------------
67
+
68
+
package/components/ez-form-view/readme.md CHANGED
@@ -7,9 +7,10 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------- | --------- | ------------------------------------------------------------------------- | ------------------ | ----------- |
12
- | `fields` | -- | Define a lista de metadados usada para criar os campos de user interface. | `IFormViewField[]` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------- | --------- | ------------------------------------------------------------------------- | ------------------ | ----------- |
12
+ | `fields` | -- | Define a lista de metadados usada para criar os campos de user interface. | `IFormViewField[]` | `undefined` |
13
+ | `selectedRecord` | -- | Define os registros da linha selecionada. | `Record` | `undefined` |
13
14
 
14
15
 
15
16
  ## Events
@@ -22,6 +23,26 @@
22
23
 
23
24
  ## Methods
24
25
 
26
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
27
+
28
+ Registra um editor customizado para campos da grade e formulário.
29
+
30
+ #### Returns
31
+
32
+ Type: `Promise<void>`
33
+
34
+
35
+
36
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
37
+
38
+ Altera/adiciona uma propriedade nos metados do campo.
39
+
40
+ #### Returns
41
+
42
+ Type: `Promise<void>`
43
+
44
+
45
+
25
46
  ### `showUp() => Promise<void>`
26
47
 
27
48
 
@@ -41,6 +62,7 @@ Type: `Promise<void>`
41
62
 
42
63
  ### Depends on
43
64
 
65
+ - [ez-custom-form-input](custom-input)
44
66
  - [ez-collapsible-box](../ez-collapsible-box)
45
67
  - [ez-check](../ez-check)
46
68
  - [ez-combo-box](../ez-combo-box)
@@ -56,6 +78,7 @@ Type: `Promise<void>`
56
78
  ### Graph
57
79
  ```mermaid
58
80
  graph TD;
81
+ ez-form-view --> ez-custom-form-input
59
82
  ez-form-view --> ez-collapsible-box
60
83
  ez-form-view --> ez-check
61
84
  ez-form-view --> ez-combo-box
package/components/ez-grid/readme.md CHANGED
@@ -9,6 +9,7 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ------------------------ | -------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
12
+ | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
12
13
  | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
13
14
  | `columnfilterDataSource` | -- | Define um `IMultiSelectionListDataSource` responsável por alimentar o filtro de colunas. | `IMultiSelectionListDataSource` | `undefined` |
14
15
  | `config` | -- | Configuração de exibição da grade. | `IGridConfig` | `undefined` |
@@ -44,6 +45,36 @@ Type: `Promise<void>`
44
45
 
45
46
 
46
47
 
48
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
49
+
50
+ Registra um editor customizado para campos da grade e formulário.
51
+
52
+ #### Returns
53
+
54
+ Type: `Promise<void>`
55
+
56
+
57
+
58
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
59
+
60
+ Registra um formatador de valores para uma coluna da grid.
61
+
62
+ #### Returns
63
+
64
+ Type: `Promise<void>`
65
+
66
+
67
+
68
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
69
+
70
+ Registra um render customizado para colunas da grid.
71
+
72
+ #### Returns
73
+
74
+ Type: `Promise<void>`
75
+
76
+
77
+
47
78
  ### `filterColumns(search: string) => Promise<Array<EzGridColumn>>`
48
79
 
49
80
  Usa um argumento para filtrar as colunas po label
@@ -74,6 +105,16 @@ Type: `Promise<EzGridColumn[]>`
74
105
 
75
106
 
76
107
 
108
+ ### `getCustomValueFormatter(columnName: string) => Promise<ICustomFormatter | undefined>`
109
+
110
+ Retorna o formatador customizado da coluna caso exista.
111
+
112
+ #### Returns
113
+
114
+ Type: `Promise<ICustomFormatter>`
115
+
116
+
117
+
77
118
  ### `getSelection() => Promise<Array<any>>`
78
119
 
79
120
  Obtém as linhas selecionadas.
@@ -104,6 +145,26 @@ Type: `Promise<void>`
104
145
 
105
146
 
106
147
 
148
+ ### `refreshSelectedRows() => Promise<void>`
149
+
150
+ Atualiza linhas da grade.
151
+
152
+ #### Returns
153
+
154
+ Type: `Promise<void>`
155
+
156
+
157
+
158
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
159
+
160
+ Remove o formatador de valores de uma coluna da grid.
161
+
162
+ #### Returns
163
+
164
+ Type: `Promise<void>`
165
+
166
+
167
+
107
168
  ### `setColumnsDef(cols: Array<EzGridColumn>) => Promise<void>`
108
169
 
109
170
  Aplica a definição de colunas.
package/components/ez-guide-navigator/readme.md CHANGED
@@ -123,6 +123,7 @@ graph TD;
123
123
  ez-guide-navigator --> ez-button
124
124
  ez-guide-navigator --> ez-scroller
125
125
  ez-guide-navigator --> ez-tree
126
+ ez-sidebar-button --> ez-icon
126
127
  ez-filter-input --> ez-text-input
127
128
  ez-filter-input --> ez-icon
128
129
  ez-button --> ez-icon
package/components/ez-icon/readme.md CHANGED
@@ -34,6 +34,7 @@
34
34
  - [ez-modal-container](../ez-modal-container)
35
35
  - [ez-multi-selection-list](../ez-multi-selection-list)
36
36
  - [ez-search](../ez-search)
37
+ - [ez-sidebar-button](../ez-sidebar-button)
37
38
  - [ez-split-button](../ez-split-button)
38
39
  - [ez-tabselector](../ez-tabselector)
39
40
  - [ez-time-input](../ez-time-input)
@@ -58,6 +59,7 @@ graph TD;
58
59
  ez-modal-container --> ez-icon
59
60
  ez-multi-selection-list --> ez-icon
60
61
  ez-search --> ez-icon
62
+ ez-sidebar-button --> ez-icon
61
63
  ez-split-button --> ez-icon
62
64
  ez-tabselector --> ez-icon
63
65
  ez-time-input --> ez-icon
package/components/ez-list/readme.md CHANGED
@@ -25,6 +25,7 @@
25
25
  | --------------- | ----------------------------------------------------------- | ---------------------------------------- |
26
26
  | `ezChange` | Emitido quando acontece a alteração de estado da lista. | `CustomEvent<(ListItem \| ListGroup)[]>` |
27
27
  | `ezCheckChange` | Emitido quando acontece a alteração de um item do checkbox. | `CustomEvent<ListItem>` |
28
+ | `ezDoubleClick` | Emitido quando ocorre um duplo clique em um item da lista. | `CustomEvent<ListItem>` |
28
29
  | `ezSelectItem` | Emitido sempre que um item da lista for selecionado. | `CustomEvent<ListItem>` |
29
30
 
30
31
 
package/components/ez-scroller/readme.md CHANGED
@@ -19,11 +19,13 @@
19
19
  ### Used by
20
20
 
21
21
  - [ez-guide-navigator](../ez-guide-navigator)
22
+ - [ez-sidebar-navigator](../ez-sidebar-navigator)
22
23
 
23
24
  ### Graph
24
25
  ```mermaid
25
26
  graph TD;
26
27
  ez-guide-navigator --> ez-scroller
28
+ ez-sidebar-navigator --> ez-scroller
27
29
  style ez-scroller fill:#f9f,stroke:#333,stroke-width:4px
28
30
  ```
29
31
 
package/components/ez-sidebar-button/readme.md CHANGED
@@ -17,11 +17,18 @@
17
17
  ### Used by
18
18
 
19
19
  - [ez-guide-navigator](../ez-guide-navigator)
20
+ - [ez-sidebar-navigator](../ez-sidebar-navigator)
21
+
22
+ ### Depends on
23
+
24
+ - [ez-icon](../ez-icon)
20
25
 
21
26
  ### Graph
22
27
  ```mermaid
23
28
  graph TD;
29
+ ez-sidebar-button --> ez-icon
24
30
  ez-guide-navigator --> ez-sidebar-button
31
+ ez-sidebar-navigator --> ez-sidebar-button
25
32
  style ez-sidebar-button fill:#f9f,stroke:#333,stroke-width:4px
26
33
  ```
27
34
 
package/components/ez-sidebar-navigator/readme.md ADDED
@@ -0,0 +1,82 @@
1
+ # ez-sidebar-navigator
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | -------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------ | ---------------------- |
12
+ | `isResponsive` | `is-responsive` | Define se terá responsividade, Controle deverá ser pelo CSS. | `boolean` | `false` |
13
+ | `mode` | `mode` | Define se o menu será do tipo FIXED ou FLOAT. | `ModeMenuEnum.FIXED \| ModeMenuEnum.FLOAT` | `ModeMenuEnum.FLOAT` |
14
+ | `showCollapseMenu` | `show-collapse-menu` | Define se o botão de "Recolher Menu" será exibido | `boolean` | `true` |
15
+ | `showFixedButton` | `show-fixed-button` | Define se o botão de "Fixar Menu" será exibido | `boolean` | `true` |
16
+ | `size` | `size` | Define o tamanho do menu (small, medium, large). | `SizeMenuEnum.LARGE \| SizeMenuEnum.MEDIUM \| SizeMenuEnum.SMALL` | `SizeMenuEnum.SMALL` |
17
+ | `titleMenu` | `title-menu` | Define o título do Sidebar Navigator | `string` | `""` |
18
+ | `type` | `type` | Define o tipo do menu (float, fixed ou dynamic (livre)). | `TypeMenuEnum.DYNAMIC \| TypeMenuEnum.FIXED \| TypeMenuEnum.FLOAT` | `TypeMenuEnum.DYNAMIC` |
19
+
20
+
21
+ ## Events
22
+
23
+ | Event | Description | Type |
24
+ | -------------- | ------------------------------------------------------------------------ | ------------------------------------------------------- |
25
+ | `ezChangeMode` | Evento emitido sempre que o modo (FLOAT ou FIXED) do menu for alterado.. | `CustomEvent<ModeMenuEnum.FIXED \| ModeMenuEnum.FLOAT>` |
26
+
27
+
28
+ ## Methods
29
+
30
+ ### `changeModeMenu() => Promise<void>`
31
+
32
+ Método para fixar/desafixar o menu, emitindo o evento ezChangeMode.
33
+
34
+ #### Returns
35
+
36
+ Type: `Promise<void>`
37
+
38
+
39
+
40
+ ### `closeSidebar() => Promise<void>`
41
+
42
+ Método para fechar o menu automaticamente após uma ação, fluxo, etc.
43
+
44
+ #### Returns
45
+
46
+ Type: `Promise<void>`
47
+
48
+
49
+
50
+ ### `openSidebar() => Promise<void>`
51
+
52
+ Método para abrir o menu automaticamente após uma ação, fluxo, etc.
53
+
54
+ #### Returns
55
+
56
+ Type: `Promise<void>`
57
+
58
+
59
+
60
+
61
+ ## Dependencies
62
+
63
+ ### Depends on
64
+
65
+ - [ez-sidebar-button](../ez-sidebar-button)
66
+ - [ez-button](../ez-button)
67
+ - [ez-scroller](../ez-scroller)
68
+
69
+ ### Graph
70
+ ```mermaid
71
+ graph TD;
72
+ ez-sidebar-navigator --> ez-sidebar-button
73
+ ez-sidebar-navigator --> ez-button
74
+ ez-sidebar-navigator --> ez-scroller
75
+ ez-sidebar-button --> ez-icon
76
+ ez-button --> ez-icon
77
+ style ez-sidebar-navigator fill:#f9f,stroke:#333,stroke-width:4px
78
+ ```
79
+
80
+ ----------------------------------------------
81
+
82
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "5.21.2",
3
+ "version": "5.22.0-dev.2",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [