@sankhyalabs/ezui-docs 6.4.2 → 6.5.0-dev.1

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 (57) hide show
  1. package/components/ez-actions-button/readme.md +2 -2
  2. package/components/ez-avatar/readme.md +1 -0
  3. package/components/ez-button/readme.md +29 -15
  4. package/components/ez-calendar/readme.md +3 -3
  5. package/components/ez-check/readme.md +3 -1
  6. package/components/ez-chip/readme.md +30 -22
  7. package/components/ez-classic-combo-box/readme.md +4 -4
  8. package/components/ez-classic-input/readme.md +1 -1
  9. package/components/ez-classic-text-area/readme.md +1 -1
  10. package/components/ez-collapsible-box/readme.md +2 -2
  11. package/components/ez-combo-box/ez-combo-box-list/readme.md +13 -13
  12. package/components/ez-combo-box/readme.md +27 -26
  13. package/components/ez-date-input/readme.md +3 -3
  14. package/components/ez-date-time-input/readme.md +3 -3
  15. package/components/ez-filter-input/readme.md +4 -4
  16. package/components/ez-form/readme.md +27 -2
  17. package/components/ez-form-view/custom-input/readme.md +2 -2
  18. package/components/ez-form-view/readme.md +28 -2
  19. package/components/ez-grid/readme.md +18 -28
  20. package/components/ez-grid/subcomponents/readme.md +1 -1
  21. package/components/ez-guide-navigator/readme.md +8 -6
  22. package/components/ez-icon/readme.md +8 -0
  23. package/components/ez-list/readme.md +5 -5
  24. package/components/ez-list-item/readme.md +43 -0
  25. package/components/ez-loading-bar/readme.md +1 -1
  26. package/components/ez-modal-container/readme.md +7 -0
  27. package/components/ez-number-input/readme.md +3 -3
  28. package/components/ez-popover/readme.md +3 -3
  29. package/components/ez-popover-plus/readme.md +5 -5
  30. package/components/ez-popover-plus/subcomponent/readme.md +5 -5
  31. package/components/ez-popup/readme.md +15 -0
  32. package/components/ez-rich-text/ez-link-builder/readme.md +69 -0
  33. package/components/ez-rich-text/ez-rich-toolbar/ez-rich-toolbar-arrows/readme.md +29 -0
  34. package/components/ez-rich-text/ez-rich-toolbar/ez-rich-toolbar-configs/readme.md +29 -0
  35. package/components/ez-rich-text/ez-rich-toolbar/ez-rich-toolbar-item/readme.md +49 -0
  36. package/components/ez-rich-text/ez-rich-toolbar/ez-rich-toolbar-letters/readme.md +29 -0
  37. package/components/ez-rich-text/ez-rich-toolbar/readme.md +54 -0
  38. package/components/ez-rich-text/ez-simple-image-uploader/readme.md +78 -0
  39. package/components/ez-rich-text/readme.md +121 -0
  40. package/components/ez-search/readme.md +4 -4
  41. package/components/ez-search/subcomponent/search-list/readme.md +1 -1
  42. package/components/ez-search-plus/readme.md +4 -4
  43. package/components/ez-search-plus/subcomponent/ez-search-result-list/readme.md +3 -3
  44. package/components/ez-sidebar-navigator/readme.md +2 -2
  45. package/components/ez-sortable-list/readme.md +16 -16
  46. package/components/ez-spinner/readme.md +27 -0
  47. package/components/ez-split-button/readme.md +17 -17
  48. package/components/ez-text-area/readme.md +19 -5
  49. package/components/ez-text-input/readme.md +6 -2
  50. package/components/ez-tile/readme.md +1 -1
  51. package/components/ez-tile-medium/readme.md +1 -1
  52. package/components/ez-time-input/readme.md +2 -2
  53. package/components/ez-tooltip/readme.md +6 -0
  54. package/components/ez-tree/readme.md +28 -6
  55. package/components/ez-upload/readme.md +2 -2
  56. package/components/ez-view-stack/readme.md +1 -1
  57. package/package.json +1 -1
@@ -0,0 +1,27 @@
1
+ # ez-spinner
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------- | --------- | --------------------------- | -------------------------------- | --------- |
12
+ | `size` | `size` | Define o tamanho do spinner | `"large" \| "medium" \| "small"` | `'small'` |
13
+
14
+
15
+ ----------------------------------------------
16
+
17
+
18
+
19
+
20
+ ## CSS Variables
21
+ | Variable | Description |
22
+ |-|-|
23
+ | --ez-spinner--color | Define a cor do spinner. |
24
+ | --ez-spinner--size-default | Define o tamanho padrão do spinner. |
25
+ | --ez-spinner--size-medium | Define o tamanho médio do spinner. |
26
+ | --ez-spinner--size-large | Define o tamanho grande do spinner. |
27
+ | --ez-spinner--animation-duration | Define a duração da animação do spinner. |
@@ -7,19 +7,19 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | --------------- |
12
- | `enabled` | `enabled` | Se false o usuário não pode interagir com o botão. | `boolean` | `true` |
13
- | `iconName` | `icon-name` | Define o ícone a ser usado da biblioteca de ícones: [ez-icons](https://gilded-nasturtium-6b64dd.netlify.app/docs/components/layout-doc/icons/) | `string` | `undefined` |
14
- | `image` | `image` | Define o caminho usado nos modos `icon-only` e `icon-left` para imagens não contempladas na biblioteca de ícones. | `string` | `undefined` |
15
- | `itemBuilder` | -- | Função builder que possibilita alterar como o item da lista vai ser apresentado. Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: IDropdownItem, level: number) => string \| HTMLElement` | `undefined` |
16
- | `items` | -- | Define o conteúdo do dropdown. | `IDropdownItem[]` | `undefined` |
17
- | `label` | `label` | Texto a ser apresentado como label do botão. | `string` | `undefined` |
18
- | `leftTitle` | `left-title` | Texto a ser apresentado como title do botão principal | `string` | `undefined` |
19
- | `mode` | `mode` | Define o modo de uso do botão. | `"default" \| "icon-left" \| "icon-only"` | `'default'` |
20
- | `rightTitle` | `right-title` | Texto a ser apresentado como title do botão dropdown | `string` | `'Mais opções'` |
21
- | `show` | `show` | | `boolean` | `false` |
22
- | `size` | `size` | Define o tamanho do ez-split-button. | `"large" \| "medium" \| "small"` | `'medium'` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ----------- |
12
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o botão. | `boolean` | `true` |
13
+ | `iconName` | `icon-name` | Define o ícone a ser usado da biblioteca de ícones: [ez-icons](https://gilded-nasturtium-6b64dd.netlify.app/docs/components/layout-doc/icons/) | `string` | `undefined` |
14
+ | `image` | `image` | Define o caminho usado nos modos `icon-only` e `icon-left` para imagens não contempladas na biblioteca de ícones. | `string` | `undefined` |
15
+ | `itemBuilder` | -- | Função builder que possibilita alterar como o item da lista vai ser apresentado. Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: IDropdownItem, level: number) => string \| HTMLElement` | `undefined` |
16
+ | `items` | -- | Define o conteúdo do dropdown. | `IDropdownItem[]` | `undefined` |
17
+ | `label` | `label` | Texto a ser apresentado como label do botão. | `string` | `undefined` |
18
+ | `leftTitle` | `left-title` | Texto a ser apresentado como title do botão principal | `string` | `undefined` |
19
+ | `mode` | `mode` | Define o modo de uso do botão. | `"default" \| "icon-left" \| "icon-only"` | `'default'` |
20
+ | `rightTitle` | `right-title` | Texto a ser apresentado como title do botão dropdown | `string` | `undefined` |
21
+ | `show` | `show` | | `boolean` | `false` |
22
+ | `size` | `size` | Define o tamanho do ez-split-button. | `"large" \| "medium" \| "small"` | `'medium'` |
23
23
 
24
24
 
25
25
  ## Events
@@ -41,7 +41,7 @@ Informa se a lista de ações está aberta.
41
41
 
42
42
  Type: `Promise<boolean>`
43
43
 
44
-
44
+ ---
45
45
 
46
46
  ### `setBlur() => Promise<void>`
47
47
 
@@ -51,7 +51,7 @@ Remove o foco de ambos os botões.
51
51
 
52
52
  Type: `Promise<void>`
53
53
 
54
-
54
+ ---
55
55
 
56
56
  ### `setLeftButtonFocus() => Promise<void>`
57
57
 
@@ -61,7 +61,7 @@ Aplica o foco no botão principal.
61
61
 
62
62
  Type: `Promise<void>`
63
63
 
64
-
64
+ ---
65
65
 
66
66
  ### `setRightButtonFocus() => Promise<void>`
67
67
 
@@ -71,7 +71,7 @@ Aplica o foco no botão do dropdown.
71
71
 
72
72
  Type: `Promise<void>`
73
73
 
74
-
74
+ ---
75
75
 
76
76
  ### `toggleDropdown() => Promise<void>`
77
77
 
@@ -17,7 +17,7 @@
17
17
  | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
18
18
  | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
19
19
  | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
20
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
20
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `'regular'` |
21
21
  | `rows` | `rows` | Define o número de linhas. | `number` | `4` |
22
22
  | `value` | `value` | Define o valor do campo. | `string` | `undefined` |
23
23
 
@@ -42,7 +42,7 @@ Adiciona o argumento text no value do text area, seguindo as regras:
42
42
 
43
43
  Type: `Promise<void>`
44
44
 
45
-
45
+ ---
46
46
 
47
47
  ### `isInvalid() => Promise<boolean>`
48
48
 
@@ -52,7 +52,7 @@ Retorna se o conteúdo é inválido.
52
52
 
53
53
  Type: `Promise<boolean>`
54
54
 
55
-
55
+ ---
56
56
 
57
57
  ### `setBlur() => Promise<void>`
58
58
 
@@ -62,7 +62,7 @@ Remove o foco do campo.
62
62
 
63
63
  Type: `Promise<void>`
64
64
 
65
-
65
+ ---
66
66
 
67
67
  ### `setFocus() => Promise<void>`
68
68
 
@@ -80,11 +80,20 @@ Type: `Promise<void>`
80
80
  ### Used by
81
81
 
82
82
  - [ez-form-view](../ez-form-view)
83
+ - [ez-rich-text](../ez-rich-text)
84
+
85
+ ### Depends on
86
+
87
+ - [ez-tooltip](../ez-tooltip)
88
+ - [ez-icon](../ez-icon)
83
89
 
84
90
  ### Graph
85
91
  ```mermaid
86
92
  graph TD;
93
+ ez-text-area --> ez-tooltip
94
+ ez-text-area --> ez-icon
87
95
  ez-form-view --> ez-text-area
96
+ ez-rich-text --> ez-text-area
88
97
  style ez-text-area fill:#f9f,stroke:#333,stroke-width:4px
89
98
  ```
90
99
 
@@ -122,4 +131,9 @@ graph TD;
122
131
  | --text-area\_\_scrollbar--color-hover | Define a cor do hover na barra de rolagem do componente. |
123
132
  | --text-area\_\_scrollbar--color-clicked | Define a cor do active na barra de rolagem do componente. |
124
133
  | --text-area\_\_scrollbar--border-radius | Define o raio da borda da barra de rolagem do componente. |
125
- | --text-area\_\_scrollbar--width | Define a largura da barra de rolagem do componente. |
134
+ | --text-area\_\_scrollbar--width | Define a largura da barra de rolagem do componente. |
135
+ | --ez-text-area\_\_tooltip-icon--spacing | Define o espaçamento lateral do icone de erro. |
136
+ | --ez-text-area\_\_tooltip-icon---width | Define a largura do icone de erro. |
137
+ | --ez-text-area\_\_tooltip-icon---horizontal-margin | Define a margem horizontal do icone de erro. |
138
+ | --ez-text-area\_\_tooltip-icon---vertical-margin | Define a margem vertical do icone de erro. |
139
+ | --ez-text-area\_\_tooltip\_icon--error--color | Define a cor da fonte da mensagem quando erro. |
@@ -42,7 +42,7 @@ Retorna se o conteúdo é inválido.
42
42
 
43
43
  Type: `Promise<boolean>`
44
44
 
45
-
45
+ ---
46
46
 
47
47
  ### `setBlur() => Promise<void>`
48
48
 
@@ -52,7 +52,7 @@ Remove o foco do campo.
52
52
 
53
53
  Type: `Promise<void>`
54
54
 
55
-
55
+ ---
56
56
 
57
57
  ### `setFocus(options?: TFocusOptions) => Promise<void>`
58
58
 
@@ -74,9 +74,11 @@ Type: `Promise<void>`
74
74
  - [ez-date-time-input](../ez-date-time-input)
75
75
  - [ez-filter-input](../ez-filter-input)
76
76
  - [ez-form-view](../ez-form-view)
77
+ - [ez-link-builder](../ez-rich-text/ez-link-builder)
77
78
  - [ez-number-input](../ez-number-input)
78
79
  - [ez-search](../ez-search)
79
80
  - [ez-search-plus](../ez-search-plus)
81
+ - [ez-simple-image-uploader](../ez-rich-text/ez-simple-image-uploader)
80
82
  - [ez-text-edit](../ez-text-edit)
81
83
  - [ez-time-input](../ez-time-input)
82
84
 
@@ -95,9 +97,11 @@ graph TD;
95
97
  ez-date-time-input --> ez-text-input
96
98
  ez-filter-input --> ez-text-input
97
99
  ez-form-view --> ez-text-input
100
+ ez-link-builder --> ez-text-input
98
101
  ez-number-input --> ez-text-input
99
102
  ez-search --> ez-text-input
100
103
  ez-search-plus --> ez-text-input
104
+ ez-simple-image-uploader --> ez-text-input
101
105
  ez-text-edit --> ez-text-input
102
106
  ez-time-input --> ez-text-input
103
107
  style ez-text-input fill:#f9f,stroke:#333,stroke-width:4px
@@ -36,7 +36,7 @@ Remove o foco do componente.
36
36
 
37
37
  Type: `Promise<void>`
38
38
 
39
-
39
+ ---
40
40
 
41
41
  ### `setFocus() => Promise<void>`
42
42
 
@@ -35,7 +35,7 @@ Remove o foco do botão.
35
35
 
36
36
  Type: `Promise<void>`
37
37
 
38
-
38
+ ---
39
39
 
40
40
  ### `setButtonFocus() => Promise<void>`
41
41
 
@@ -39,7 +39,7 @@ Retorna se o conteúdo é inválido.
39
39
 
40
40
  Type: `Promise<boolean>`
41
41
 
42
-
42
+ ---
43
43
 
44
44
  ### `setBlur() => Promise<void>`
45
45
 
@@ -49,7 +49,7 @@ Remove o foco do campo.
49
49
 
50
50
  Type: `Promise<void>`
51
51
 
52
-
52
+ ---
53
53
 
54
54
  ### `setFocus({ selectText }: TFocusOptions) => Promise<void>`
55
55
 
@@ -24,11 +24,17 @@
24
24
 
25
25
  ### Used by
26
26
 
27
+ - [ez-chip](../ez-chip)
28
+ - [ez-simple-image-uploader](../ez-rich-text/ez-simple-image-uploader)
29
+ - [ez-text-area](../ez-text-area)
27
30
  - [ez-text-input](../ez-text-input)
28
31
 
29
32
  ### Graph
30
33
  ```mermaid
31
34
  graph TD;
35
+ ez-chip --> ez-tooltip
36
+ ez-simple-image-uploader --> ez-tooltip
37
+ ez-text-area --> ez-tooltip
32
38
  ez-text-input --> ez-tooltip
33
39
  style ez-tooltip fill:#f9f,stroke:#333,stroke-width:4px
34
40
  ```
@@ -40,7 +40,7 @@ um item carregado atualmente na árvore.
40
40
 
41
41
  Type: `Promise<void>`
42
42
 
43
-
43
+ ---
44
44
 
45
45
  ### `applyFilter(pattern: string) => Promise<void>`
46
46
 
@@ -50,7 +50,17 @@ Efetua a seleção de um item.
50
50
 
51
51
  Type: `Promise<void>`
52
52
 
53
+ ---
54
+
55
+ ### `collapseAll() => Promise<void>`
56
+
57
+ Recolhe todos os itens da árvore.
58
+
59
+ #### Returns
60
+
61
+ Type: `Promise<void>`
53
62
 
63
+ ---
54
64
 
55
65
  ### `disableItem(id: string | Array<string>) => Promise<void>`
56
66
 
@@ -60,7 +70,7 @@ Desabilita um ou mais itens.
60
70
 
61
71
  Type: `Promise<void>`
62
72
 
63
-
73
+ ---
64
74
 
65
75
  ### `enableItem(id: string | Array<string>) => Promise<void>`
66
76
 
@@ -70,7 +80,17 @@ Habilita um ou mais itens.
70
80
 
71
81
  Type: `Promise<void>`
72
82
 
83
+ ---
73
84
 
85
+ ### `expandAll() => Promise<void>`
86
+
87
+ Expande todos os itens da árvore.
88
+
89
+ #### Returns
90
+
91
+ Type: `Promise<void>`
92
+
93
+ ---
74
94
 
75
95
  ### `getCurrentPath() => Promise<Array<ITreeItem>>`
76
96
 
@@ -82,6 +102,8 @@ Type: `Promise<ITreeItem[]>`
82
102
 
83
103
  Retorna um array do caminho de itens da seleção atual.
84
104
 
105
+ ---
106
+
85
107
  ### `getItem(id: string) => Promise<ITreeItem>`
86
108
 
87
109
  Obtem um item pelo id
@@ -90,7 +112,7 @@ Obtem um item pelo id
90
112
 
91
113
  Type: `Promise<ITreeItem>`
92
114
 
93
-
115
+ ---
94
116
 
95
117
  ### `getParent(id: string) => Promise<ITreeItem>`
96
118
 
@@ -100,7 +122,7 @@ Obtem o item pai a partir de um id
100
122
 
101
123
  Type: `Promise<ITreeItem>`
102
124
 
103
-
125
+ ---
104
126
 
105
127
  ### `openItem(id: string) => Promise<void>`
106
128
 
@@ -114,7 +136,7 @@ tornando possível a carga a partir de um ponto já carregado.
114
136
 
115
137
  Type: `Promise<void>`
116
138
 
117
-
139
+ ---
118
140
 
119
141
  ### `selectItem(id: string) => Promise<void>`
120
142
 
@@ -124,7 +146,7 @@ Efetua a seleção de um item.
124
146
 
125
147
  Type: `Promise<void>`
126
148
 
127
-
149
+ ---
128
150
 
129
151
  ### `updateItem(item: ITreeItem) => Promise<void>`
130
152
 
@@ -39,7 +39,7 @@ Adiciona arquivos.
39
39
 
40
40
  Type: `Promise<void>`
41
41
 
42
-
42
+ ---
43
43
 
44
44
  ### `setBlur() => Promise<void>`
45
45
 
@@ -49,7 +49,7 @@ Remove o foco do campo.
49
49
 
50
50
  Type: `Promise<void>`
51
51
 
52
-
52
+ ---
53
53
 
54
54
  ### `setFocus() => Promise<void>`
55
55
 
@@ -15,7 +15,7 @@ Obtem o índice selecionado.
15
15
 
16
16
  Type: `Promise<number>`
17
17
 
18
-
18
+ ---
19
19
 
20
20
  ### `show(index: number) => Promise<void>`
21
21
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "6.4.2",
3
+ "version": "6.5.0-dev.1",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [