@sankhyalabs/ezui-docs 6.3.0-dev.5 → 6.3.0-dev.6

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 (43) hide show
  1. package/components/ez-actions-button/readme.md +2 -2
  2. package/components/ez-button/readme.md +29 -15
  3. package/components/ez-calendar/readme.md +3 -3
  4. package/components/ez-check/readme.md +1 -1
  5. package/components/ez-chip/readme.md +1 -1
  6. package/components/ez-classic-input/readme.md +1 -1
  7. package/components/ez-classic-text-area/readme.md +1 -1
  8. package/components/ez-collapsible-box/readme.md +2 -2
  9. package/components/ez-combo-box/ez-combo-box-list/readme.md +2 -2
  10. package/components/ez-combo-box/readme.md +4 -4
  11. package/components/ez-date-input/readme.md +3 -3
  12. package/components/ez-date-time-input/readme.md +3 -3
  13. package/components/ez-filter-input/readme.md +4 -4
  14. package/components/ez-form/readme.md +2 -2
  15. package/components/ez-form-view/custom-input/readme.md +2 -2
  16. package/components/ez-form-view/readme.md +2 -2
  17. package/components/ez-grid/readme.md +18 -18
  18. package/components/ez-grid/subcomponents/readme.md +1 -1
  19. package/components/ez-guide-navigator/readme.md +8 -6
  20. package/components/ez-list/readme.md +5 -5
  21. package/components/ez-loading-bar/readme.md +1 -1
  22. package/components/ez-number-input/readme.md +3 -3
  23. package/components/ez-popover/readme.md +3 -3
  24. package/components/ez-popover-plus/readme.md +5 -5
  25. package/components/ez-popover-plus/subcomponent/readme.md +5 -5
  26. package/components/ez-rich-text/ez-link-builder/readme.md +1 -1
  27. package/components/ez-rich-text/ez-simple-image-uploader/readme.md +1 -1
  28. package/components/ez-rich-text/readme.md +2 -2
  29. package/components/ez-search/readme.md +4 -4
  30. package/components/ez-search/subcomponent/search-list/readme.md +1 -1
  31. package/components/ez-search-plus/readme.md +4 -4
  32. package/components/ez-search-plus/subcomponent/ez-search-result-list/readme.md +3 -3
  33. package/components/ez-sidebar-navigator/readme.md +2 -2
  34. package/components/ez-split-button/readme.md +4 -4
  35. package/components/ez-text-area/readme.md +3 -3
  36. package/components/ez-text-input/readme.md +2 -2
  37. package/components/ez-tile/readme.md +1 -1
  38. package/components/ez-tile-medium/readme.md +1 -1
  39. package/components/ez-time-input/readme.md +2 -2
  40. package/components/ez-tree/readme.md +12 -10
  41. package/components/ez-upload/readme.md +2 -2
  42. package/components/ez-view-stack/readme.md +1 -1
  43. package/package.json +1 -1
@@ -39,7 +39,7 @@ Oculta a lista de ações.
39
39
 
40
40
  Type: `Promise<void>`
41
41
 
42
-
42
+ ---
43
43
 
44
44
  ### `isOpened() => Promise<boolean>`
45
45
 
@@ -49,7 +49,7 @@ Verifica se a lista de ações está aberta.
49
49
 
50
50
  Type: `Promise<boolean>`
51
51
 
52
-
52
+ ---
53
53
 
54
54
  ### `showActions() => Promise<void>`
55
55
 
@@ -7,14 +7,20 @@
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://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html) | `string` | `undefined` |
14
- | `image` | `image` | Define o caminho usado nos modos `icon` e `label-icon` para imagens não contempladas na biblioteca de ícones. | `string` | `undefined` |
15
- | `label` | `label` | Texto a ser apresentado como título do botão. | `string` | `undefined` |
16
- | `mode` | `mode` | Define o modo de uso do botão. | `"icon" \| "label-icon" \| "link" \| "regular"` | `"regular"` |
17
- | `size` | `size` | Define o tamanho do ez-button. | `"large" \| "medium" \| "small" \| "x-small"` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
12
+ | `enabled` | `enabled` | ⚠️ **[DEPRECATED]** Use `isDisabled` prop instead.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://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html) | `string` | `undefined` |
14
+ | `image` | `image` | Define o caminho usado nos modos `icon` e `label-icon` para imagens não contempladas na biblioteca de ícones. | `string` | `undefined` |
15
+ | `isDisabled` | `is-disabled` | Se verdadeiro o clique no botão fica desabilitado mas a navegação continua funcional. Se full, o usuário não pode interagir com o botão. | `"" \| "full" \| boolean` | `false` |
16
+ | `label` | `label` | Texto a ser apresentado como título do botão. | `string` | `undefined` |
17
+ | `leftIconName` | `left-icon-name` | Define o ícone esquerdo do ez-button. Tem prioridade sobre o slot `leftIcon`. | `string` | `undefined` |
18
+ | `mode` | `mode` | Define o modo de uso do botão. | `"icon" \| "label-icon" \| "link" \| "regular"` | `"regular"` |
19
+ | `rightIconName` | `right-icon-name` | Define o ícone direto do ez-button. Tem prioridade sobre o slot `rightIcon`. | `string` | `undefined` |
20
+ | `size` | `size` | Define o tamanho do ez-button. | `"large" \| "medium" \| "small" \| "x-small"` | `"medium"` |
21
+ | `suppressAnimation` | `suppress-animation` | Se verdadeiro, desabilita a animação de ripple. | `boolean` | `false` |
22
+ | `type` | `type` | Define o tipo do botão. Pode ser `button`, `submit` ou `reset`. | `string` | `"button"` |
23
+ | `variant` | `variant` | Define a variante do ez-button. | `"primary" \| "secondary" \| "tertiary"` | `undefined` |
18
24
 
19
25
 
20
26
  ## Methods
@@ -27,7 +33,7 @@ Remove o foco do botão.
27
33
 
28
34
  Type: `Promise<void>`
29
35
 
30
-
36
+ ---
31
37
 
32
38
  ### `setFocus() => Promise<void>`
33
39
 
@@ -91,30 +97,38 @@ graph TD;
91
97
  | --ez-button--min-width | Define a largura mínima do componente. |
92
98
  | --ez-button--width | Define a largura do componente. |
93
99
  | --ez-button--height | Define a altura do componente. |
94
- | --ez-button\_\_icon--width | Define a largura do slot que contém o ícone. |
95
- | --ez-button\_\_inline\_\_icon--padding | Define o espaçamento entre o ícone e o label. |
96
100
  | --ez-button--padding-top | Define o espaçamento superior ao label. |
97
101
  | --ez-button--padding-bottom | Define o espaçamento inferior ao label. |
98
102
  | --ez-button--padding-right | Define o espaçamento à direita do label. |
99
103
  | --ez-button--padding-left | Define o espaçamento à esquerda do label. |
104
+ | --ez-button--icon--gap | Define o gap entre o texto e ícone, quando existir. |
100
105
  | --ez-button--color | Define a cor do label. |
106
+ | --ez-button--label-icon--color | Define a cor do label do botao tipo label-icon. |
107
+ | --ez-button--label-icon--hover-color | Define a cor do label do botao tipo label-icon, quando o mouse sobre o botão. |
108
+ | --ez-button--label-icon--disabled-color | Define a cor do label do botao tipo label-icon, quando desabilitado. |
109
+ | --ez-button--left-icon--color | Define a cor do icone esquerdo. |
110
+ | --ez-button--right-icon--color | Define a cor do icone direito, quando o mouse está sobre o botão. |
111
+ | --ez-button--left-icon--hover-color | Define a cor do icone esquerdo. |
112
+ | --ez-button--right-icon--hover-color | Define a cor do icone direito, quando o mouse está sobre o botão. |
113
+ | --ez-button--left-icon--disabled-color | Define a cor do icone esquerdo, quando desabilitado. |
114
+ | --ez-button--right-icon--disabled-color | Define a cor do icone direito, quando desabilitado. |
101
115
  | --ez-button--font-size | Define o tamanho do label. |
102
116
  | --ez-button--font-family | Define a família da fonte do label. |
103
117
  | --ez-button--font-weight | Define o peso da fonte do label. |
104
118
  | --ez-button--background-color | Define a cor de fundo do botão. |
105
119
  | --ez-button--border-radius | Define o raio da borda do botão. |
106
120
  | --ez-button--border | Define o estilo da borda do botão. |
121
+ | --ez-button--hover--border | Define o estilo da borda do botão quando em hover. |
107
122
  | --ez-button--justify-content | Define o alinhamento horizontal do conteúdo do botão. |
108
123
  | --ez-button--hover-color | Define a cor do texto e do ícone quando o cursor está sobre o botão. |
109
124
  | --ez-button--hover--background-color | Define a cor de fundo quando o cursor está sobre o botão. |
110
125
  | --ez-button--disabled-color | Define a cor do texto quando o botão está desabilitado. |
111
126
  | --ez-button--disabled--background-color | Define a cor de fundo quando o botão está desabilitado. |
112
- | --ez-button--focus--border | Define o estido da borda quando o botão está selecionado. |
113
- | --ez-button--focus--box-shadow | Define a sombra do botão quando selecionado. |
114
- | --ez-button--active-color | Define a cor do texto e do ícone ao ativar o botão. |
115
- | --ez-button--active--background-color | Define a cor do fundo ao ativar o botão. |
127
+ | --ez-button--disabled--border | Define a cor da borda quando o botão está desabilitado. |
128
+ | --ez-button--disabled-icon-color | Define a cor do icone quando o botão está desabilitado. |
116
129
  | --ez-button--link-color | Define a cor do texto do botão no modo link. |
117
130
  | --ez-button--link--hover-color | Define a cor do texto do botão no hover do modo link. |
