@sankhyalabs/ezui-docs 3.6.0 → 4.0.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 +5 -11
  2. package/components/ez-form-view/readme.md +20 -0
  3. package/components/ez-guide-navigator/readme.md +63 -5
  4. package/components/ez-tree/readme.md +40 -2
  5. package/package.json +1 -1
package/components/ez-form/readme.md CHANGED
@@ -7,14 +7,11 @@
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
+ | `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` |
18
15
 
19
16
 
20
17
  ## Events
@@ -41,17 +38,14 @@ Type: `Promise<void>`
41
38
 
42
39
  ### Depends on
43
40
 
44
- - [ez-tree](../ez-tree)
45
41
  - [ez-tabselector](../ez-tabselector)
46
42
  - [ez-form-view](../ez-form-view)
47
43
 
48
44
  ### Graph
49
45
  ```mermaid
50
46
  graph TD;
51
- ez-form --> ez-tree
52
47
  ez-form --> ez-tabselector
53
48
  ez-form --> ez-form-view
54
- ez-tree --> ez-icon
55
49
  ez-tabselector --> ez-icon
56
50
  ez-form-view --> ez-collapsible-box
57
51
  ez-form-view --> ez-check
package/components/ez-form-view/readme.md CHANGED
@@ -12,6 +12,26 @@
12
12
  | `fields` | -- | Define a lista de metadados usada para criar os campos de user interface. | `IFormViewField[]` | `undefined` |
13
13
 
14
14
 
15
+ ## Events
16
+
17
+ | Event | Description | Type |
18
+ | ---------------- | ------------------------------------------------------------------- | ---------------------------- |
19
+ | `ezContentReady` | Evento emitido quando o componente foi totalmente carregado na DOM. | `CustomEvent<HTMLElement[]>` |
20
+
21
+
22
+ ## Methods
23
+
24
+ ### `showUp() => Promise<void>`
25
+
26
+
27
+
28
+ #### Returns
29
+
30
+ Type: `Promise<void>`
31
+
32
+
33
+
34
+
15
35
  ## Dependencies
16
36
 
17
37
  ### Used by
package/components/ez-guide-navigator/readme.md CHANGED
@@ -7,11 +7,19 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | --------- | ----------------------------------------------------------------------- | --------------------------------------------------------------- | ----------- |
12
- | `items` | -- | Lista de itens do menu de navegação. | `IGuideItem[]` | `[]` |
13
- | `open` | `open` | Define se o menu de navegação está aberto. | `boolean` | `true` |
14
- | `tooltipResolver` | -- | Define uma função que vai resolver o `tooltip` ou `title` daquele item. | `(item: IGuideItem, enabled: boolean, level: number) => string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------- | ----------- |
12
+ | `items` | -- | Lista de itens do menu de navegação. | `IGuideItem[]` | `[]` |
13
+ | `open` | `open` | Define se o menu de navegação está aberto. | `boolean` | `true` |
14
+ | `selectedId` | `selected-id` | Define o id do item selecionado. | `string` | `undefined` |
15
+ | `tooltipResolver` | -- | Define uma função que vai resolver o `tooltip` ou `title` daquele item. | `(item: IGuideItem, enabled: boolean, level: number) => string` | `undefined` |
16
+
17
+
18
+ ## Events
19
+
20
+ | Event | Description | Type |
21
+ | ------------------- | ----------------------------------------------------------------- | ------------------------- |
22
+ | `ezSelectionChange` | Evento emitido quando o item selecionado no navigator é alterado. | `CustomEvent<IGuideItem>` |
15
23
 
16
24
 
17
25
  ## Methods
@@ -36,6 +44,56 @@ Type: `Promise<void>`
36
44
 
37
45
 
38
46
 
47
+ ### `getCurrentPath() => Promise<Array<IGuideItem>>`
48
+
49
+ Obtem um array do caminho de itens da seleção atual.
50
+
51
+ #### Returns
52
+
53
+ Type: `Promise<IGuideItem[]>`
54
+
55
+ Retorna um array do caminho de itens da seleção atual.
56
+
57
+ ### `getItem(id: string) => Promise<IGuideItem>`
58
+
59
+ Obtem um item pelo id
60
+
61
+ #### Returns
62
+
63
+ Type: `Promise<IGuideItem>`
64
+
65
+
66
+
67
+ ### `getParent(id: string) => Promise<IGuideItem>`
68
+
69
+ Obtem o item pai a partir de um id
70
+
71
+ #### Returns
72
+
73
+ Type: `Promise<IGuideItem>`
74
+
75
+
76
+
77
+ ### `selectGuide(id: string) => Promise<void>`
78
+
79
+ Seleciona o item desejado pelo ID.
80
+
81
+ #### Returns
82
+
83
+ Type: `Promise<void>`
84
+
85
+
86
+
87
+ ### `updateItem(item: IGuideItem | Array<IGuideItem>) => Promise<void>`
88
+
89
+ Atualiza um ou mais items
90
+
91
+ #### Returns
92
+
93
+ Type: `Promise<void>`
94
+
95
+
96
+
39
97
 
40
98
  ## Dependencies
41
99
 
package/components/ez-tree/readme.md CHANGED
@@ -70,6 +70,36 @@ Type: `Promise<void>`
70
70
 
71
71
 
72
72
 
73
+ ### `getCurrentPath() => Promise<Array<ITreeItem>>`
74
+
75
+ Obtem um array do caminho de itens da seleção atual.
76
+
77
+ #### Returns
78
+
79
+ Type: `Promise<ITreeItem[]>`
80
+
81
+ Retorna um array do caminho de itens da seleção atual.
82
+
83
+ ### `getItem(id: string) => Promise<ITreeItem>`
84
+
85
+ Obtem um item pelo id
86
+
87
+ #### Returns
88
+
89
+ Type: `Promise<ITreeItem>`
90
+
91
+
92
+
93
+ ### `getParent(id: string) => Promise<ITreeItem>`
94
+
95
+ Obtem o item pai a partir de um id
96
+
97
+ #### Returns
98
+
99
+ Type: `Promise<ITreeItem>`
100
+
101
+
102
+
73
103
  ### `openItem(id: string) => Promise<void>`
74
104
 
75
105
  Realiza a abertura de um item, incluindo a hieraquia acima.
@@ -94,12 +124,21 @@ Type: `Promise<void>`
94
124
 
95
125
 
96
126
 
127
+ ### `updateItem(item: ITreeItem) => Promise<void>`
128
+
129
+ Atualiza um item
130
+
131
+ #### Returns
132
+
133
+ Type: `Promise<void>`
134
+
135
+
136
+
97
137
 
98
138
  ## Dependencies
99
139
 
100
140
  ### Used by
101
141
 
102
- - [ez-form](../ez-form)
103
142
  - [ez-guide-navigator](../ez-guide-navigator)
104
143
 
105
144
  ### Depends on
@@ -110,7 +149,6 @@ Type: `Promise<void>`
110
149
  ```mermaid
111
150
  graph TD;
112
151
  ez-tree --> ez-icon
113
- ez-form --> ez-tree
114
152
  ez-guide-navigator --> ez-tree
115
153
  style ez-tree fill:#f9f,stroke:#333,stroke-width:4px
116
154
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "3.6.0",
3
+ "version": "4.0.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [