@sankhyalabs/ezui-docs 2.12.0 → 2.13.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 (19) hide show
  1. package/components/ez-button/readme.md +2 -0
  2. package/components/ez-check/readme.md +2 -2
  3. package/components/ez-collapsible-box/readme.md +2 -2
  4. package/components/ez-combo-box/readme.md +2 -2
  5. package/components/ez-date-input/readme.md +2 -2
  6. package/components/ez-date-time-input/readme.md +2 -2
  7. package/components/ez-filter-input/readme.md +5 -0
  8. package/components/ez-form/readme.md +31 -22
  9. package/components/ez-guide-navigator/readme.md +64 -0
  10. package/components/ez-number-input/readme.md +2 -2
  11. package/components/ez-search/readme.md +2 -2
  12. package/components/ez-sidebar-button/readme.md +13 -0
  13. package/components/ez-text-area/readme.md +2 -2
  14. package/components/ez-text-input/readme.md +2 -2
  15. package/components/ez-time-input/readme.md +2 -2
  16. package/components/ez-tree/readme.md +2 -0
  17. package/components/ez-upload/readme.md +2 -2
  18. package/package.json +1 -1
  19. package/components/ez-form-view/readme.md +0 -70
package/components/ez-button/readme.md CHANGED
@@ -47,6 +47,7 @@ Type: `Promise<void>`
47
47
  - [ez-actions-button](../ez-actions-button)
48
48
  - [ez-dialog](../ez-dialog)
49
49
  - [ez-grid](../ez-grid)
50
+ - [ez-guide-navigator](../ez-guide-navigator)
50
51
  - [ez-modal-container](../ez-modal-container)
51
52
  - [ez-text-edit](../ez-text-edit)
52
53
 
@@ -61,6 +62,7 @@ graph TD;
61
62
  ez-actions-button --> ez-button
62
63
  ez-dialog --> ez-button
63
64
  ez-grid --> ez-button
65
+ ez-guide-navigator --> ez-button
64
66
  ez-modal-container --> ez-button
65
67
  ez-text-edit --> ez-button
66
68
  style ez-button fill:#f9f,stroke:#333,stroke-width:4px
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-view](../ez-form-view)
53
+ - [ez-form](../ez-form)
54
54
 
55
55
  ### Graph
56
56
  ```mermaid
57
57
  graph TD;
58
- ez-form-view --> ez-check
58
+ ez-form --> 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-view](../ez-form-view)
69
+ - [ez-form](../ez-form)
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-view --> ez-collapsible-box
84
+ ez-form --> 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-view](../ez-form-view)
71
+ - [ez-form](../ez-form)
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-view --> ez-combo-box
84
+ ez-form --> 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-view](../ez-form-view)
65
+ - [ez-form](../ez-form)
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-view --> ez-date-input
77
+ ez-form --> 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-view](../ez-form-view)
66
+ - [ez-form](../ez-form)
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-view --> ez-date-time-input
78
+ ez-form --> 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-filter-input/readme.md CHANGED
@@ -59,6 +59,10 @@ Type: `Promise<void>`
59
59
 
60
60
  ## Dependencies
61
61
 
62
+ ### Used by
63
+
64
+ - [ez-guide-navigator](../ez-guide-navigator)
65
+
62
66
  ### Depends on
63
67
 
64
68
  - [ez-text-input](../ez-text-input)
@@ -69,6 +73,7 @@ Type: `Promise<void>`
69
73
  graph TD;
70
74
  ez-filter-input --> ez-text-input
71
75
  ez-filter-input --> ez-icon
76
+ ez-guide-navigator --> ez-filter-input
72
77
  style ez-filter-input fill:#f9f,stroke:#333,stroke-width:4px
73
78
  ```
74
79
 
package/components/ez-form/readme.md CHANGED
@@ -7,14 +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
- | `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` |
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: (IFieldMetadata \| IFieldSetMetadata)[], fieldBuilder: (field: IFieldMetadata) => HTMLElement) => 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` |
18
18
 
19
19
 
20
20
  ## Events
@@ -43,27 +43,36 @@ Type: `Promise<void>`
43
43
 
44
44
  - [ez-tree](../ez-tree)
45
45
  - [ez-tabselector](../ez-tabselector)
46
- - [ez-form-view](../ez-form-view)
46
+ - [ez-collapsible-box](../ez-collapsible-box)
47
+ - [ez-text-area](../ez-text-area)
48
+ - [ez-text-input](../ez-text-input)
49
+ - [ez-check](../ez-check)
50
+ - [ez-combo-box](../ez-combo-box)
51
+ - [ez-search](../ez-search)
52
+ - [ez-upload](../ez-upload)
53
+ - [ez-date-input](../ez-date-input)
54
+ - [ez-time-input](../ez-time-input)
55
+ - [ez-date-time-input](../ez-date-time-input)
56
+ - [ez-number-input](../ez-number-input)
47
57
 
48
58
  ### Graph
49
59
  ```mermaid
50
60
  graph TD;
51
61
  ez-form --> ez-tree
52
62
  ez-form --> ez-tabselector
53
- ez-form --> ez-form-view
63
+ ez-form --> ez-collapsible-box
64
+ ez-form --> ez-text-area
65
+ ez-form --> ez-text-input
66
+ ez-form --> ez-check
67
+ ez-form --> ez-combo-box
68
+ ez-form --> ez-search
69
+ ez-form --> ez-upload
70
+ ez-form --> ez-date-input
71
+ ez-form --> ez-time-input
72
+ ez-form --> ez-date-time-input
73
+ ez-form --> ez-number-input
54
74
  ez-tree --> ez-icon
55
75
  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
67
76
  ez-collapsible-box --> ez-icon
68
77
  ez-collapsible-box --> ez-text-edit
69
78
  ez-text-edit --> ez-text-input
@@ -71,6 +80,7 @@ graph TD;
71
80
  ez-button --> ez-icon
72
81
  ez-combo-box --> ez-text-input
73
82
  ez-combo-box --> ez-icon
83
+ ez-search --> ez-combo-box
74
84
  ez-date-input --> ez-text-input
75
85
  ez-date-input --> ez-calendar
76
86
  ez-time-input --> ez-text-input
@@ -78,7 +88,6 @@ graph TD;
78
88
  ez-date-time-input --> ez-text-input
79
89
  ez-date-time-input --> ez-calendar
80
90
  ez-number-input --> ez-text-input
81
- ez-search --> ez-combo-box
82
91
  style ez-form fill:#f9f,stroke:#333,stroke-width:4px
83
92
  ```
84
93
 
package/components/ez-guide-navigator/readme.md ADDED
@@ -0,0 +1,64 @@
1
+ # ez-guide-navigator
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------- | --------- | ------------------------------------------ | -------------- | ------- |
12
+ | `binder` | -- | Provedor de dados para o guide navigator. | `IGuideBinder` | `null` |
13
+ | `open` | `open` | Define se o menu de navegação está aberto. | `boolean` | `true` |
14
+
15
+
16
+ ## Methods
17
+
18
+ ### `enableAll() => Promise<void>`
19
+
20
+ Habilita todos os itens do menu de navegação.
21
+
22
+ #### Returns
23
+
24
+ Type: `Promise<void>`
25
+
26
+
27
+
28
+ ### `enableOnly(id: Array<string>, customTooltip: string) => Promise<void>`
29
+
30
+ Habilita itens específicos a partir de uma lista de ID's.
31
+
32
+ #### Returns
33
+
34
+ Type: `Promise<void>`
35
+
36
+
37
+
38
+
39
+ ## Dependencies
40
+
41
+ ### Depends on
42
+
43
+ - [ez-filter-input](../ez-filter-input)
44
+ - [ez-button](../ez-button)
45
+ - [ez-tree](../ez-tree)
46
+ - [ez-sidebar-button](../ez-sidebar-button)
47
+
48
+ ### Graph
49
+ ```mermaid
50
+ graph TD;
51
+ ez-guide-navigator --> ez-filter-input
52
+ ez-guide-navigator --> ez-button
53
+ ez-guide-navigator --> ez-tree
54
+ ez-guide-navigator --> ez-sidebar-button
55
+ ez-filter-input --> ez-text-input
56
+ ez-filter-input --> ez-icon
57
+ ez-button --> ez-icon
58
+ ez-tree --> ez-icon
59
+ style ez-guide-navigator fill:#f9f,stroke:#333,stroke-width:4px
60
+ ```
61
+
62
+ ----------------------------------------------
63
+
64
+
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-view](../ez-form-view)
67
+ - [ez-form](../ez-form)
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-view --> ez-number-input
77
+ ez-form --> 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-view](../ez-form-view)
67
+ - [ez-form](../ez-form)
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-view --> ez-search
79
+ ez-form --> ez-search
80
80
  style ez-search fill:#f9f,stroke:#333,stroke-width:4px
81
81
  ```
82
82
 
package/components/ez-sidebar-button/readme.md CHANGED
@@ -12,6 +12,19 @@
12
12
  | `ezClick` | Emitido sempre que o ez-sidebar-button é clicado. | `CustomEvent<void>` |
13
13
 
14
14
 
15
+ ## Dependencies
16
+
17
+ ### Used by
18
+
19
+ - [ez-guide-navigator](../ez-guide-navigator)
20
+
21
+ ### Graph
22
+ ```mermaid
23
+ graph TD;
24
+ ez-guide-navigator --> ez-sidebar-button
25
+ style ez-sidebar-button fill:#f9f,stroke:#333,stroke-width:4px
26
+ ```
27
+
15
28
  ----------------------------------------------
16
29
 
17
30
 
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-view](../ez-form-view)
65
+ - [ez-form](../ez-form)
66
66
 
67
67
  ### Graph
68
68
  ```mermaid
69
69
  graph TD;
70
- ez-form-view --> ez-text-area
70
+ ez-form --> 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-view](../ez-form-view)
71
+ - [ez-form](../ez-form)
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-view --> ez-text-input
83
+ ez-form --> 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-view](../ez-form-view)
66
+ - [ez-form](../ez-form)
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-view --> ez-time-input
78
+ ez-form --> 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
@@ -90,6 +90,7 @@ Type: `Promise<void>`
90
90
  ### Used by
91
91
 
92
92
  - [ez-form](../ez-form)
93
+ - [ez-guide-navigator](../ez-guide-navigator)
93
94
 
94
95
  ### Depends on
95
96
 
@@ -100,6 +101,7 @@ Type: `Promise<void>`
100
101
  graph TD;
101
102
  ez-tree --> ez-icon
102
103
  ez-form --> ez-tree
104
+ ez-guide-navigator --> ez-tree
103
105
  style ez-tree fill:#f9f,stroke:#333,stroke-width:4px
104
106
  ```
105
107
 
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-view](../ez-form-view)
68
+ - [ez-form](../ez-form)
69
69
 
70
70
  ### Graph
71
71
  ```mermaid
72
72
  graph TD;
73
- ez-form-view --> ez-upload
73
+ ez-form --> 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.12.0",
3
+ "version": "2.13.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
package/components/ez-form-view/readme.md DELETED
@@ -1,70 +0,0 @@
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
-