131
+ | --ez-button--link-disabled-color | Define a cor do texto do botão no hover do modo link, quando desabilitado. |
118
132
  | --ez-button--link--small--font-size | Define o tamanho small na fonte do texto do botão no modo link. |
119
133
  | --ez-button--link--medium--font-size | Define o tamanho medium na fonte do texto do botão no modo link. |
120
134
  | --ez-button--link--large--font-size | Define o tamanho large na fonte do texto do botão no modo link. |
@@ -32,7 +32,7 @@ Ajusta o posicionamento horizontal do ez-calendar conforme a disponibilidade de
32
32
 
33
33
  Type: `Promise<void>`
34
34
 
35
-
35
+ ---
36
36
 
37
37
  ### `fitVertical(topOffset: number, bottomOffset: number) => Promise<void>`
38
38
 
@@ -42,7 +42,7 @@ Ajusta o posicionamento vertical do ez-calendar conforme a disponibilidade de es
42
42
 
43
43
  Type: `Promise<void>`
44
44
 
45
-
45
+ ---
46
46
 
47
47
  ### `hide() => Promise<void>`
48
48
 
@@ -52,7 +52,7 @@ Oculta o ez-calendar.
52
52
 
53
53
  Type: `Promise<void>`
54
54
 
55
-
55
+ ---
56
56
 
57
57
  ### `show(top?: string, left?: string, bottom?: string, right?: string) => Promise<void>`
58
58
 
@@ -35,7 +35,7 @@ Obtém o modo escolhido.
35
35
 
36
36
  Type: `Promise<CheckMode>`
37
37
 
38
-
38
+ ---
39
39
 
40
40
  ### `setFocus() => Promise<void>`
41
41
 
@@ -43,7 +43,7 @@ Remove o foco do ez-chip.
43
43
 
44
44
  Type: `Promise<void>`
45
45
 
46
-
46
+ ---
47
47
 
48
48
  ### `setFocus() => Promise<void>`
49
49
 
@@ -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(option?: OptionsSetFocus) => Promise<void>`
55
55
 
@@ -47,7 +47,7 @@ Remove o foco do campo.
47
47
 
48
48
  Type: `Promise<void>`
49
49
 
50
-
50
+ ---
51
51
 
52
52
  ### `setFocus(option?: OptionsSetFocus) => Promise<void>`
53
53
 
@@ -41,7 +41,7 @@ Aplica o foco no campo de edição de título.
41
41
 
42
42
  Type: `Promise<void>`
43
43
 
44
-
44
+ ---
45
45
 
46
46
  ### `cancelEdition() => Promise<void>`
47
47
 
@@ -51,7 +51,7 @@ Cancela a edição de título.
51
51
 
52
52
  Type: `Promise<void>`
53
53
 
54
-
54
+ ---
55
55
 
56
56
  ### `showHide() => Promise<void>`
57
57
 
@@ -30,7 +30,7 @@ Move a seleção para a próxima opção na lista.
30
30
 
31
31
  Type: `Promise<void>`
32
32
 
33
-
33
+ ---
34
34
 
35
35
  ### `previousOption() => Promise<void>`
36
36
 
@@ -40,7 +40,7 @@ Move a seleção para a opção anterior na lista, sem ultrapassar o início.
40
40
 
41
41
  Type: `Promise<void>`
42
42
 
43
-
43
+ ---
44
44
 
45
45
  ### `selectCurrentOption() => Promise<void>`
46
46
 
@@ -49,7 +49,7 @@ Limpa o valor do campo de pesquisa
49
49
 
50
50
  Type: `Promise<void>`
51
51
 
52
-
52
+ ---
53
53
 
54
54
  ### `getValueAsync() => Promise<unknown>`
55
55
 
@@ -59,7 +59,7 @@ Type: `Promise<void>`
59
59
 
60
60
  Type: `Promise<unknown>`
61
61
 
62
-
62
+ ---
63
63
 
64
64
  ### `isInvalid() => Promise<boolean>`
65
65
 
@@ -69,7 +69,7 @@ Retorna se o conteúdo é inválido.
69
69
 
70
70
  Type: `Promise<boolean>`
71
71
 
72
-
72
+ ---
73
73
 
74
74
  ### `setBlur() => Promise<void>`
75
75
 
@@ -79,7 +79,7 @@ Remove o foco do campo.
79
79
 
80
80
  Type: `Promise<void>`
81
81
 
82
-
82
+ ---
83
83
 
84
84
  ### `setFocus(options?: TFocusOptions) => Promise<void>`
85
85
 
@@ -38,7 +38,7 @@
38
38
 
39
39
  Type: `Promise<Date>`
40
40
 
41
-
41
+ ---
42
42
 
43
43
  ### `isInvalid() => Promise<boolean>`
44
44
 
@@ -48,7 +48,7 @@ Retorna se o conteúdo é inválido.
48
48
 
49
49
  Type: `Promise<boolean>`
50
50
 
51
-
51
+ ---
52
52
 
53
53
  ### `setBlur() => Promise<void>`
54
54
 
@@ -58,7 +58,7 @@ Remove o foco do campo.
58
58
 
59
59
  Type: `Promise<void>`
60
60
 
61
-
61
+ ---
62
62
 
63
63
  ### `setFocus(options?: TFocusOptions) => Promise<void>`
64
64
 
@@ -39,7 +39,7 @@
39
39
 
40
40
  Type: `Promise<Date>`
41
41
 
42
-
42
+ ---
43
43
 
44
44
  ### `isInvalid() => Promise<boolean>`
45
45
 
@@ -49,7 +49,7 @@ Retorna se o conteúdo é inválido.
49
49
 
50
50
  Type: `Promise<boolean>`
51
51
 
52
-
52
+ ---
53
53
 
54
54
  ### `setBlur() => Promise<void>`
55
55
 
@@ -59,7 +59,7 @@ Remove o foco do campo.
59
59
 
60
60
  Type: `Promise<void>`
61
61
 
62
-
62
+ ---
63
63
 
64
64
  ### `setFocus(options?: TFocusOptions) => Promise<void>`
65
65
 
@@ -39,7 +39,7 @@ Método responsável por resetar o valor do campo para o ultimo valor inputado.
39
39
 
40
40
  Type: `Promise<void>`
41
41
 
42
-
42
+ ---
43
43
 
44
44
  ### `isInvalid() => Promise<boolean>`
45
45
 
@@ -49,7 +49,7 @@ Retorna se o conteúdo é inválido.
49
49
 
50
50
  Type: `Promise<boolean>`
51
51
 
52
-
52
+ ---
53
53
 
54
54
  ### `setBlur() => Promise<void>`
55
55
 
@@ -59,7 +59,7 @@ Remove o foco do campo.
59
59
 
60
60
  Type: `Promise<void>`
61
61
 
62
-
62
+ ---
63
63
 
64
64
  ### `setFocus(options?: TFocusOptions) => Promise<void>`
65
65
 
@@ -69,7 +69,7 @@ Aplica o foco no campo.
69
69
 
70
70
  Type: `Promise<void>`
71
71
 
72
-
72
+ ---
73
73
 
74
74
  ### `setValue(newValue: string) => Promise<void>`
75
75
 
@@ -38,7 +38,7 @@ Registra um editor customizado para campos da grade e formulário.
38
38
 
39
39
  Type: `Promise<void>`
40
40
 
41
-
41
+ ---
42
42
 
43
43
  ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
44
44
 
@@ -48,7 +48,7 @@ Altera/adiciona uma propriedade nos metadados do campo.
48
48
 
49
49
  Type: `Promise<void>`
50
50
 
51
-
51
+ ---
52
52
 
53
53
  ### `validate() => Promise<void>`
54
54
 
@@ -27,7 +27,7 @@ Retorna se o conteúdo é inválido.
27
27
 
28
28
  Type: `Promise<boolean>`
29
29
 
30
-
30
+ ---
31
31
 
32
32
  ### `setBlur() => Promise<void>`
33
33
 
@@ -37,7 +37,7 @@ Remove o foco do campo.
37
37
 
38
38
  Type: `Promise<void>`
39
39
 
40
-
40
+ ---
41
41
 
42
42
  ### `setFocus() => Promise<void>`
43
43
 
@@ -32,7 +32,7 @@ Registra um editor customizado para campos da grade e formulário.
32
32
 
33
33
  Type: `Promise<void>`
34
34
 
35
-
35
+ ---
36
36
 
37
37
  ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
38
38
 
@@ -42,7 +42,7 @@ Altera/adiciona uma propriedade nos metados do campo.
42
42
 
43
43
  Type: `Promise<void>`
44
44
 
45
-
45
+ ---
46
46
 
47
47
  ### `showUp() => Promise<void>`
48
48
 
@@ -55,7 +55,7 @@ Adiciona item de menu nas colunas.
55
55
 
56
56
  Type: `Promise<void>`
57
57
 
58
-
58
+ ---
59
59
 
60
60
  ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
61
61
 
@@ -65,7 +65,7 @@ Registra um editor customizado para campos da grade e formulário.
65
65
 
66
66
  Type: `Promise<void>`
67
67
 
68
-
68
+ ---
69
69
 
70
70
  ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
71
71
 
@@ -75,7 +75,7 @@ Registra um formatador de valores para uma coluna da grid.
75
75
 
76
76
  Type: `Promise<void>`
77
77
 
78
-
78
+ ---
79
79
 
80
80
  ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
81
81
 
@@ -85,7 +85,7 @@ Registra um render customizado para colunas da grid.
85
85
 
86
86
  Type: `Promise<void>`
87
87
 
88
-
88
+ ---
89
89
 
90
90
  ### `checkStopEditOutsideClick(event: MouseEvent) => Promise<void>`
91
91
 
@@ -95,7 +95,7 @@ Type: `Promise<void>`
95
95
 
96
96
  Type: `Promise<void>`
97
97
 
98
-
98
+ ---
99
99
 
100
100
  ### `filterColumns(search: string) => Promise<Array<EzGridColumn>>`
101
101
 
@@ -105,7 +105,7 @@ Usa um argumento para filtrar as colunas po label
105
105
 
106
106
  Type: `Promise<EzGridColumn[]>`
107
107
 
108
-
108
+ ---
109
109
 
110
110
  ### `getColumns() => Promise<Array<EzGridColumn>>`
111
111
 
@@ -115,7 +115,7 @@ Obtém a lista de definição de colunas.
115
115
 
116
116
  Type: `Promise<EzGridColumn[]>`
117
117
 
118
-
118
+ ---
119
119
 
120
120
  ### `getColumnsState() => Promise<Array<EzGridColumn>>`
121
121
 
@@ -125,7 +125,7 @@ Obtém o estado atual das colunas.
125
125
 
126
126
  Type: `Promise<EzGridColumn[]>`
127
127
 
128
-
128
+ ---
129
129
 
130
130
  ### `getCustomValueFormatter(columnName: string) => Promise<ICustomFormatter | undefined>`
131
131
 
@@ -135,7 +135,7 @@ Retorna o formatador customizado da coluna caso exista.
135
135
 
136
136
  Type: `Promise<ICustomFormatter>`
137
137
 
138
-
138
+ ---
139
139
 
140
140
  ### `getSelection() => Promise<Array<any>>`
141
141
 
@@ -145,7 +145,7 @@ Obtém as linhas selecionadas.
145
145
 
146
146
  Type: `Promise<any[]>`
147
147
 
148
-
148
+ ---
149
149
 
150
150
  ### `locateColumn(columnName: string) => Promise<void>`
151
151
 
@@ -155,7 +155,7 @@ Localiza determinada coluna tornando-a visível.
155
155
 
156
156
  Type: `Promise<void>`
157
157
 
158
-
158
+ ---
159
159
 
160
160
  ### `quickFilter(term: string) => Promise<void>`
161
161
 
@@ -165,7 +165,7 @@ Aplica um filtro rápido.
165
165
 
166
166
  Type: `Promise<void>`
167
167
 
168
-
168
+ ---
169
169
 
170
170
  ### `refreshSelectedRows() => Promise<void>`
171
171
 
@@ -175,7 +175,7 @@ Atualiza linhas da grade.
175
175
 
176
176
  Type: `Promise<void>`
177
177
 
178
-
178
+ ---
179
179
 
180
180
  ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
181
181
 
@@ -185,7 +185,7 @@ Remove o formatador de valores de uma coluna da grid.
185
185
 
186
186
  Type: `Promise<void>`
187
187
 
188
-
188
+ ---
189
189
 
190
190
  ### `setColumnsDef(cols: Array<EzGridColumn>) => Promise<void>`
191
191
 
@@ -195,7 +195,7 @@ Aplica a definição de colunas.
195
195
 
196
196
  Type: `Promise<void>`
197
197
 
198
-
198
+ ---
199
199
 
200
200
  ### `setColumnsState(state: Array<EzGridColumnConfig>) => Promise<void>`
201
201
 
@@ -205,7 +205,7 @@ Aplica o estado das colunas.
205
205
 
206
206
  Type: `Promise<void>`
207
207
 
208
-
208
+ ---
209
209
 
210
210
  ### `setData(data: Array<any>) => Promise<void>`
211
211
 
@@ -215,7 +215,7 @@ Insere os registros no ez-grid.
215
215
 
216
216
  Type: `Promise<void>`
217
217
 
218
-
218
+ ---
219
219
 
220
220
  ### `setFocus() => Promise<void>`
221
221
 
@@ -225,7 +225,7 @@ Atribui o foco para a grade.
225
225
 
226
226
  Type: `Promise<void>`
227
227
 
228
-
228
+ ---
229
229
 
230
230
  ### `stopEdit() => Promise<void>`
231
231
 
@@ -36,7 +36,7 @@
36
36
 
37
37
  Type: `Promise<void>`
38
38
 
39
-
39
+ ---
40
40
 
41
41
  ### `show(configs: IFilterColumnConfigs) => Promise<void>`
42
42
 
@@ -32,7 +32,7 @@ Desabilita um ou mais itens.
32
32
 
33
33
  Type: `Promise<void>`
34
34
 
35
-
35
+ ---
36
36
 
37
37
  ### `enableItem(id: string | Array<string>) => Promise<void>`
38
38
 
@@ -42,7 +42,7 @@ Habilita um ou mais itens.
42
42
 
43
43
  Type: `Promise<void>`
44
44
 
45
-
45
+ ---
46
46
 
47
47
  ### `getCurrentPath() => Promise<Array<IGuideItem>>`
48
48
 
@@ -54,6 +54,8 @@ Type: `Promise<IGuideItem[]>`
54
54
 
55
55
  Retorna um array do caminho de itens da seleção atual.
56
56
 
57
+ ---
58
+
57
59
  ### `getItem(id: string) => Promise<IGuideItem>`
58
60
 
59
61
  Obtem um item pelo id
@@ -62,7 +64,7 @@ Obtem um item pelo id
62
64
 
63
65
  Type: `Promise<IGuideItem>`
64
66
 
65
-
67
+ ---
66
68
 
67
69
  ### `getParent(id: string) => Promise<IGuideItem>`
68
70
 
@@ -72,7 +74,7 @@ Obtem o item pai a partir de um id
72
74
 
73
75
  Type: `Promise<IGuideItem>`
74
76
 
75
-
77
+ ---
76
78
 
77
79
  ### `openGuideNavidator() => Promise<void>`
78
80
 
@@ -82,7 +84,7 @@ Abre o navegador de Guia
82
84
 
83
85
  Type: `Promise<void>`
84
86
 
85
-
87
+ ---
86
88
 
87
89
  ### `selectGuide(id: string) => Promise<void>`
88
90
 
@@ -92,7 +94,7 @@ Seleciona o item desejado pelo ID.
92
94
 
93
95
  Type: `Promise<void>`
94
96
 
95
-
97
+ ---
96
98
 
97
99
  ### `updateItem(item: IGuideItem | Array<IGuideItem>) => Promise<void>`
98
100
 
@@ -41,7 +41,7 @@ Limpa o histórico da lista.
41
41
 
42
42
  Type: `Promise<void>`
43
43
 
44
-
44
+ ---
45
45
 
46
46
  ### `getList() => Promise<Array<ListItem | ListGroup>>`
47
47
 
@@ -51,7 +51,7 @@ Obtém a lista de items ou grupos.
51
51
 
52
52
  Type: `Promise<(ListItem | ListGroup)[]>`
53
53
 
54
-
54
+ ---
55
55
 
56
56
  ### `getSelection() => Promise<ListItem>`
57
57
 
@@ -61,7 +61,7 @@ Obtém o item selecionado.
61
61
 
62
62
  Type: `Promise<ListItem>`
63
63
 
64
-
64
+ ---
65
65
 
66
66
  ### `removeSelection() => Promise<void>`
67
67
 
@@ -71,7 +71,7 @@ Limpa a seleção atual
71
71
 
72
72
  Type: `Promise<void>`
73
73
 
74
-
74
+ ---
75
75
 
76
76
  ### `scrollToTop() => Promise<void>`
77
77
 
@@ -81,7 +81,7 @@ Traz o conteúdo da lista para a área visível.
81
81
 
82
82
  Type: `Promise<void>`
83
83
 
84
-
84
+ ---
85
85
 
86
86
  ### `setSelection(selectedItem: ListItem, scrollToOption?: boolean, shitkey?: boolean, ctrlKey?: boolean) => Promise<void>`
87
87
 
@@ -15,7 +15,7 @@ Oculta o ez-loading-bar.
15
15
 
16
16
  Type: `Promise<void>`
17
17
 
18
-
18
+ ---
19
19
 
20
20
  ### `show() => Promise<void>`
21
21
 
@@ -41,7 +41,7 @@
41
41
 
42
42
  Type: `Promise<number>`
43
43
 
44
-
44
+ ---
45
45
 
46
46
  ### `isInvalid() => Promise<boolean>`
47
47
 
@@ -51,7 +51,7 @@ Retorna se o conteúdo é inválido.
51
51
 
52
52
  Type: `Promise<boolean>`
53
53
 
54
-
54
+ ---
55
55
 
56
56
  ### `setBlur() => Promise<void>`
57
57
 
@@ -61,7 +61,7 @@ Remove o foco do campo.
61
61
 
62
62
  Type: `Promise<void>`
63
63
 
64
-
64
+ ---
65
65
 
66
66
  ### `setFocus(options?: TFocusOptions) => Promise<void>`
67
67
 
@@ -33,7 +33,7 @@ Oculta o ez-popover.
33
33
 
34
34
  Type: `Promise<void>`
35
35
 
36
-
36
+ ---
37
37
 
38
38
  ### `show(top?: string, left?: string) => Promise<void>`
39
39
 
@@ -43,7 +43,7 @@ Exibe o ez-popover.
43
43
 
44
44
  Type: `Promise<void>`
45
45
 
46
-
46
+ ---
47
47
 
48
48
  ### `showUnder(element: HTMLElement, options?: IEzPopoverAnchorOptions) => Promise<void>`
49
49
 
@@ -53,7 +53,7 @@ Ancora a exibição do popOver a um elemento HTML.
53
53
 
54
54
  Type: `Promise<void>`
55
55
 
56
-
56
+ ---
57
57
 
58
58
  ### `updatePosition(top?: string, left?: string) => Promise<void>`
59
59
 
@@ -36,7 +36,7 @@ Oculta o ez-popover.
36
36
 
37
37
  Type: `Promise<void>`
38
38
 
39
-
39
+ ---
40
40
 
41
41
  ### `setAnchorElement(anchor: HTMLElement | string) => Promise<void>`
42
42
 
@@ -46,7 +46,7 @@ Altera o elemento de ancoragem.
46
46
 
47
47
  Type: `Promise<void>`
48
48
 
49
-
49
+ ---
50
50
 
51
51
  ### `setOptions(options: IEzPopoverAnchorOptions) => Promise<void>`
52
52
 
@@ -56,7 +56,7 @@ Altera as opções.
56
56
 
57
57
  Type: `Promise<void>`
58
58
 
59
-
59
+ ---
60
60
 
61
61
  ### `show(top?: string | number, left?: string | number) => Promise<void>`
62
62
 
@@ -66,7 +66,7 @@ Exibe o ez-popover.
66
66
 
67
67
  Type: `Promise<void>`
68
68
 
69
-
69
+ ---
70
70
 
71
71
  ### `showUnder(element: HTMLElement | string, options?: IEzPopoverAnchorOptions) => Promise<void>`
72
72
 
@@ -76,7 +76,7 @@ Ancora a exibição do popOver a um elemento HTML.
76
76
 
77
77
  Type: `Promise<void>`
78
78
 
79
-
79
+ ---
80
80
 
81
81
  ### `updatePosition(top?: string, left?: string) => Promise<void>`
82
82
 
@@ -36,7 +36,7 @@ Oculta o ez-popover.
36
36
 
37
37
  Type: `Promise<void>`
38
38
 
39
-
39
+ ---
40
40
 
41
41
  ### `setAnchorElement(anchor: HTMLElement | string) => Promise<void>`
42
42
 
@@ -46,7 +46,7 @@ Altera o elemento de ancoragem.
46
46
 
47
47
  Type: `Promise<void>`
48
48
 
49
-
49
+ ---
50
50
 
51
51
  ### `setOptions(options: IEzPopoverAnchorOptions) => Promise<void>`
52
52
 
@@ -56,7 +56,7 @@ Altera as opções.
56
56
 
57
57
  Type: `Promise<void>`
58
58
 
59
-
59
+ ---
60
60
 
61
61
  ### `show(top?: string | number, left?: string | number) => Promise<void>`
62
62
 
@@ -66,7 +66,7 @@ Exibe o ez-popover.
66
66
 
67
67
  Type: `Promise<void>`
68
68
 
69
-
69
+ ---
70
70
 
71
71
  ### `showUnder(element: HTMLElement | string, options?: IEzPopoverAnchorOptions) => Promise<void>`
72
72
 
@@ -76,7 +76,7 @@ Ancora a exibição do popOver a um elemento HTML.
76
76
 
77
77
  Type: `Promise<void>`
78
78
 
79
-
79
+ ---
80
80
 
81
81
  ### `updatePosition(top?: string, left?: string) => Promise<void>`
82
82
 
@@ -22,7 +22,7 @@
22
22
 
23
23
  Type: `Promise<void>`
24
24
 
25
-
25
+ ---
26
26
 
27
27
  ### `show(text?: string) => Promise<void>`
28
28
 
@@ -29,7 +29,7 @@ Método responsável pelo fechamento do popup.
29
29
 
30
30
  Type: `Promise<void>`
31
31
 
32
-
32
+ ---
33
33
 
34
34
  ### `show() => Promise<void>`
35
35
 
@@ -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() => Promise<void>`
55
55
 
@@ -50,7 +50,7 @@ Limpa o valor do campo de pesquisa
50
50
 
51
51
  Type: `Promise<void>`
52
52
 
53
-
53
+ ---
54
54
 
55
55
  ### `getValueAsync() => Promise<unknown>`
56
56
 
@@ -60,7 +60,7 @@ Type: `Promise<void>`
60
60
 
61
61
  Type: `Promise<unknown>`
62
62
 
63
-
63
+ ---
64
64
 
65
65
  ### `isInvalid() => Promise<boolean>`
66
66
 
@@ -70,7 +70,7 @@ Retorna se o conteúdo é inválido.
70
70
 
71
71
  Type: `Promise<boolean>`
72
72
 
73
-
73
+ ---
74
74
 
75
75
  ### `setBlur() => Promise<void>`
76
76
 
@@ -80,7 +80,7 @@ Remove o foco do campo.
80
80
 
81
81
  Type: `Promise<void>`
82
82
 
83
-
83
+ ---
84
84
 
85
85
  ### `setFocus(options?: TFocusOptions) => Promise<void>`
86
86
 
@@ -36,7 +36,7 @@
36
36
 
37
37
  Type: `Promise<void>`
38
38
 
39
-
39
+ ---
40
40
 
41
41
  ### `previousOption() => Promise<void>`
42
42
 
@@ -52,7 +52,7 @@ Limpa o valor do campo de pesquisa
52
52
 
53
53
  Type: `Promise<void>`
54
54
 
55
-
55
+ ---
56
56
 
57
57
  ### `getValueAsync() => Promise<IOption>`
58
58
 
@@ -63,7 +63,7 @@ ter sido resolvido pelo option loader quando necessário
63
63
 
64
64
  Type: `Promise<IOption>`
65
65
 
66
-
66
+ ---
67
67
 
68
68
  ### `isInvalid() => Promise<boolean>`
69
69
 
@@ -73,7 +73,7 @@ Retorna se o conteúdo é inválido.
73
73
 
74
74
  Type: `Promise<boolean>`
75
75
 
76
-
76
+ ---
77
77
 
78
78
  ### `setBlur() => Promise<void>`
79
79
 
@@ -83,7 +83,7 @@ Remove o foco do campo.
83
83
 
84
84
  Type: `Promise<void>`
85
85
 
86
-
86
+ ---
87
87
 
88
88
  ### `setFocus(options?: TFocusOptions) => Promise<void>`
89
89
 
@@ -32,7 +32,7 @@
32
32
 
33
33
  Type: `Promise<void>`
34
34
 
35
-
35
+ ---
36
36
 
37
37
  ### `nextOption() => Promise<void>`
38
38
 
@@ -42,7 +42,7 @@ Type: `Promise<void>`
42
42
 
43
43
  Type: `Promise<void>`
44
44
 
45
-
45
+ ---
46
46
 
47
47
  ### `previousOption() => Promise<void>`
48
48
 
@@ -52,7 +52,7 @@ Type: `Promise<void>`
52
52
 
53
53
  Type: `Promise<void>`
54
54
 
55
-
55
+ ---
56
56
 
57
57
  ### `selectCurrentItem() => Promise<void>`
58
58
 
@@ -35,7 +35,7 @@ Método para fixar/desafixar o menu, emitindo o evento ezChangeMode.
35
35
 
36
36
  Type: `Promise<void>`
37
37
 
38
-
38
+ ---
39
39
 
40
40
  ### `closeSidebar() => Promise<void>`
41
41
 
@@ -45,7 +45,7 @@ Método para fechar o menu automaticamente após uma ação, fluxo, etc.
45
45
 
46
46
  Type: `Promise<void>`
47
47
 
48
-
48
+ ---
49
49
 
50
50
  ### `openSidebar() => Promise<void>`
51
51
 
@@ -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
 
@@ -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
 
@@ -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
 
@@ -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
 
@@ -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,7 @@ Efetua a seleção de um item.
50
50
 
51
51
  Type: `Promise<void>`
52
52
 
53
-
53
+ ---
54
54
 
55
55
  ### `collapseAll() => Promise<void>`
56
56
 
@@ -60,7 +60,7 @@ Recolhe todos os itens da árvore.
60
60
 
61
61
  Type: `Promise<void>`
62
62
 
63
-
63
+ ---
64
64
 
65
65
  ### `disableItem(id: string | Array<string>) => Promise<void>`
66
66
 
@@ -70,7 +70,7 @@ Desabilita um ou mais itens.
70
70
 
71
71
  Type: `Promise<void>`
72
72
 
73
-
73
+ ---
74
74
 
75
75
  ### `enableItem(id: string | Array<string>) => Promise<void>`
76
76
 
@@ -80,7 +80,7 @@ Habilita um ou mais itens.
80
80
 
81
81
  Type: `Promise<void>`
82
82
 
83
-
83
+ ---
84
84
 
85
85
  ### `expandAll() => Promise<void>`
86
86
 
@@ -90,7 +90,7 @@ Expande todos os itens da árvore.
90
90
 
91
91
  Type: `Promise<void>`
92
92
 
93
-
93
+ ---
94
94
 
95
95
  ### `getCurrentPath() => Promise<Array<ITreeItem>>`
96
96
 
@@ -102,6 +102,8 @@ Type: `Promise<ITreeItem[]>`
102
102
 
103
103
  Retorna um array do caminho de itens da seleção atual.
104
104
 
105
+ ---
106
+
105
107
  ### `getItem(id: string) => Promise<ITreeItem>`
106
108
 
107
109
  Obtem um item pelo id
@@ -110,7 +112,7 @@ Obtem um item pelo id
110
112
 
111
113
  Type: `Promise<ITreeItem>`
112
114
 
113
-
115
+ ---
114
116
 
115
117
  ### `getParent(id: string) => Promise<ITreeItem>`
116
118
 
@@ -120,7 +122,7 @@ Obtem o item pai a partir de um id
120
122
 
121
123
  Type: `Promise<ITreeItem>`
122
124
 
123
-
125
+ ---
124
126
 
125
127
  ### `openItem(id: string) => Promise<void>`
126
128
 
@@ -134,7 +136,7 @@ tornando possível a carga a partir de um ponto já carregado.
134
136
 
135
137
  Type: `Promise<void>`
136
138
 
137
-
139
+ ---
138
140
 
139
141
  ### `selectItem(id: string) => Promise<void>`
140
142
 
@@ -144,7 +146,7 @@ Efetua a seleção de um item.
144
146
 
145
147
  Type: `Promise<void>`
146
148
 
147
-
149
+ ---
148
150
 
149
151
  ### `updateItem(item: ITreeItem) => Promise<void>`
150
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.3.0-dev.5",
3
+ "version": "6.3.0-dev.6",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [