@sankhyalabs/ezui-docs 2.11.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 (7) hide show
  1. package/components/ez-button/readme.md +2 -0
  2. package/components/ez-filter-input/readme.md +5 -0
  3. package/components/ez-form/readme.md +11 -5
  4. package/components/ez-guide-navigator/readme.md +64 -0
  5. package/components/ez-sidebar-button/readme.md +13 -0
  6. package/components/ez-tree/readme.md +14 -5
  7. package/package.json +1 -1
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-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,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: (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` |
15
18
 
16
19
 
17
20
  ## Events
@@ -38,6 +41,7 @@ Type: `Promise<void>`
38
41
 
39
42
  ### Depends on
40
43
 
44
+ - [ez-tree](../ez-tree)
41
45
  - [ez-tabselector](../ez-tabselector)
42
46
  - [ez-collapsible-box](../ez-collapsible-box)
43
47
  - [ez-text-area](../ez-text-area)
@@ -54,6 +58,7 @@ Type: `Promise<void>`
54
58
  ### Graph
55
59
  ```mermaid
56
60
  graph TD;
61
+ ez-form --> ez-tree
57
62
  ez-form --> ez-tabselector
58
63
  ez-form --> ez-collapsible-box
59
64
  ez-form --> ez-text-area
@@ -66,6 +71,7 @@ graph TD;
66
71
  ez-form --> ez-time-input
67
72
  ez-form --> ez-date-time-input
68
73
  ez-form --> ez-number-input
74
+ ez-tree --> ez-icon
69
75
  ez-tabselector --> ez-icon
70
76
  ez-collapsible-box --> ez-icon
71
77
  ez-collapsible-box --> ez-text-edit
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-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-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,11 @@ Type: `Promise<void>`
85
87
 
86
88
  ## Dependencies
87
89
 
90
+ ### Used by
91
+
92
+ - [ez-form](../ez-form)
93
+ - [ez-guide-navigator](../ez-guide-navigator)
94
+
88
95
  ### Depends on
89
96
 
90
97
  - [ez-icon](../ez-icon)
@@ -93,6 +100,8 @@ Type: `Promise<void>`
93
100
  ```mermaid
94
101
  graph TD;
95
102
  ez-tree --> ez-icon
103
+ ez-form --> ez-tree
104
+ ez-guide-navigator --> ez-tree
96
105
  style ez-tree fill:#f9f,stroke:#333,stroke-width:4px
97
106
  ```
98
107
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "2.11.0",
3
+ "version": "2.13.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [