@sankhyalabs/ezui-docs 2.10.1 → 2.12.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 (17) hide show
  1. package/components/ez-check/readme.md +2 -2
  2. package/components/ez-collapsible-box/readme.md +2 -2
  3. package/components/ez-combo-box/readme.md +2 -2
  4. package/components/ez-date-input/readme.md +2 -2
  5. package/components/ez-date-time-input/readme.md +2 -2
  6. package/components/ez-dropdown/readme.md +40 -0
  7. package/components/ez-form/readme.md +25 -28
  8. package/components/ez-form-view/readme.md +70 -0
  9. package/components/ez-icon/readme.md +2 -0
  10. package/components/ez-number-input/readme.md +2 -2
  11. package/components/ez-search/readme.md +2 -2
  12. package/components/ez-text-area/readme.md +2 -2
  13. package/components/ez-text-input/readme.md +2 -2
  14. package/components/ez-time-input/readme.md +2 -2
  15. package/components/ez-tree/readme.md +12 -5
  16. package/components/ez-upload/readme.md +2 -2
  17. package/package.json +1 -1
package/components/ez-check/readme.md CHANGED
@@ -50,12 +50,12 @@ Type: `Promise<void>`
50
50
 
51
51
  ### Used by
52
52
 
53
- - [ez-form](../ez-form)
53
+ - [ez-form-view](../ez-form-view)
54
54
 
55
55
  ### Graph
56
56
  ```mermaid
57
57
  graph TD;
58
- ez-form --> ez-check
58
+ ez-form-view --> ez-check
59
59
  style ez-check fill:#f9f,stroke:#333,stroke-width:4px
60
60
  ```
61
61
 
package/components/ez-collapsible-box/readme.md CHANGED
@@ -66,7 +66,7 @@ Type: `Promise<void>`
66
66
 
67
67
  ### Used by
68
68
 
69
- - [ez-form](../ez-form)
69
+ - [ez-form-view](../ez-form-view)
70
70
 
71
71
  ### Depends on
72
72
 
@@ -81,7 +81,7 @@ graph TD;
81
81
  ez-text-edit --> ez-text-input
82
82
  ez-text-edit --> ez-button
83
83
  ez-button --> ez-icon
84
- ez-form --> ez-collapsible-box
84
+ ez-form-view --> ez-collapsible-box
85
85
  style ez-collapsible-box fill:#f9f,stroke:#333,stroke-width:4px
86
86
  ```
87
87
 
package/components/ez-combo-box/readme.md CHANGED
@@ -68,7 +68,7 @@ Type: `Promise<void>`
68
68
 
69
69
  ### Used by
70
70
 
71
- - [ez-form](../ez-form)
71
+ - [ez-form-view](../ez-form-view)
72
72
  - [ez-search](../ez-search)
73
73
 
74
74
  ### Depends on
@@ -81,7 +81,7 @@ Type: `Promise<void>`
81
81
  graph TD;
82
82
  ez-combo-box --> ez-text-input
83
83
  ez-combo-box --> ez-icon
84
- ez-form --> ez-combo-box
84
+ ez-form-view --> ez-combo-box
85
85
  ez-search --> ez-combo-box
86
86
  style ez-combo-box fill:#f9f,stroke:#333,stroke-width:4px
87
87
  ```
package/components/ez-date-input/readme.md CHANGED
@@ -62,7 +62,7 @@ Type: `Promise<void>`
62
62
 
63
63
  ### Used by
64
64
 
65
- - [ez-form](../ez-form)
65
+ - [ez-form-view](../ez-form-view)
66
66
 
67
67
  ### Depends on
68
68
 
@@ -74,7 +74,7 @@ Type: `Promise<void>`
74
74
  graph TD;
75
75
  ez-date-input --> ez-text-input
76
76
  ez-date-input --> ez-calendar
77
- ez-form --> ez-date-input
77
+ ez-form-view --> ez-date-input
78
78
  style ez-date-input fill:#f9f,stroke:#333,stroke-width:4px
79
79
  ```
80
80
 
package/components/ez-date-time-input/readme.md CHANGED
@@ -63,7 +63,7 @@ Type: `Promise<void>`
63
63
 
64
64
  ### Used by
65
65
 
66
- - [ez-form](../ez-form)
66
+ - [ez-form-view](../ez-form-view)
67
67
 
68
68
  ### Depends on
69
69
 
@@ -75,7 +75,7 @@ Type: `Promise<void>`
75
75
  graph TD;
76
76
  ez-date-time-input --> ez-text-input
77
77
  ez-date-time-input --> ez-calendar
78
- ez-form --> ez-date-time-input
78
+ ez-form-view --> ez-date-time-input
79
79
  style ez-date-time-input fill:#f9f,stroke:#333,stroke-width:4px
80
80
  ```
81
81
 
package/components/ez-dropdown/readme.md ADDED
@@ -0,0 +1,40 @@
1
+ # ez-dropdown
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------- | --------- | -------------------------------------------------------------------------------- | ------------------------------------------------ | ----------- |
12
+ | `itemBuilder` | -- | Função builder que possibilita alterar como o item da lista vai ser apresentado. | `(item: IDropdownItem, level: number) => string` | `undefined` |
13
+ | `items` | -- | Lista de itens que vão ser apresentados no dropdown. | `IDropdownItem[]` | `[]` |
14
+ | `value` | -- | Último item que recebeu o click. | `IDropdownItem` | `undefined` |
15
+
16
+
17
+ ## Events
18
+
19
+ | Event | Description | Type |
20
+ | ------------------ | ------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- |
21
+ | `ezClick` | Emitido quando ocorrer um click em um item da lista, o IDropdownItem que recebeu o click deve ser enviado como data do evento. | `CustomEvent<IDropdownItem>` |
22
+ | `ezSubActionClick` | Emitido quando ocorrer um click em uma ação secundaria do item, o IDropdownSubAction deve ser enviado como data do evento. | `CustomEvent<IDropdownSubAction>` |
23
+
24
+
25
+ ## Dependencies
26
+
27
+ ### Depends on
28
+
29
+ - [ez-icon](../ez-icon)
30
+
31
+ ### Graph
32
+ ```mermaid
33
+ graph TD;
34
+ ez-dropdown --> ez-icon
35
+ style ez-dropdown fill:#f9f,stroke:#333,stroke-width:4px
36
+ ```
37
+
38
+ ----------------------------------------------
39
+
40
+
package/components/ez-form/readme.md CHANGED
@@ -7,11 +7,14 @@
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
- | `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
+ | `contentBuilder` | -- | Define um construtor. Isso permite personalizar o conteúdo do formulário | `(selectedTab: string, fields: IFormViewField[]) => string \| HTMLElement` | `undefined` |
14
+ | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
15
+ | `levelResolver` | -- | Define um resolvedor de nível no modo `multiLevel`. | `(items: ITreeItem[]) => ITreeItem[]` | `undefined` |
16
+ | `multiLevel` | `multi-level` | Habilita o modo de organização com vários níveis. | `boolean` | `undefined` |
17
+ | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
15
18
 
16
19
 
17
20
  ## Events
@@ -38,35 +41,29 @@ Type: `Promise<void>`
38
41
 
39
42
  ### Depends on
40
43
 
44
+ - [ez-tree](../ez-tree)
41
45
  - [ez-tabselector](../ez-tabselector)
42
- - [ez-collapsible-box](../ez-collapsible-box)
43
- - [ez-text-area](../ez-text-area)
44
- - [ez-text-input](../ez-text-input)
45
- - [ez-check](../ez-check)
46
- - [ez-combo-box](../ez-combo-box)
47
- - [ez-search](../ez-search)
48
- - [ez-upload](../ez-upload)
49
- - [ez-date-input](../ez-date-input)
50
- - [ez-time-input](../ez-time-input)
51
- - [ez-date-time-input](../ez-date-time-input)
52
- - [ez-number-input](../ez-number-input)
46
+ - [ez-form-view](../ez-form-view)
53
47
 
54
48
  ### Graph
55
49
  ```mermaid
56
50
  graph TD;
51
+ ez-form --> ez-tree
57
52
  ez-form --> ez-tabselector
58
- ez-form --> ez-collapsible-box
59
- ez-form --> ez-text-area
60
- ez-form --> ez-text-input
61
- ez-form --> ez-check
62
- ez-form --> ez-combo-box
63
- ez-form --> ez-search
64
- ez-form --> ez-upload
65
- ez-form --> ez-date-input
66
- ez-form --> ez-time-input
67
- ez-form --> ez-date-time-input
68
- ez-form --> ez-number-input
53
+ ez-form --> ez-form-view
54
+ ez-tree --> ez-icon
69
55
  ez-tabselector --> ez-icon
56
+ ez-form-view --> ez-collapsible-box
57
+ ez-form-view --> ez-check
58
+ ez-form-view --> ez-combo-box
59
+ ez-form-view --> ez-date-input
60
+ ez-form-view --> ez-time-input
61
+ ez-form-view --> ez-date-time-input
62
+ ez-form-view --> ez-upload
63
+ ez-form-view --> ez-number-input
64
+ ez-form-view --> ez-search
65
+ ez-form-view --> ez-text-area
66
+ ez-form-view --> ez-text-input
70
67
  ez-collapsible-box --> ez-icon
71
68
  ez-collapsible-box --> ez-text-edit
72
69
  ez-text-edit --> ez-text-input
@@ -74,7 +71,6 @@ graph TD;
74
71
  ez-button --> ez-icon
75
72
  ez-combo-box --> ez-text-input
76
73
  ez-combo-box --> ez-icon
77
- ez-search --> ez-combo-box
78
74
  ez-date-input --> ez-text-input
79
75
  ez-date-input --> ez-calendar
80
76
  ez-time-input --> ez-text-input
@@ -82,6 +78,7 @@ graph TD;
82
78
  ez-date-time-input --> ez-text-input
83
79
  ez-date-time-input --> ez-calendar
84
80
  ez-number-input --> ez-text-input
81
+ ez-search --> ez-combo-box
85
82
  style ez-form fill:#f9f,stroke:#333,stroke-width:4px
86
83
  ```
87
84
 
package/components/ez-form-view/readme.md ADDED
@@ -0,0 +1,70 @@
1
+ # ez-form-view
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
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` |
13
+
14
+
15
+ ## Dependencies
16
+
17
+ ### Used by
18
+
19
+ - [ez-form](../ez-form)
20
+
21
+ ### Depends on
22
+
23
+ - [ez-collapsible-box](../ez-collapsible-box)
24
+ - [ez-check](../ez-check)
25
+ - [ez-combo-box](../ez-combo-box)
26
+ - [ez-date-input](../ez-date-input)
27
+ - [ez-time-input](../ez-time-input)
28
+ - [ez-date-time-input](../ez-date-time-input)
29
+ - [ez-upload](../ez-upload)
30
+ - [ez-number-input](../ez-number-input)
31
+ - [ez-search](../ez-search)
32
+ - [ez-text-area](../ez-text-area)
33
+ - [ez-text-input](../ez-text-input)
34
+
35
+ ### Graph
36
+ ```mermaid
37
+ graph TD;
38
+ ez-form-view --> ez-collapsible-box
39
+ ez-form-view --> ez-check
40
+ ez-form-view --> ez-combo-box
41
+ ez-form-view --> ez-date-input
42
+ ez-form-view --> ez-time-input
43
+ ez-form-view --> ez-date-time-input
44
+ ez-form-view --> ez-upload
45
+ ez-form-view --> ez-number-input
46
+ ez-form-view --> ez-search
47
+ ez-form-view --> ez-text-area
48
+ ez-form-view --> ez-text-input
49
+ ez-collapsible-box --> ez-icon
50
+ ez-collapsible-box --> ez-text-edit
51
+ ez-text-edit --> ez-text-input
52
+ ez-text-edit --> ez-button
53
+ ez-button --> ez-icon
54
+ ez-combo-box --> ez-text-input
55
+ ez-combo-box --> ez-icon
56
+ ez-date-input --> ez-text-input
57
+ ez-date-input --> ez-calendar
58
+ ez-time-input --> ez-text-input
59
+ ez-time-input --> ez-icon
60
+ ez-date-time-input --> ez-text-input
61
+ ez-date-time-input --> ez-calendar
62
+ ez-number-input --> ez-text-input
63
+ ez-search --> ez-combo-box
64
+ ez-form --> ez-form-view
65
+ style ez-form-view fill:#f9f,stroke:#333,stroke-width:4px
66
+ ```
67
+
68
+ ----------------------------------------------
69
+
70
+
package/components/ez-icon/readme.md CHANGED
@@ -26,6 +26,7 @@
26
26
  - [ez-collapsible-box](../ez-collapsible-box)
27
27
  - [ez-combo-box](../ez-combo-box)
28
28
  - [ez-dialog](../ez-dialog)
29
+ - [ez-dropdown](../ez-dropdown)
29
30
  - [ez-file-item](../ez-file-item)
30
31
  - [ez-filter-input](../ez-filter-input)
31
32
  - [ez-modal-container](../ez-modal-container)
@@ -44,6 +45,7 @@ graph TD;
44
45
  ez-collapsible-box --> ez-icon
45
46
  ez-combo-box --> ez-icon
46
47
  ez-dialog --> ez-icon
48
+ ez-dropdown --> ez-icon
47
49
  ez-file-item --> ez-icon
48
50
  ez-filter-input --> ez-icon
49
51
  ez-modal-container --> ez-icon
package/components/ez-number-input/readme.md CHANGED
@@ -64,7 +64,7 @@ Type: `Promise<void>`
64
64
 
65
65
  ### Used by
66
66
 
67
- - [ez-form](../ez-form)
67
+ - [ez-form-view](../ez-form-view)
68
68
 
69
69
  ### Depends on
70
70
 
@@ -74,7 +74,7 @@ Type: `Promise<void>`
74
74
  ```mermaid
75
75
  graph TD;
76
76
  ez-number-input --> ez-text-input
77
- ez-form --> ez-number-input
77
+ ez-form-view --> ez-number-input
78
78
  style ez-number-input fill:#f9f,stroke:#333,stroke-width:4px
79
79
  ```
80
80
 
package/components/ez-search/readme.md CHANGED
@@ -64,7 +64,7 @@ Type: `Promise<void>`
64
64
 
65
65
  ### Used by
66
66
 
67
- - [ez-form](../ez-form)
67
+ - [ez-form-view](../ez-form-view)
68
68
 
69
69
  ### Depends on
70
70
 
@@ -76,7 +76,7 @@ graph TD;
76
76
  ez-search --> ez-combo-box
77
77
  ez-combo-box --> ez-text-input
78
78
  ez-combo-box --> ez-icon
79
- ez-form --> ez-search
79
+ ez-form-view --> ez-search
80
80
  style ez-search fill:#f9f,stroke:#333,stroke-width:4px
81
81
  ```
82
82
 
package/components/ez-text-area/readme.md CHANGED
@@ -62,12 +62,12 @@ Type: `Promise<void>`
62
62
 
63
63
  ### Used by
64
64
 
65
- - [ez-form](../ez-form)
65
+ - [ez-form-view](../ez-form-view)
66
66
 
67
67
  ### Graph
68
68
  ```mermaid
69
69
  graph TD;
70
- ez-form --> ez-text-area
70
+ ez-form-view --> ez-text-area
71
71
  style ez-text-area fill:#f9f,stroke:#333,stroke-width:4px
72
72
  ```
73
73
 
package/components/ez-text-input/readme.md CHANGED
@@ -68,7 +68,7 @@ Type: `Promise<void>`
68
68
  - [ez-date-input](../ez-date-input)
69
69
  - [ez-date-time-input](../ez-date-time-input)
70
70
  - [ez-filter-input](../ez-filter-input)
71
- - [ez-form](../ez-form)
71
+ - [ez-form-view](../ez-form-view)
72
72
  - [ez-number-input](../ez-number-input)
73
73
  - [ez-text-edit](../ez-text-edit)
74
74
  - [ez-time-input](../ez-time-input)
@@ -80,7 +80,7 @@ graph TD;
80
80
  ez-date-input --> ez-text-input
81
81
  ez-date-time-input --> ez-text-input
82
82
  ez-filter-input --> ez-text-input
83
- ez-form --> ez-text-input
83
+ ez-form-view --> ez-text-input
84
84
  ez-number-input --> ez-text-input
85
85
  ez-text-edit --> ez-text-input
86
86
  ez-time-input --> ez-text-input
package/components/ez-time-input/readme.md CHANGED
@@ -63,7 +63,7 @@ Type: `Promise<void>`
63
63
 
64
64
  ### Used by
65
65
 
66
- - [ez-form](../ez-form)
66
+ - [ez-form-view](../ez-form-view)
67
67
 
68
68
  ### Depends on
69
69
 
@@ -75,7 +75,7 @@ Type: `Promise<void>`
75
75
  graph TD;
76
76
  ez-time-input --> ez-text-input
77
77
  ez-time-input --> ez-icon
78
- ez-form --> ez-time-input
78
+ ez-form-view --> ez-time-input
79
79
  style ez-time-input fill:#f9f,stroke:#333,stroke-width:4px
80
80
  ```
81
81
 
package/components/ez-tree/readme.md CHANGED
@@ -7,11 +7,13 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------- | --------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | --------------------- |
12
- | `iconResolver` | -- | Define uma função que vai resolver o ícone daquele item. Retorna o nome do ícone da lib de icones do DS. | `(item: ITreeItem, expanded: boolean, level: number) => string` | `defaultIconResolver` |
13
- | `items` | -- | Define os itens apresentados na árvore. | `ITreeItem[]` | `[]` |
14
- | `value` | -- | Define o item selecionado na árvore. | `ITreeItem` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------------------------ |
12
+ | `iconResolver` | -- | Define uma função que vai resolver o ícone daquele item. Retorna o nome do ícone da lib de icones do DS. | `(item: ITreeItem, expanded: boolean, level: number) => string` | `defaultIconResolver` |
13
+ | `items` | -- | Define os itens apresentados na árvore. | `ITreeItem[]` | `[]` |
14
+ | `selectedId` | `selected-id` | Forma alternativa para atribuir o item selecionado por seu ID. | `string` | `undefined` |
15
+ | `tooltipResolver` | -- | Define uma função que vai resolver o `tooltip` ou `title` daquele item. | `(item: ITreeItem, enabled: boolean, level: number) => string` | `defaultTooltipResolver` |
16
+ | `value` | -- | Define o item selecionado na árvore. | `ITreeItem` | `undefined` |
15
17
 
16
18
 
17
19
  ## Events
@@ -85,6 +87,10 @@ Type: `Promise<void>`
85
87
 
86
88
  ## Dependencies
87
89
 
90
+ ### Used by
91
+
92
+ - [ez-form](../ez-form)
93
+
88
94
  ### Depends on
89
95
 
90
96
  - [ez-icon](../ez-icon)
@@ -93,6 +99,7 @@ Type: `Promise<void>`
93
99
  ```mermaid
94
100
  graph TD;
95
101
  ez-tree --> ez-icon
102
+ ez-form --> ez-tree
96
103
  style ez-tree fill:#f9f,stroke:#333,stroke-width:4px
97
104
  ```
98
105
 
package/components/ez-upload/readme.md CHANGED
@@ -65,12 +65,12 @@ Type: `Promise<void>`
65
65
 
66
66
  ### Used by
67
67
 
68
- - [ez-form](../ez-form)
68
+ - [ez-form-view](../ez-form-view)
69
69
 
70
70
  ### Graph
71
71
  ```mermaid
72
72
  graph TD;
73
- ez-form --> ez-upload
73
+ ez-form-view --> ez-upload
74
74
  style ez-upload fill:#f9f,stroke:#333,stroke-width:4px
75
75
  ```
76
76
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "2.10.1",
3
+ "version": "2.12.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [