@sankhyalabs/ezui 2.3.1 → 2.3.2

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 (155) hide show
  1. package/README.md +1 -0
  2. package/dist/cjs/ez-actions-button.cjs.entry.js +12 -8
  3. package/dist/cjs/ez-button.cjs.entry.js +5 -5
  4. package/dist/cjs/ez-calendar.cjs.entry.js +10 -13
  5. package/dist/cjs/ez-check.cjs.entry.js +5 -8
  6. package/dist/cjs/ez-chip.cjs.entry.js +4 -4
  7. package/dist/cjs/ez-collapsible-box.cjs.entry.js +14 -14
  8. package/dist/cjs/ez-combo-box.cjs.entry.js +11 -11
  9. package/dist/cjs/ez-date-input.cjs.entry.js +5 -5
  10. package/dist/cjs/ez-date-time-input.cjs.entry.js +7 -7
  11. package/dist/cjs/ez-dialog.cjs.entry.js +4 -7
  12. package/dist/cjs/ez-filter-input.cjs.entry.js +6 -6
  13. package/dist/cjs/ez-form.cjs.entry.js +3 -6
  14. package/dist/cjs/ez-grid.cjs.entry.js +16 -17
  15. package/dist/cjs/ez-icon.cjs.entry.js +3 -3
  16. package/dist/cjs/ez-list.cjs.entry.js +71 -71
  17. package/dist/cjs/ez-loading-bar.cjs.entry.js +8 -4
  18. package/dist/cjs/ez-modal-container.cjs.entry.js +2 -2
  19. package/dist/cjs/ez-modal.cjs.entry.js +6 -6
  20. package/dist/cjs/ez-number-input.cjs.entry.js +5 -5
  21. package/dist/cjs/ez-popover.cjs.entry.js +8 -10
  22. package/dist/cjs/ez-popup.cjs.entry.js +4 -5
  23. package/dist/cjs/ez-radio-button.cjs.entry.js +3 -3
  24. package/dist/cjs/ez-scroller.cjs.entry.js +2 -7
  25. package/dist/cjs/ez-search.cjs.entry.js +13 -14
  26. package/dist/cjs/ez-text-area.cjs.entry.js +7 -7
  27. package/dist/cjs/ez-text-edit.cjs.entry.js +1 -1
  28. package/dist/cjs/ez-text-input.cjs.entry.js +7 -7
  29. package/dist/cjs/ez-time-input.cjs.entry.js +6 -6
  30. package/dist/cjs/ez-toast.cjs.entry.js +5 -5
  31. package/dist/cjs/ez-upload.cjs.entry.js +5 -5
  32. package/dist/cjs/ez-view-stack.cjs.entry.js +2 -2
  33. package/dist/cjs/ezui.cjs.js +1 -1
  34. package/dist/cjs/loader.cjs.js +1 -1
  35. package/dist/collection/components/ez-actions-button/ez-actions-button.js +27 -22
  36. package/dist/collection/components/ez-button/ez-button.js +15 -15
  37. package/dist/collection/components/ez-calendar/ez-calendar.js +18 -21
  38. package/dist/collection/components/ez-card-item/ez-card-item.js +2 -2
  39. package/dist/collection/components/ez-check/ez-check.js +28 -22
  40. package/dist/collection/components/ez-chip/ez-chip.js +15 -15
  41. package/dist/collection/components/ez-collapsible-box/ez-collapsible-box.js +28 -28
  42. package/dist/collection/components/ez-combo-box/ez-combo-box.js +42 -33
  43. package/dist/collection/components/ez-date-input/ez-date-input.js +18 -18
  44. package/dist/collection/components/ez-date-time-input/ez-date-time-input.js +21 -21
  45. package/dist/collection/components/ez-dialog/ez-dialog.js +13 -35
  46. package/dist/collection/components/ez-filter-input/ez-filter-input.js +18 -35
  47. package/dist/collection/components/ez-form/ez-form.js +7 -42
  48. package/dist/collection/components/ez-grid/ez-grid.js +41 -42
  49. package/dist/collection/components/ez-icon/ez-icon.js +11 -11
  50. package/dist/collection/components/ez-list/ez-list.js +112 -93
  51. package/dist/collection/components/ez-loading-bar/ez-loading-bar.js +10 -6
  52. package/dist/collection/components/ez-modal/ez-modal.js +14 -14
  53. package/dist/collection/components/ez-modal-container/ez-modal-container.js +16 -16
  54. package/dist/collection/components/ez-number-input/ez-number-input.js +20 -20
  55. package/dist/collection/components/ez-popover/ez-popover.js +22 -24
  56. package/dist/collection/components/ez-popup/ez-popup.js +16 -17
  57. package/dist/collection/components/ez-radio-button/ez-radio-button.js +8 -8
  58. package/dist/collection/components/ez-scroller/ez-scroller.js +6 -12
  59. package/dist/collection/components/ez-search/ez-search.js +42 -46
  60. package/dist/collection/components/ez-tabselector/ez-tabselector.js +2 -2
  61. package/dist/collection/components/ez-text-area/ez-text-area.js +20 -37
  62. package/dist/collection/components/ez-text-edit/ez-text-edit.js +6 -6
  63. package/dist/collection/components/ez-text-input/ez-text-input.js +21 -38
  64. package/dist/collection/components/ez-time-input/ez-time-input.js +20 -20
  65. package/dist/collection/components/ez-toast/ez-toast.js +12 -12
  66. package/dist/collection/components/ez-upload/ez-upload.js +14 -14
  67. package/dist/collection/components/ez-view-stack/ez-view-stack.js +4 -4
  68. package/dist/custom-elements/index.js +265 -279
  69. package/dist/esm/ez-actions-button.entry.js +12 -8
  70. package/dist/esm/ez-button.entry.js +5 -5
  71. package/dist/esm/ez-calendar.entry.js +10 -13
  72. package/dist/esm/ez-check.entry.js +5 -8
  73. package/dist/esm/ez-chip.entry.js +4 -4
  74. package/dist/esm/ez-collapsible-box.entry.js +14 -14
  75. package/dist/esm/ez-combo-box.entry.js +11 -11
  76. package/dist/esm/ez-date-input.entry.js +5 -5
  77. package/dist/esm/ez-date-time-input.entry.js +7 -7
  78. package/dist/esm/ez-dialog.entry.js +4 -7
  79. package/dist/esm/ez-filter-input.entry.js +6 -6
  80. package/dist/esm/ez-form.entry.js +3 -6
  81. package/dist/esm/ez-grid.entry.js +16 -17
  82. package/dist/esm/ez-icon.entry.js +3 -3
  83. package/dist/esm/ez-list.entry.js +71 -71
  84. package/dist/esm/ez-loading-bar.entry.js +8 -4
  85. package/dist/esm/ez-modal-container.entry.js +2 -2
  86. package/dist/esm/ez-modal.entry.js +6 -6
  87. package/dist/esm/ez-number-input.entry.js +5 -5
  88. package/dist/esm/ez-popover.entry.js +8 -10
  89. package/dist/esm/ez-popup.entry.js +4 -5
  90. package/dist/esm/ez-radio-button.entry.js +3 -3
  91. package/dist/esm/ez-scroller.entry.js +2 -7
  92. package/dist/esm/ez-search.entry.js +13 -14
  93. package/dist/esm/ez-text-area.entry.js +7 -7
  94. package/dist/esm/ez-text-edit.entry.js +1 -1
  95. package/dist/esm/ez-text-input.entry.js +7 -7
  96. package/dist/esm/ez-time-input.entry.js +6 -6
  97. package/dist/esm/ez-toast.entry.js +5 -5
  98. package/dist/esm/ez-upload.entry.js +5 -5
  99. package/dist/esm/ez-view-stack.entry.js +2 -2
  100. package/dist/esm/ezui.js +1 -1
  101. package/dist/esm/loader.js +1 -1
  102. package/dist/ezui/ezui.esm.js +1 -1
  103. package/dist/ezui/p-1214c5ce.entry.js +1 -0
  104. package/dist/ezui/p-2af9fe67.entry.js +1 -0
  105. package/dist/ezui/p-642c530f.entry.js +1 -0
  106. package/dist/ezui/p-96265e26.entry.js +1 -0
  107. package/dist/ezui/p-b47eb5d4.entry.js +1 -0
  108. package/dist/ezui/{p-855f99f8.entry.js → p-ccbe8272.entry.js} +1 -1
  109. package/dist/ezui/p-e60e7308.entry.js +1 -0
  110. package/dist/ezui/p-ede1328a.entry.js +1 -0
  111. package/dist/ezui/p-f6111077.entry.js +1 -0
  112. package/dist/types/components/ez-actions-button/ez-actions-button.d.ts +15 -14
  113. package/dist/types/components/ez-button/ez-button.d.ts +10 -10
  114. package/dist/types/components/ez-calendar/ez-calendar.d.ts +11 -14
  115. package/dist/types/components/ez-card-item/ez-card-item.d.ts +7 -0
  116. package/dist/types/components/ez-check/ez-check.d.ts +11 -13
  117. package/dist/types/components/ez-chip/ez-chip.d.ts +15 -14
  118. package/dist/types/components/ez-collapsible-box/ez-collapsible-box.d.ts +25 -25
  119. package/dist/types/components/ez-combo-box/ez-combo-box.d.ts +21 -20
  120. package/dist/types/components/ez-date-input/ez-date-input.d.ts +16 -17
  121. package/dist/types/components/ez-date-time-input/ez-date-time-input.d.ts +18 -19
  122. package/dist/types/components/ez-dialog/ez-dialog.d.ts +13 -16
  123. package/dist/types/components/ez-filter-input/ez-filter-input.d.ts +12 -17
  124. package/dist/types/components/ez-form/ez-form.d.ts +7 -5
  125. package/dist/types/components/ez-grid/controller/EzGridController.d.ts +2 -2
  126. package/dist/types/components/ez-grid/ez-grid.d.ts +37 -39
  127. package/dist/types/components/ez-icon/ez-icon.d.ts +4 -4
  128. package/dist/types/components/ez-list/ez-list.d.ts +29 -32
  129. package/dist/types/components/ez-loading-bar/ez-loading-bar.d.ts +6 -0
  130. package/dist/types/components/ez-modal/ez-modal.d.ts +15 -15
  131. package/dist/types/components/ez-modal-container/ez-modal-container.d.ts +10 -10
  132. package/dist/types/components/ez-number-input/ez-number-input.d.ts +18 -24
  133. package/dist/types/components/ez-popover/ez-popover.d.ts +13 -16
  134. package/dist/types/components/ez-popup/ez-popup.d.ts +12 -13
  135. package/dist/types/components/ez-radio-button/ez-radio-button.d.ts +8 -8
  136. package/dist/types/components/ez-scroller/ez-scroller.d.ts +3 -4
  137. package/dist/types/components/ez-search/ez-search.d.ts +27 -31
  138. package/dist/types/components/ez-tabselector/ez-tabselector.d.ts +4 -7
  139. package/dist/types/components/ez-text-area/ez-text-area.d.ts +12 -16
  140. package/dist/types/components/ez-text-edit/ez-text-edit.d.ts +5 -5
  141. package/dist/types/components/ez-text-input/ez-text-input.d.ts +14 -19
  142. package/dist/types/components/ez-time-input/ez-time-input.d.ts +16 -17
  143. package/dist/types/components/ez-toast/ez-toast.d.ts +7 -7
  144. package/dist/types/components/ez-upload/ez-upload.d.ts +11 -12
  145. package/dist/types/components/ez-view-stack/ez-view-stack.d.ts +2 -2
  146. package/dist/types/components.d.ts +514 -529
  147. package/package.json +2 -2
  148. package/dist/ezui/p-0fb5f4be.entry.js +0 -1
  149. package/dist/ezui/p-1ba371a3.entry.js +0 -1
  150. package/dist/ezui/p-42c6493e.entry.js +0 -1
  151. package/dist/ezui/p-6700360e.entry.js +0 -1
  152. package/dist/ezui/p-89b2a151.entry.js +0 -1
  153. package/dist/ezui/p-8c2105a5.entry.js +0 -1
  154. package/dist/ezui/p-ed2135a5.entry.js +0 -1
  155. package/dist/ezui/p-f6afdc4d.entry.js +0 -1
@@ -7,7 +7,8 @@
7
7
  import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
8
8
  import { IAction } from "./components/ez-actions-button/ez-actions-button";
9
9
  import { CardItem } from "./components/ez-card-item/ez-card-item";
10
- import { IOption } from "./components/ez-combo-box/ez-combo-box";
10
+ import { CheckMode } from "./components/ez-check/CheckMode";
11
+ import { IOption, ISearchArgument } from "./components/ez-combo-box/ez-combo-box";
11
12
  import { DataUnit, Record, WaitingChange } from "@sankhyalabs/core";
12
13
  import { DialogType } from "./components/ez-dialog/DialogType";
13
14
  import { IFormConfig, IRecordValidator, IValidationResult } from "./components/ez-form/ez-form";
@@ -15,54 +16,54 @@ import { EzGridColumn, EzGridColumnConfig, EzGridColumStateEvent, IGridConfig, I
15
16
  import { ListGroup, ListItem } from "./components/ez-list/ez-list";
16
17
  import { Radio } from "./components/ez-radio-button/ez-radio-button";
17
18
  import { EzScrollDirection } from "./components/ez-scroller/EzScrollDirection";
18
- import { IOption as IOption1 } from "./components/ez-combo-box/ez-combo-box";
19
+ import { IOption as IOption1, ISearchArgument as ISearchArgument1 } from "./components/ez-combo-box/ez-combo-box";
19
20
  import { Tab } from "./components/ez-tabselector/ez-tabselector";
20
21
  import { IStyled } from "./components/ez-text-edit/ez-text-edit";
21
22
  import { EzFile } from "./components/ez-upload/ez-upload";
22
23
  export namespace Components {
23
24
  interface EzActionsButton {
24
25
  /**
25
- * . Array no formato "{value: string, label: string, iconName: string}" que alimenta a lista de ações.
26
+ * Define a lista de ações. Os elementos devem obedecer o formato: `{value: string, label: string}`.
26
27
  */
27
28
  "actions": Array<IAction>;
28
29
  /**
29
- * Define se o elemento contará com a seta de orientação.
30
+ * Se true a seta de ordenação será apresentada.
30
31
  */
31
32
  "arrowActive": boolean;
32
33
  /**
33
- * Define se na opção selecionada apresentará um ícone de check.
34
+ * Se true o check será apresentado para os itens.
34
35
  */
35
36
  "checkOption": boolean;
36
37
  /**
37
- * Nome do ícone que será apresentado no display do componente.
38
+ * Define o ícone do componente.
38
39
  */
39
40
  "displayIcon": string;
40
41
  /**
41
- * Deixa o campo disponível ou não para interação com usuário.
42
+ * Se false o usuário não pode interagir com o componente.
42
43
  */
43
44
  "enabled": boolean;
44
45
  /**
45
- * Oculta a lista de ações
46
+ * Oculta a lista de ações.
46
47
  */
47
48
  "hideActions": () => Promise<void>;
48
49
  /**
49
- * Verifica se a lista de ações está oculta
50
+ * Verifica se a lista de ações está aberta.
50
51
  */
51
52
  "isOpened": () => Promise<boolean>;
52
53
  /**
53
- * Define se o background do botão será transparent.
54
+ * Se true o background será transparent.
54
55
  */
55
56
  "isTransparent": boolean;
56
57
  /**
57
- * Define se o label será apresentado no display do componente.
58
+ * Se true o label será apresentado.
58
59
  */
59
60
  "showLabel": boolean;
60
61
  /**
61
- * É possível escolher entre [small,medium,large].
62
+ * Determina o tamanho do ez-action-button.
62
63
  */
63
- "size": "small" | "medium" | "large" | undefined;
64
+ "size": "small" | "medium" | "large";
64
65
  /**
65
- * Define qual o value que será selecionado na lista.
66
+ * Define o valor do componente.
66
67
  */
67
68
  "value": string;
68
69
  }
@@ -70,138 +71,141 @@ export namespace Components {
70
71
  }
71
72
  interface EzButton {
72
73
  /**
73
- * Deixa o botão disponível ou não para interação com o usuário.
74
+ * Se false o usuário não pode interagir com o botão.
74
75
  */
75
76
  "enabled": boolean;
76
77
  /**
77
- * Nome do icone disponível no pacote de fontes [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html)
78
+ * Define o ícone a ser usado da biblioteca de ícones: [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html)
78
79
  */
79
80
  "iconName": string;
80
81
  /**
81
- * Define o icone svg que será utilizado no botão. Esta propriedade é utilizada caso o componente esteja no modo "icon"
82
+ * Define o caminho usado nos modos `icon` e `label-icon` para imagens não contempladas na biblioteca de ícones.
82
83
  */
83
84
  "image": string;
84
85
  /**
85
- * Texto indicativo da ação do botão.
86
+ * Texto a ser apresentado como título do botão.
86
87
  */
87
88
  "label": string;
88
89
  /**
89
- * Define o modo de uso do botão; opções: icon, link e regular
90
+ * Define o modo de uso do botão.
90
91
  */
91
- "mode": string;
92
+ "mode": "regular" | "icon" | "link" | "label-icon";
92
93
  /**
93
- * Remove o foco no botão
94
+ * Remove o foco do botão.
94
95
  */
95
96
  "setBlur": () => Promise<void>;
96
97
  /**
97
- * Realiza o foco no botão
98
+ * Aplica o foco no botão.
98
99
  */
99
100
  "setFocus": () => Promise<void>;
100
101
  /**
101
- * É possível escolher entre [small,medium,large] (somente para os modos "icon" e "link")
102
+ * Define o tamanho do ez-button.
102
103
  */
103
104
  "size": "small" | "medium" | "large" | undefined;
104
105
  }
105
106
  interface EzCalendar {
106
107
  /**
107
- * Método necessário para ajustar o posicionamento do calendar acima ou abaixo do ez-date-input conforme a disponibilidade de espaço.
108
+ * Ajusta o posicionamento do ez-calendar conforme a disponibilidade de espaço.
108
109
  */
109
110
  "fitVertical": (topOffset: number, bottomOffset: number) => Promise<void>;
110
111
  /**
111
- * No modo floating o calendário se tornará visível quando o método show() for acionado.
112
+ * Define se a exibição do ez-calendar será feita pelos métodos `show()` e `hide()`.
112
113
  */
113
114
  "floating": boolean;
114
115
  /**
115
- * Usado no modo floating. Faz com que o componente seja ocultado.
116
+ * Oculta o ez-calendar.
116
117
  */
117
118
  "hide": () => Promise<void>;
118
119
  /**
119
- * Usado no modo floating. Faz com que o componente seja exibido. É possível determinar ajustes de posicionamento através dos parâmetros top, left, bottom e right. Esses parâmetros devem ser informados como strings no formato css.
120
+ * Exibe o ez-calendar em uma posição determinada. É possível determinar o posicionamento através dos parâmetros, no formato css.
120
121
  */
121
122
  "show": (top?: string, left?: string, bottom?: string, right?: string) => Promise<void>;
122
123
  /**
123
- * Exibe ou não os segundos no calendario
124
+ * Se true a data considera segundos. Deve ser usado em conjunto com a propriedade `time`.
124
125
  */
125
126
  "showSeconds": boolean;
126
127
  /**
127
- * Exibe ou não as horas e minutos no calendario
128
+ * Se true a data considera horas e minutos.
128
129
  */
129
130
  "time": boolean;
130
131
  /**
131
- * A data selecionada no calendário
132
+ * Define o valor do calendário.
132
133
  */
133
134
  "value": Date;
134
135
  }
135
136
  interface EzCardItem {
137
+ /**
138
+ * Determina o conteúdo do card. Deve conter um objeto no formato: `{title: string, key: string, details: any}`.
139
+ */
136
140
  "item": CardItem;
137
141
  }
138
142
  interface EzCheck {
139
143
  /**
140
- * Deixa o campo disponível ou não para interação com o usuário.
144
+ * Se false o usuário não pode interagir com o campo.
141
145
  */
142
146
  "enabled": boolean;
143
147
  /**
144
- * Devolve o modo escolhido para o componente
148
+ * Obtém o modo escolhido.
145
149
  */
146
- "getMode": () => Promise<string>;
150
+ "getMode": () => Promise<CheckMode>;
147
151
  /**
148
- * Deixa o campo em um estado indeterminado, nem marcado nem desmarcado (não disponível em modo "switch").
152
+ * Se true ativa o estado indeterminado, nem marcado nem desmarcado (não disponível em modo `switch`).
149
153
  */
150
154
  "indeterminate": boolean;
151
155
  /**
152
- * Título do campo
156
+ * Texto a ser apresentado como título do campo.
153
157
  */
154
158
  "label": string;
155
159
  /**
156
- * Existem dois modos de visualização: regular e switch. Se esta propriedade for omitida, o componete assume o formato "regular". No modo "regular" a visualização é a tradicional de uma caixinha marcada/desmarcada. No modo "switch" o campo tem uma interface em formato de um pino liga/desliga.
160
+ * Define o modo de visualização do ez-check.
157
161
  */
158
- "mode": string;
162
+ "mode": CheckMode;
159
163
  /**
160
- * Faz o foco no componente de input
164
+ * Aplica o foco no campo.
161
165
  */
162
166
  "setFocus": () => Promise<void>;
163
167
  /**
164
- * Como se trata de um componente binário, o valor alterna entre true e false (marcado / desmarcado)
168
+ * Define o valor do campo.
165
169
  */
166
170
  "value": boolean;
167
171
  }
168
172
  interface EzChip {
169
173
  /**
170
- * Deixa o componente disponível ou não para seleção.
174
+ * Se false o usuário não pode interagir com o ez-chip.
171
175
  */
172
176
  "enabled": boolean;
173
177
  /**
174
- * Título exibido no componente.
178
+ * Texto a ser apresentado como título do ez-chip.
175
179
  */
176
180
  "label": string;
177
181
  /**
178
- * Define o modo de uso do cjip: label ou action
182
+ * Define o modo de uso do ez-chip.
179
183
  */
180
184
  "mode": "label" | "action";
181
185
  /**
182
- * Indica se o componente terá a opção de ser removido e qual sua posição: left ou right.
186
+ * Determina o posicionamento do botão de remover (não disponível no modo `action`). Se não informado, não exibe o botão.
183
187
  */
184
- "removePosition": "left" | "right";
188
+ "removePosition": "left" | "right" | undefined;
185
189
  /**
186
- * Remove o foco no componente de input
190
+ * Remove o foco do ez-chip.
187
191
  */
188
192
  "setBlur": () => Promise<void>;
189
193
  /**
190
- * Faz o foco no componente de input
194
+ * Aplica o foco no ez-chip.
191
195
  */
192
196
  "setFocus": () => Promise<void>;
193
197
  /**
194
- * Indica se o componente está ou não ativado.
198
+ * Define o valor do ez-chip.
195
199
  */
196
200
  "value": boolean;
197
201
  }
198
202
  interface EzCollapsibleBox {
199
203
  /**
200
- * Aplica focus no campo de edição de título.
204
+ * Aplica o foco no campo de edição de título.
201
205
  */
202
206
  "applyFocusTextEdit": () => Promise<void>;
203
207
  /**
204
- * Fecha a edição de título.
208
+ * Cancela a edição de título.
205
209
  */
206
210
  "cancelEdition": () => Promise<void>;
207
211
  /**
@@ -209,390 +213,389 @@ export namespace Components {
209
213
  */
210
214
  "conditionalSave": Function;
211
215
  /**
212
- * Ativa o ícone para edição do componente.
216
+ * Se true mostra o ícone para edição do componente.
213
217
  */
214
218
  "editable": boolean;
215
219
  /**
216
- * Define o tamanho do texto e do ícone do componente.
220
+ * Define o tamanho do texto e do ícone.
217
221
  */
218
222
  "headerSize": "x-small" | "small" | "medium" | "large" | "x-large" | undefined;
219
223
  /**
220
- * Define o local onde o ícone será renderizado.
224
+ * Define o posicionamento do ícone.
221
225
  */
222
226
  "iconPlacement": "left" | "right";
223
227
  /**
224
- * Título do campo
228
+ * Texto a ser apresentado como título do componente.
225
229
  */
226
230
  "label": string;
227
231
  /**
228
- * Ativa o ícone para remoção do componente.
232
+ * Se true mostra o ícone para remoção do componente.
229
233
  */
230
234
  "removable": boolean;
231
235
  /**
232
- * Esconde ou revela o conteúdo do componente.
236
+ * Oculta/mostra o conteúdo do ez-collapsible-box.
233
237
  */
234
238
  "showHide": () => Promise<void>;
235
239
  /**
236
- * Define se o titulo irá ocupar toda a largura do componente.
240
+ * Se true o título irá ocupar toda a largura do componente.
237
241
  */
238
242
  "stretchTitle": boolean;
239
243
  /**
240
- * Valor externalizado que garante a exibição ou não do componente.
244
+ * Define o valor do componente.
241
245
  */
242
246
  "value": boolean;
243
247
  }
244
248
  interface EzComboBox {
245
249
  /**
246
- * Permite exibir a mensagem de erro.
250
+ * Se false deixa de exibir a mensagem de erro dentro do campo.
247
251
  */
248
252
  "canShowError": boolean;
249
253
  /**
250
- * Deixa o campo disponível ou não para interação com usuário.
254
+ * Se false o usuário não pode interagir com o campo.
251
255
  */
252
256
  "enabled": boolean;
253
257
  /**
254
- * Quando um problema de validação, serve como orientação ao usuário
258
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
255
259
  */
256
260
  "errorMessage": string;
257
261
  /**
258
- * Retorna informando se o campo está inválido (true | false)
262
+ * Retorna se o conteúdo é inválido.
259
263
  */
260
264
  "isInvalid": () => Promise<boolean>;
261
265
  /**
262
- * Título do campo
266
+ * Texto a ser apresentado como título do campo.
263
267
  */
264
268
  "label": string;
265
269
  /**
266
- * Define o modo do tamanho do campo; opções: slim e regular.
270
+ * Define o tamanho do campo.
267
271
  */
268
- "mode": string;
272
+ "mode": "slim" | "regular";
269
273
  /**
270
- * Função responsável por carregar as opções dinamicamente
274
+ * Carrega as opções dinamicamente.
271
275
  */
272
- "optionLoader": Function;
276
+ "optionLoader": (argument: ISearchArgument) => Promise<Array<IOption>> | Array<IOption> | IOption;
273
277
  /**
274
- * Array no formato "{value: string, label: string}" que alimenta as opções do Combobox
278
+ * Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`.
275
279
  */
276
280
  "options": Array<IOption>;
277
281
  /**
278
- * Ativa o modo pesquisa do combobox
282
+ * Se true ativa o modo pesquisa do ez-combo-box.
279
283
  */
280
284
  "searchMode": boolean;
281
285
  /**
282
- * Remove o foco no componente de seleção
286
+ * Remove o foco do campo.
283
287
  */
284
288
  "setBlur": () => Promise<void>;
285
289
  /**
286
- * Realiza o foco no componente de seleção
290
+ * Aplica o foco no campo.
287
291
  */
288
292
  "setFocus": () => Promise<void>;
289
293
  /**
290
- * Ajusta a opção de mostrar o "value" para cada opção. Por padrão não mostra
294
+ * Se true cada opção na lista exibe o `value` junto com `label`.
291
295
  */
292
296
  "showOptionValue": boolean;
293
297
  /**
294
- * Ajusta a opção de mostrar o "value" ao selecionar uma opção. Por padrão não mostra.
298
+ * Se true a opção selecionada exibe o `value` junto com `label`.
295
299
  */
296
300
  "showSelectedValue": boolean;
297
301
  /**
298
- * Remove a opção vazia da lista de opções
302
+ * Se true remove a opção vazia da lista.
299
303
  */
300
304
  "suppressEmptyOption": boolean;
301
305
  /**
302
- * Desabilita a digitação dentro do componente.
306
+ * Se true desabilita a digitação dentro do componente.
303
307
  */
304
308
  "suppressSearch": boolean;
305
309
  /**
306
- * Valor selecionado no campo
310
+ * Define o valor do campo.
307
311
  */
308
312
  "value": IOption | string;
309
313
  }
310
314
  interface EzDateInput {
311
315
  /**
312
- * Deixa o campo disponível ou não para uso.
316
+ * Se false o usuário não pode interagir com o campo.
313
317
  */
314
318
  "enabled": boolean;
315
319
  /**
316
- * Quando um problema de validação, serve como orientação ao usuário
320
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
317
321
  */
318
322
  "errorMessage": string;
319
323
  /**
320
- * Retorna informando se o campo está inválido (true | false)
324
+ * Retorna se o conteúdo é inválido.
321
325
  */
322
326
  "isInvalid": () => Promise<boolean>;
323
327
  /**
324
- * Título do campo
328
+ * Texto a ser apresentado como título do campo.
325
329
  */
326
330
  "label": string;
327
331
  /**
328
- * Define o modo do tamanho do campo; opções: slim e regular.
332
+ * Define o tamanho do campo.
329
333
  */
330
- "mode": string;
334
+ "mode": "slim" | "regular";
331
335
  /**
332
- * Remove o foco no componente de data
336
+ * Remove o foco do campo.
333
337
  */
334
338
  "setBlur": () => Promise<void>;
335
339
  /**
336
- * Realiza o foco no componente de data
340
+ * Aplica o foco no campo.
337
341
  */
338
342
  "setFocus": () => Promise<void>;
339
343
  /**
340
- * A data informada pelo usuário
344
+ * Define o valor do campo.
341
345
  */
342
346
  "value": Date;
343
347
  }
344
348
  interface EzDateTimeInput {
345
349
  /**
346
- * Deixa o campo disponível ou não para uso.
350
+ * Se false o usuário não pode interagir com o campo.
347
351
  */
348
352
  "enabled": boolean;
349
353
  /**
350
- * Quando um problema de validação, serve como orientação ao usuário
354
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
351
355
  */
352
356
  "errorMessage": string;
353
357
  /**
354
- * Retorna informando se o campo está inválido (true | false)
358
+ * Retorna se o conteúdo é inválido.
355
359
  */
356
360
  "isInvalid": () => Promise<boolean>;
357
361
  /**
358
- * Título do campo
362
+ * Texto a ser apresentado como título do campo.
359
363
  */
360
364
  "label": string;
361
365
  /**
362
- * Define o modo do tamanho do campo; opções: slim e regular.
366
+ * Define o tamanho do campo.
363
367
  */
364
- "mode": string;
368
+ "mode": "slim" | "regular";
365
369
  /**
366
- * Remove o foco no componente de datetime
370
+ * Remove o foco do campo.
367
371
  */
368
372
  "setBlur": () => Promise<void>;
369
373
  /**
370
- * Realiza o foco no componente de datetime
374
+ * Aplica o foco no campo.
371
375
  */
372
376
  "setFocus": () => Promise<void>;
373
377
  /**
374
- * Exibe ou não os segundos no input
378
+ * Se true considera segundos.
375
379
  */
376
380
  "showSeconds": boolean;
377
381
  /**
378
- * A data informada pelo usuário
382
+ * Define o valor do campo.
379
383
  */
380
384
  "value": Date;
381
385
  }
382
386
  interface EzDialog {
383
387
  /**
384
- * Define se o componente será utilizado no modo de confirmação.
388
+ * Define se o ez-dialog será utilizado no modo de confirmação.
385
389
  */
386
390
  "confirm": boolean;
387
391
  /**
388
- * Define se o componente terá o visual padrão, de erro ou de aviso
392
+ * Define aparência do ez-dialog.
389
393
  */
390
394
  "dialogType": DialogType;
391
395
  /**
392
- * Define o título do componente.
396
+ * Texto a ser apresentado como título do campo.
393
397
  */
394
398
  "ezTitle": string;
395
399
  /**
396
- * Lida com o clique nos botões de dentro do componente.
397
- */
398
- "handleButtonClick": (selectedOption: boolean) => Promise<void>;
399
- /**
400
- * Menssagem exibida dentro do Dialog
400
+ * Define a menssagem exibida no ez-dialog.
401
401
  */
402
402
  "message": string;
403
403
  /**
404
- * Controla a exibição do componente
404
+ * Define se o ez-dialog está aberto.
405
405
  */
406
406
  "opened": boolean;
407
407
  /**
408
- * Define o ícone a ser exibido ao lado do título do componente
408
+ * Define o ícone a ser exibido.
409
409
  */
410
410
  "personalizedIconPath": string;
411
411
  /**
412
- * Faz com que o componente seja exibido.
412
+ * Exibe o ez-dialog.
413
413
  */
414
414
  "show": (title: string, message: string, dialogType: DialogType, confirm: boolean, icon: string, labelCancel: string, labelConfirm: string, btnConfirmDanger: boolean) => Promise<boolean>;
415
415
  }
416
416
  interface EzFilterInput {
417
417
  /**
418
- * Deixa o campo disponível ou não para uso.
418
+ * Se false o usuário não pode interagir com o campo.
419
419
  */
420
420
  "enabled": boolean;
421
421
  /**
422
- * Quando um problema de validação, serve como orientação ao usuário
422
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
423
423
  */
424
424
  "errorMessage": string;
425
425
  /**
426
- * Retorna informando se o campo está inválido (true | false)
426
+ * Retorna se o conteúdo é inválido.
427
427
  */
428
428
  "isInvalid": () => Promise<boolean>;
429
429
  /**
430
- * Título do campo
430
+ * Texto a ser apresentado como título do campo.
431
431
  */
432
432
  "label": string;
433
433
  /**
434
- * Deixa o componente em modo "carregando".
435
- */
436
- "loading": boolean;
437
- /**
438
- * Define o modo do tamanho do campo; opções: slim e regular.
434
+ * Define o tamanho do campo.
439
435
  */
440
- "mode": string;
436
+ "mode": "slim" | "regular";
441
437
  /**
442
- * Restringe o que o usuário pode digitar. Cada caractere digitado será testado e deve estar contido nessa string ou será descartado.
438
+ * Restringe o que o usuário pode digitar.
443
439
  */
444
440
  "restrict": string;
445
441
  /**
446
- * Remove o foco no componente de input
442
+ * Remove o foco do campo.
447
443
  */
448
444
  "setBlur": () => Promise<void>;
449
445
  /**
450
- * Realiza o foco no componente de input
446
+ * Aplica o foco no campo.
451
447
  */
452
448
  "setFocus": () => Promise<void>;
453
449
  /**
454
- * O valor informado pelo usuário
450
+ * Define o valor do campo.
455
451
  */
456
452
  "value": string;
457
453
  }
458
454
  interface EzForm {
459
- "cancel": () => Promise<void>;
460
455
  /**
461
- * Configuração dos campos.
456
+ * Configuração do formulário.
462
457
  */
463
458
  "config": IFormConfig;
464
459
  /**
465
- * Repositório de dados, controla a manipulação dos dados
460
+ * Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos.
466
461
  */
467
462
  "dataUnit": DataUnit;
468
463
  /**
469
- * Validador responsável por checar a integridade das informações do registro
464
+ * Define um validador responsável pela integridade dos registros.
470
465
  */
471
466
  "recordsValidator": IRecordValidator;
472
- "submit": () => Promise<void>;
467
+ /**
468
+ * Realiza validação no conteúdo de todos os campos.
469
+ */
473
470
  "validate": () => Promise<void>;
474
471
  }
475
472
  interface EzGrid {
476
473
  /**
477
474
  * Adiciona item de menu nas colunas.
478
475
  */
479
- "addColumnMenuItem": (label: string, name: string, action: Function) => Promise<any>;
476
+ "addColumnMenuItem": (label: string, name: string, action: Function) => Promise<void>;
480
477
  /**
481
478
  * Configuração de exibição da grade.
482
479
  */
483
480
  "config": IGridConfig;
484
481
  /**
485
- * Repositório de dados, controla a manipulação dos dados.
482
+ * Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos.
486
483
  */
487
484
  "dataUnit": DataUnit;
488
485
  /**
489
- * Método retornar o estado atual das colunas do grid.
486
+ * Obtém a lista de definição de colunas.
490
487
  */
491
488
  "getColumns": () => Promise<Array<EzGridColumn>>;
492
489
  /**
493
- * Método retornar o estado atual das colunas do grid.
490
+ * Obtém o estado atual das colunas.
494
491
  */
495
492
  "getColumnsState": () => Promise<Array<EzGridColumn>>;
496
493
  /**
497
- * Retorna as linhas selecionadas na grade.
494
+ * Obtém as linhas selecionadas.
498
495
  */
499
496
  "getSelection": () => Promise<Array<any>>;
500
497
  /**
501
- * Habilita a seleção de várias linhas
498
+ * Habilita a seleção de várias linhas.
502
499
  */
503
500
  "multipleSelection": boolean;
504
501
  /**
505
- * Método para fazer um filtro rápido na grid.
502
+ * Aplica um filtro rápido.
506
503
  */
507
- "quickFilter": (term: string) => Promise<any>;
504
+ "quickFilter": (term: string) => Promise<void>;
508
505
  /**
509
- * Endereço do servidor. Se informado, o próprio datagrid controlará a obtenção dos dados, anulando a necessidade de acionar o método "setData(data)"
506
+ * Endereço do servidor para obtenção dos dados.
510
507
  */
511
508
  "serverUrl": string;
512
509
  /**
513
- * Método responsável por receber a definição das colunas
510
+ * Aplica a definição de colunas.
514
511
  */
515
- "setColumnsDef": (cols: Array<EzGridColumn>) => Promise<any>;
512
+ "setColumnsDef": (cols: Array<EzGridColumn>) => Promise<void>;
516
513
  /**
517
- * Método responsável por aplicar estado pré-existente nas colunas do grid.
514
+ * Aplica o estado das colunas.
518
515
  */
519
- "setColumnsState": (state: Array<EzGridColumnConfig>) => Promise<any>;
516
+ "setColumnsState": (state: Array<EzGridColumnConfig>) => Promise<void>;
520
517
  /**
521
- * Método de carga dos registros. Os objetos deste array devem conter atributos para as colunas desejadas.
518
+ * Insere os registros no ez-grid.
522
519
  */
523
- "setData": (data: Array<any>) => Promise<any>;
520
+ "setData": (data: Array<any>) => Promise<void>;
524
521
  /**
525
- * Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }
522
+ * Define um `IStatusResolver` responsável pelo estado da coluna de status.
526
523
  */
527
524
  "statusResolver": IStatusResolver;
528
525
  }
529
526
  interface EzIcon {
530
527
  /**
531
- * Path da imagem
528
+ * Define o endereço da imagem quando não contempladas na biblioteca de ícones.
532
529
  */
533
530
  "href": string;
534
531
  /**
535
- * Nome do icone disponível no pacote de fontes [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html)
532
+ * Define o ícone a ser usado da biblioteca de ícones: [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html)
536
533
  */
537
534
  "iconName": string;
538
535
  /**
539
- * Tamanho do ícone
536
+ * Define o tamanho do ícone.
540
537
  */
541
- "size": string;
538
+ "size": "x-small" | "small"| "medium" | "large" | "x-large";
542
539
  }
543
540
  interface EzList {
544
541
  /**
545
- * Responsável por limpar a lista de histórico do componente.
542
+ * Limpa o histórico da lista.
546
543
  */
547
544
  "clearHistory": () => Promise<void>;
548
545
  /**
549
546
  * Define a lista inicial do componente.
550
547
  */
551
- "dataSource": any[];
548
+ "dataSource": Array<ListGroup | ListItem>;
552
549
  /**
553
- * Define se o componente terá o comportamento de arrasto de linhas.
550
+ * Se true habilita `drag and drop` para os itens.
554
551
  */
555
552
  "ezDraggable": boolean;
556
553
  /**
557
- * Define se os items da lista serão selecionáveis.
554
+ * Se true os itens serão selecionáveis.
558
555
  */
559
556
  "ezSelectable": boolean;
560
557
  /**
561
- * Retorna a lista de items conforme o modo de uso.
558
+ * Obtém a lista de items ou grupos.
562
559
  */
563
- "getList": () => Promise<ListItem[] | ListGroup[]>;
560
+ "getList": () => Promise<Array<ListItem | ListGroup>>;
564
561
  /**
565
- * Retorna o item selecionado.
562
+ * Obtém o item selecionado.
566
563
  */
567
- "getSelection": () => Promise<any>;
564
+ "getSelection": () => Promise<ListItem>;
568
565
  /**
569
- * Define se é possível selecionar mais de um registro. /** Função responsável por renderizar um conteúdo dentro do item da lista.
566
+ * Define um `builder` para construir o `HTMLElement` do item da lista.
570
567
  */
571
568
  "itemSlotBuilder": (item: any, group?: any) => HTMLElement;
572
569
  /**
573
- * Responsável por dar um scroll top no componente da lista.
570
+ * Traz o conteúdo da lista para a área visível.
574
571
  */
575
572
  "scrollToTop": () => Promise<void>;
576
573
  /**
577
- * Recebe como argumento um ListItem {label: string} e um booleano que define se o componente deve fazer scroll para exibir o item específico (opcional).
574
+ * Aplica seleção nas linhas da lista.
578
575
  */
579
576
  "setSelection": (selectedItem: ListItem, scrollToOption?: boolean) => Promise<void>;
580
577
  /**
581
- * Define se o componente renderizará os itens separados em grupos..
578
+ * Se true os grupos serão exibidos.
582
579
  */
583
580
  "useGroups": boolean;
584
581
  }
585
582
  interface EzLoadingBar {
583
+ /**
584
+ * Oculta o ez-loading-bar.
585
+ */
586
586
  "hide": () => Promise<void>;
587
+ /**
588
+ * Exibe o ez-loading-bar.
589
+ */
587
590
  "show": () => Promise<void>;
588
591
  }
589
592
  interface EzModal {
590
593
  /**
591
- * Define o alinhamento do modal. Seus valores podem ser "right" ou "left"
594
+ * Define o alinhamento do ez-modal.
592
595
  */
593
- "align": string;
596
+ "align": "right" | "left";
594
597
  /**
595
- * Define se o modal será fechado ao clicar ESC
598
+ * Define se o ez-modal será fechado ao clicar `ESC`.
596
599
  */
597
600
  "closeEsc": boolean;
598
601
  /**
@@ -600,165 +603,165 @@ export namespace Components {
600
603
  */
601
604
  "closeOutsideClick": boolean;
602
605
  /**
603
- * Define o tamanho do modal. Devem ser utilizados os tamanhos definidos de colunas como "col-sd-3"
606
+ * Define o tamanho do ez-modal. Devem ser definidas seguindo grid-layout. Exemplo: `col-sd-3`.
604
607
  */
605
608
  "modalSize": string;
606
609
  /**
607
- * Controle de exibição do Modal
610
+ * Define se o ez-modal está aberto.
608
611
  */
609
612
  "opened": boolean;
610
613
  }
611
614
  interface EzModalContainer {
612
615
  /**
613
- * Determina o texto do botão de cancelar
616
+ * Define o texto do botão de cancelamento.
614
617
  */
615
618
  "cancelButtonLabel": string;
616
619
  /**
617
- * Variação de estado do botão de cancelar: [HIDDEN|ENABLED|DISABLED]
620
+ * Define o estado do botão de cancelamento.
618
621
  */
619
- "cancelButtonStatus": string;
622
+ "cancelButtonStatus": "HIDDEN"|"ENABLED"|"DISABLED";
620
623
  /**
621
- * Subtítulo (opcional), geralmente usado para orientação do usuário
624
+ * Texto do subtítulo, geralmente usado para orientação do usuário.
622
625
  */
623
626
  "modalSubTitle": string;
624
627
  /**
625
- * Título do modal
628
+ * Texto a ser apresentado como título do modal.
626
629
  */
627
630
  "modalTitle": string;
628
631
  /**
629
- * Determina o texto do botão de Ok
632
+ * Determina o texto do botão de confirmação.
630
633
  */
631
634
  "okButtonLabel": string;
632
635
  /**
633
- * Variação de estado do botão de ok: [HIDDEN|ENABLED|DISABLED]
636
+ * Define o estado do botão de confirmação.
634
637
  */
635
- "okButtonStatus": string;
638
+ "okButtonStatus": "HIDDEN"|"ENABLED"|"DISABLED";
636
639
  /**
637
- * Determina se o cabeçalho com o título deverá ser mostrado
640
+ * Define se o cabeçalho será mostrado.
638
641
  */
639
642
  "showTitleBar": boolean;
640
643
  }
641
644
  interface EzNumberInput {
642
645
  /**
643
- * Deixa o campo disponível ou não para uso.
646
+ * Se false, o usuário não pode interagir com o campo.
644
647
  */
645
648
  "enabled": boolean;
646
649
  /**
647
- * Quando um problema de validação, serve como orientação ao usuário
650
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
648
651
  */
649
652
  "errorMessage": string;
650
653
  /**
651
- * Retorna informando se o campo está inválido (true | false)
654
+ * Retorna se o conteúdo é inválido.
652
655
  */
653
656
  "isInvalid": () => Promise<boolean>;
654
657
  /**
655
- * Título do campo
658
+ * Texto a ser apresentado como título do campo.
656
659
  */
657
660
  "label": string;
658
661
  /**
659
- * Define o modo do tamanho do campo; opções: slim e regular.
662
+ * Define o tamanho do campo.
660
663
  */
661
- "mode": string;
664
+ "mode": "slim" | "regular";
662
665
  /**
663
- * Precisão decimal, ou seja, quantas casas decimais podem ser exibidas. Caso a quantidade de casas decimais do valor seja maior que precision, haverá arredondamento
666
+ * Define quantas casas decimais serão exibidas. Caso haja mais casas haverá arredondamento.
664
667
  */
665
668
  "precision": number;
666
669
  /**
667
- * Esse atributo determina qual é o número mínimo de casas depois da vírgula. Exemplo: Digamos que a precision seja igual a 4, assim qualquer número será representado com 4 casas decimais mesmo que iguais a zero: 1,0100. Se prettiprecision igual a 2, como não há necessidade de mais de duas casas decimais o valor exibido será 1,01. Por outro lado, até a quarta casa não haverá arredondamento (1,1234 = 1,1234) mas a partir da quinta casa sim (1,12345 = 1,1235).
670
+ * Define qual é o mínimo de casas depois da vírgula. Exemplo: 1,1 será exibido como 1,1000 quando `prettyPrecision = 4`.
668
671
  */
669
672
  "prettyPrecision": number;
670
673
  /**
671
- * Remove o foco no componente de input
674
+ * Remove o foco do campo.
672
675
  */
673
676
  "setBlur": () => Promise<void>;
674
677
  /**
675
- * Realiza o foco no componente de input
678
+ * Aplica o foco no campo.
676
679
  */
677
680
  "setFocus": () => Promise<void>;
678
681
  /**
679
- * O valor informado pelo usuário
682
+ * Define o valor do campo.
680
683
  */
681
684
  "value": number;
682
685
  }
683
686
  interface EzPopover {
684
687
  /**
685
- * No modo floating = false o popover só se tornará visível quando o método show() for acionado.
688
+ * Define que será fechado automaticamente quando o usuário clicar fora do conteúdo.
686
689
  */
687
690
  "autoClose": boolean;
688
691
  /**
689
- * Offset bottom do popover em relação ao componente pai
692
+ * Define a distância de baixo. Devem ser usados valores válidos de CSS.
690
693
  */
691
694
  "bottom": string;
692
695
  /**
693
- * Ajusta o comportamento da largura do popover. Opções: "100% e "fit-content" (default)
696
+ * Ajusta o comportamento da largura do popover.
694
697
  */
695
- "boxWidth": string;
698
+ "boxWidth": "full-width" | "fit-content";
696
699
  /**
697
- * Usado no modo floating. Faz com que o componente seja ocultado.
700
+ * Oculta o ez-popover.
698
701
  */
699
702
  "hide": () => Promise<void>;
700
703
  /**
701
- * Array de componente(s) que irá(ão) abrir o popover.
704
+ * Define as tags que serão consideradas conteúdo.
702
705
  */
703
706
  "innerElement": Array<string> | string;
704
707
  /**
705
- * Offset left do popover em relação ao componente pai
708
+ * Define a distância do lado esquerdo. Devem ser usados valores válidos de CSS.
706
709
  */
707
710
  "left": string;
708
711
  /**
709
- * Externaliza estado atual do componente.
712
+ * Define se o ez-popover está aberto.
710
713
  */
711
714
  "opened": boolean;
712
715
  /**
713
- * Offset right do popover em relação ao componente pai
716
+ * Define a distância do lado direito. Devem ser usados valores válidos de CSS.
714
717
  */
715
718
  "right": string;
716
719
  /**
717
- * Faz com que o popover seja renderizado na DOM.
720
+ * Exibe o ez-popover.
718
721
  */
719
722
  "show": (top?: string, left?: string, bottom?: string, right?: string) => Promise<void>;
720
723
  /**
721
- * Offset top do popover em relação ao componente pai
724
+ * Define a distância do topo. Devem ser usados valores válidos de CSS.
722
725
  */
723
726
  "top": string;
724
727
  /**
725
- * Atualiza a posição do popover em relação ao componente pai.
728
+ * Atualiza a posição do popover.
726
729
  */
727
730
  "updatePosition": (top?: string, left?: string, bottom?: string, right?: string) => Promise<void>;
728
731
  }
729
732
  interface EzPopup {
730
733
  /**
731
- * Título do componente.
734
+ * Texto a ser apresentado como título do componente.
732
735
  */
733
736
  "ezTitle": string;
734
737
  /**
735
- * Define se o componente utilizará um cabeçalho com botão de fechamento.
738
+ * Define altura do componente.
736
739
  */
737
- "heightMode": string;
740
+ "heightMode": "auto" | "full";
738
741
  /**
739
- * Controla a exibição do componente.
742
+ * Define se o ez-popover está aberto.
740
743
  */
741
744
  "opened": boolean;
742
745
  /**
743
- * Define o width que o componente deve ter, seguindo o grid system. Os valores devem estar compreendidos em [x-small | small | medium | large | x-large].
746
+ * Define a largura do ez-popup.
744
747
  */
745
- "size": string;
748
+ "size": "x-small" | "small" | "medium" | "large" | "x-large";
746
749
  /**
747
- * Define se o componente utilizará um cabeçalho com botão de fechamento.
750
+ * Define se o componente utilizará cabeçalho.
748
751
  */
749
752
  "useHeader": boolean;
750
753
  }
751
754
  interface EzRadioButton {
752
755
  /**
753
- * Define a direção em que os itens são apresentadoss, podendo ser horizontal ou vertical.
756
+ * Define a direção dos itens.
754
757
  */
755
758
  "direction": "vertical" | "horizontal";
756
759
  /**
757
- * Define se o componente está habilitado ou desabilitado
760
+ * Se false o usuário não pode interagir com o campo.
758
761
  */
759
762
  "enabled": boolean;
760
763
  /**
761
- * Determina a descrição do grupo
764
+ * Texto a ser apresentado como título do campo.
762
765
  */
763
766
  "label": string;
764
767
  /**
@@ -766,71 +769,71 @@ export namespace Components {
766
769
  */
767
770
  "options": Array<Radio>;
768
771
  /**
769
- * Representa o valor atualmente selecionado entre as opções
772
+ * Define o valor do campo.
770
773
  */
771
774
  "value": any;
772
775
  }
773
776
  interface EzScroller {
774
777
  /**
775
- * Determina de o efeito de sombreado está ativo.
778
+ * Define se haverá efeito de sombreado.
776
779
  */
777
780
  "activeShadow": boolean;
778
781
  /**
779
- * Determina se haverá scroll na direção Vertical, Horizontal ou Ambos. Por padrão, a direção é "Ambos".
782
+ * Define a direção em que haverá scroll.
780
783
  */
781
784
  "direction": EzScrollDirection;
782
785
  /**
783
- * Determina se o scroll estará bloqueado quando necessário.
786
+ * Define se o `scroll` estará bloqueado.
784
787
  */
785
788
  "locked": boolean;
786
789
  }
787
790
  interface EzSearch {
788
791
  /**
789
- * Deixa o campo disponível ou não.
792
+ * Se false o usuário não pode interagir com o campo.
790
793
  */
791
794
  "enabled": boolean;
792
795
  /**
793
- * Quando um problema de validação, serve como orientação ao usuário
796
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
794
797
  */
795
798
  "errorMessage": string;
796
799
  /**
797
- * Retorna informando se o campo está inválido (true | false)
800
+ * Retorna se o conteúdo é inválido.
798
801
  */
799
802
  "isInvalid": () => Promise<boolean>;
800
803
  /**
801
- * Título do campo
804
+ * Texto a ser apresentado como título do campo.
802
805
  */
803
806
  "label": string;
804
807
  /**
805
- * Define o modo do tamanho do campo; opções: slim e regular.
808
+ * Define o tamanho do campo.
806
809
  */
807
- "mode": string;
810
+ "mode": "slim" | "regular";
808
811
  /**
809
- * Função responsável por carregar as opções dinamicamente
812
+ * Carrega as opções dinamicamente.
810
813
  */
811
- "optionLoader": Function;
814
+ "optionLoader": (argument: ISearchArgument) => Promise<Array<IOption>> | Array<IOption> | IOption;
812
815
  /**
813
- * Remove o foco no componente de pesquisa
816
+ * Remove o foco do campo.
814
817
  */
815
818
  "setBlur": () => Promise<void>;
816
819
  /**
817
- * Realiza o foco no componente de pesquisa
820
+ * Aplica o foco no campo.
818
821
  */
819
822
  "setFocus": () => Promise<void>;
820
823
  /**
821
- * Ajusta a opção de mostrar o "value" para cada opção.
824
+ * Se false cada opção na lista deve exibir somente o `label`.
822
825
  */
823
826
  "showOptionValue": boolean;
824
827
  /**
825
- * Ajusta a opção de mostrar o "value" ao selecionar uma opção.
828
+ * Se false a opção selecionada deve exibir somente o `label`.
826
829
  */
827
830
  "showSelectedValue": boolean;
828
831
  /**
829
- * Remove a opção vazia da lista de opções
832
+ * Se true remove a opção vazia da lista.
830
833
  */
831
834
  "suppressEmptyOption": boolean;
832
835
  /**
833
- * Código do registro selecionado
836
+ * Define o valor do campo.
834
837
  */
835
838
  "value": IOption | string;
836
839
  }
@@ -844,195 +847,187 @@ export namespace Components {
844
847
  */
845
848
  "selectedTab": string;
846
849
  /**
847
- * Define o nome das abas do componente, separadas por vírgulas ",". Opcionalmente pode-se construir um array de objetos do tipo Tab, nesse caso o tabKey e o índice serão respeitados.
850
+ * Define o nome das abas do componente. Podendo serem separadas por vírgula "," ou em um Array de configuração.
848
851
  */
849
852
  "tabs": string | Array<Tab>;
850
853
  }
851
854
  interface EzTextArea {
852
855
  /**
853
- * Permite exibir a mensagem de erro.
856
+ * Se false deixa de exibir a mensagem de erro dentro do campo.
854
857
  */
855
858
  "canShowError": boolean;
856
859
  /**
857
- * Deixa o campo disponível ou não para digitação.
860
+ * Se false o usuário não pode interagir com o campo.
858
861
  */
859
862
  "enabled": boolean;
860
863
  /**
861
- * Quando um problema de validação, serve como orientação ao usuário
864
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
862
865
  */
863
866
  "errorMessage": string;
864
867
  /**
865
- * Retorna informando se o campo está inválido (true | false)
868
+ * Retorna se o conteúdo é inválido.
866
869
  */
867
870
  "isInvalid": () => Promise<boolean>;
868
871
  /**
869
- * Título do campo
872
+ * Texto a ser apresentado como título do campo.
870
873
  */
871
874
  "label": string;
872
875
  /**
873
- * Deixa o componente em modo "carregando".
874
- */
875
- "loading": boolean;
876
- /**
877
- * Define o modo do tamanho do campo; opções: slim e regular.
876
+ * Define o tamanho do campo.
878
877
  */
879
- "mode": string;
878
+ "mode": "slim" | "regular";
880
879
  /**
881
- * Ajusta o número de linhas e consequentemente o height do textarea. Valor default: 4
880
+ * Define o número de linhas.
882
881
  */
883
882
  "rows": number;
884
883
  /**
885
- * Remove o foco no componente de input
884
+ * Remove o foco do campo.
886
885
  */
887
886
  "setBlur": () => Promise<void>;
888
887
  /**
889
- * Faz o foco no componente de input
888
+ * Aplica o foco no campo.
890
889
  */
891
890
  "setFocus": () => Promise<void>;
892
891
  /**
893
- * Valor digitado pelo usuário. Este valor é o que fica visível no campo.
892
+ * Define o valor do campo.
894
893
  */
895
894
  "value": string;
896
895
  }
897
896
  interface EzTextEdit {
898
897
  /**
899
- * Aplica focus no campo.
898
+ * Aplica foco no campo.
900
899
  */
901
900
  "applyFocusSelect": () => Promise<void>;
902
901
  /**
903
- * Define atributos do estilo
902
+ * Define atributos do estilo.
904
903
  */
905
904
  "styled": IStyled;
906
905
  /**
907
- * Valor manipulado pelo componente através do input
906
+ * Define o valor do campo.
908
907
  */
909
908
  "value": string;
910
909
  }
911
910
  interface EzTextInput {
912
911
  /**
913
- * Permite exibir a mensagem de erro.
912
+ * Se false deixa de exibir a mensagem de erro dentro do campo.
914
913
  */
915
914
  "canShowError": boolean;
916
915
  /**
917
- * Deixa o campo disponível ou não para digitação.
916
+ * Se false o usuário não pode interagir com o campo.
918
917
  */
919
918
  "enabled": boolean;
920
919
  /**
921
- * Quando um problema de validação, serve como orientação ao usuário
920
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
922
921
  */
923
922
  "errorMessage": string;
924
923
  /**
925
- * Retorna informando se o campo está inválido (true | false)
924
+ * Retorna se o conteúdo é inválido.
926
925
  */
927
926
  "isInvalid": () => Promise<boolean>;
928
927
  /**
929
- * Título do campo
928
+ * Texto a ser apresentado como título do campo.
930
929
  */
931
930
  "label": string;
932
- /**
933
- * Deixa o componente em modo "carregando".
934
- */
935
- "loading": boolean;
936
931
  /**
937
932
  * Aplica uma máscara no conteúdo conforme o padrão estabelecido
938
933
  */
939
934
  "mask": string;
940
935
  /**
941
- * Define o modo do tamanho do campo; opções: slim e regular.
936
+ * Define o tamanho do campo.
942
937
  */
943
- "mode": string;
938
+ "mode": "slim" | "regular";
944
939
  /**
945
- * Define se o campo contará com bordas ou não
940
+ * Se true o campo não terá bordas.
946
941
  */
947
942
  "noBorder": boolean;
948
943
  /**
949
- * Restringe o que o usuário pode digitar. Cada caractere digitado será testado e deve estar contido nessa string ou será descartado.
944
+ * Restringe o que o usuário pode digitar.
950
945
  */
951
946
  "restrict": string;
952
947
  /**
953
- * Remove o foco no componente de input
948
+ * Remove o foco do campo.
954
949
  */
955
950
  "setBlur": () => Promise<void>;
956
951
  /**
957
- * Faz o foco no componente de input
952
+ * Aplica o foco no campo.
958
953
  */
959
954
  "setFocus": () => Promise<void>;
960
955
  /**
961
- * Valor digitado pelo usuário. Este valor é o que fica visível no campo.
956
+ * Define o valor do campo.
962
957
  */
963
958
  "value": string;
964
959
  }
965
960
  interface EzTimeInput {
966
961
  /**
967
- * Deixa o campo disponível ou não para digitação.
962
+ * Se false o usuário não pode interagir com o campo.
968
963
  */
969
964
  "enabled": boolean;
970
965
  /**
971
- * Quando um problema de validação, serve como orientação ao usuário.
966
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
972
967
  */
973
968
  "errorMessage": string;
974
969
  /**
975
- * Retorna informando se o campo está inválido (true | false)
970
+ * Retorna se o conteúdo é inválido.
976
971
  */
977
972
  "isInvalid": () => Promise<boolean>;
978
973
  /**
979
- * Título do campo
974
+ * Texto a ser apresentado como título do campo.
980
975
  */
981
976
  "label": string;
982
977
  /**
983
- * Define o modo do tamanho do campo; opções: slim e regular.
978
+ * Define o tamanho do campo.
984
979
  */
985
- "mode": string;
980
+ "mode": "slim" | "regular";
986
981
  /**
987
- * Remove o foco no componente de input
982
+ * Remove o foco do campo.
988
983
  */
989
984
  "setBlur": () => Promise<void>;
990
985
  /**
991
- * Faz o foco no componente de input
986
+ * Aplica o foco no campo.
992
987
  */
993
988
  "setFocus": () => Promise<void>;
994
989
  /**
995
- * Define se o componente irá ou não considerar os segundos.
990
+ * Se true considera segundos.
996
991
  */
997
992
  "showSeconds": boolean;
998
993
  /**
999
- * Valor que será transmitido para o back-end.
994
+ * Define o valor do campo.
1000
995
  */
1001
996
  "value": number;
1002
997
  }
1003
998
  interface EzToast {
1004
999
  /**
1005
- * Controla o uso do icone de fechar o toast.
1000
+ * Se false, o usuário não consegue fechar.
1006
1001
  */
1007
1002
  "canClose": boolean;
1008
1003
  /**
1009
- * Controla o tempo de exibição do componente em milissegundos.
1004
+ * Define o tempo de exibição em milissegundos.
1010
1005
  */
1011
1006
  "fadeTime": number;
1012
1007
  /**
1013
- * Mensagem exibida no componente.
1008
+ * Mensagem a ser exibida no componente.
1014
1009
  */
1015
1010
  "message": string;
1016
1011
  /**
1017
- * Exibe o componente na tela.
1012
+ * Exibe o ez-toast.
1018
1013
  */
1019
- "show": (message: string, fadeTime: number, useIcon: boolean, canClose?: boolean) => Promise<unknown>;
1014
+ "show": (message: string, fadeTime: number, useIcon: boolean, canClose?: boolean) => Promise<void>;
1020
1015
  /**
1021
- * Adiciona ícone de check no componente.
1016
+ * Se true permite a utilização do slot de ícone.
1022
1017
  */
1023
1018
  "useIcon": boolean;
1024
1019
  }
1025
1020
  interface EzUpload {
1026
1021
  /**
1027
- * Método responsável por adicionar um ou mais arquivos ao componente.
1022
+ * Adiciona arquivos.
1028
1023
  */
1029
1024
  "addFiles": (files: Array<File>) => Promise<void>;
1030
1025
  /**
1031
- * Deixa o campo disponível ou não para digitação.
1026
+ * Se false o usuário não pode interagir com o campo.
1032
1027
  */
1033
1028
  "enabled": boolean;
1034
1029
  /**
1035
- * Título do campo
1030
+ * Texto a ser apresentado como título do campo.
1036
1031
  */
1037
1032
  "label": string;
1038
1033
  /**
@@ -1048,11 +1043,11 @@ export namespace Components {
1048
1043
  */
1049
1044
  "requestHeaders": any;
1050
1045
  /**
1051
- * Remove o foco no componente de upload
1046
+ * Remove o foco do campo.
1052
1047
  */
1053
1048
  "setBlur": () => Promise<void>;
1054
1049
  /**
1055
- * Realiza o foco no componente de upload
1050
+ * Aplica o foco no campo.
1056
1051
  */
1057
1052
  "setFocus": () => Promise<void>;
1058
1053
  /**
@@ -1064,17 +1059,17 @@ export namespace Components {
1064
1059
  */
1065
1060
  "urlUpload": string;
1066
1061
  /**
1067
- * Lista de arquivos que será trafegada entre cliente e servidor
1062
+ * Define o valor do campo.
1068
1063
  */
1069
1064
  "value": Array<EzFile>;
1070
1065
  }
1071
1066
  interface EzViewStack {
1072
1067
  /**
1073
- * Retorna o index que está atualmente ativo e sendo exibido.
1068
+ * Obtem o índice selecionado.
1074
1069
  */
1075
1070
  "getSelectedIndex": () => Promise<number>;
1076
1071
  /**
1077
- * Exibe a aba desejada de acordo com o index passado na tela fazendo com a ativa atual seja removida ou oculta dependendo da hidePolicy.
1072
+ * Exibe a visão de acordo com o índice.
1078
1073
  */
1079
1074
  "show": (index: number) => Promise<void>;
1080
1075
  }
@@ -1324,43 +1319,43 @@ declare global {
1324
1319
  declare namespace LocalJSX {
1325
1320
  interface EzActionsButton {
1326
1321
  /**
1327
- * . Array no formato "{value: string, label: string, iconName: string}" que alimenta a lista de ações.
1322
+ * Define a lista de ações. Os elementos devem obedecer o formato: `{value: string, label: string}`.
1328
1323
  */
1329
1324
  "actions"?: Array<IAction>;
1330
1325
  /**
1331
- * Define se o elemento contará com a seta de orientação.
1326
+ * Se true a seta de ordenação será apresentada.
1332
1327
  */
1333
1328
  "arrowActive"?: boolean;
1334
1329
  /**
1335
- * Define se na opção selecionada apresentará um ícone de check.
1330
+ * Se true o check será apresentado para os itens.
1336
1331
  */
1337
1332
  "checkOption"?: boolean;
1338
1333
  /**
1339
- * Nome do ícone que será apresentado no display do componente.
1334
+ * Define o ícone do componente.
1340
1335
  */
1341
1336
  "displayIcon"?: string;
1342
1337
  /**
1343
- * Deixa o campo disponível ou não para interação com usuário.
1338
+ * Se false o usuário não pode interagir com o componente.
1344
1339
  */
1345
1340
  "enabled"?: boolean;
1346
1341
  /**
1347
- * Define se o background do botão será transparent.
1342
+ * Se true o background será transparent.
1348
1343
  */
1349
1344
  "isTransparent"?: boolean;
1350
1345
  /**
1351
- * Evento que é disparado ao acionar uma ação.
1346
+ * Emitido ao acionar uma ação.
1352
1347
  */
1353
1348
  "onEzAction"?: (event: CustomEvent<IAction>) => void;
1354
1349
  /**
1355
- * Define se o label será apresentado no display do componente.
1350
+ * Se true o label será apresentado.
1356
1351
  */
1357
1352
  "showLabel"?: boolean;
1358
1353
  /**
1359
- * É possível escolher entre [small,medium,large].
1354
+ * Determina o tamanho do ez-action-button.
1360
1355
  */
1361
- "size"?: "small" | "medium" | "large" | undefined;
1356
+ "size"?: "small" | "medium" | "large";
1362
1357
  /**
1363
- * Define qual o value que será selecionado na lista.
1358
+ * Define o valor do componente.
1364
1359
  */
1365
1360
  "value"?: string;
1366
1361
  }
@@ -1372,113 +1367,119 @@ declare namespace LocalJSX {
1372
1367
  }
1373
1368
  interface EzButton {
1374
1369
  /**
1375
- * Deixa o botão disponível ou não para interação com o usuário.
1370
+ * Se false o usuário não pode interagir com o botão.
1376
1371
  */
1377
1372
  "enabled"?: boolean;
1378
1373
  /**
1379
- * Nome do icone disponível no pacote de fontes [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html)
1374
+ * Define o ícone a ser usado da biblioteca de ícones: [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html)
1380
1375
  */
1381
1376
  "iconName"?: string;
1382
1377
  /**
1383
- * Define o icone svg que será utilizado no botão. Esta propriedade é utilizada caso o componente esteja no modo "icon"
1378
+ * Define o caminho usado nos modos `icon` e `label-icon` para imagens não contempladas na biblioteca de ícones.
1384
1379
  */
1385
1380
  "image"?: string;
1386
1381
  /**
1387
- * Texto indicativo da ação do botão.
1382
+ * Texto a ser apresentado como título do botão.
1388
1383
  */
1389
1384
  "label"?: string;
1390
1385
  /**
1391
- * Define o modo de uso do botão; opções: icon, link e regular
1386
+ * Define o modo de uso do botão.
1392
1387
  */
1393
- "mode"?: string;
1388
+ "mode"?: "regular" | "icon" | "link" | "label-icon";
1394
1389
  /**
1395
- * É possível escolher entre [small,medium,large] (somente para os modos "icon" e "link")
1390
+ * Define o tamanho do ez-button.
1396
1391
  */
1397
1392
  "size"?: "small" | "medium" | "large" | undefined;
1398
1393
  }
1399
1394
  interface EzCalendar {
1400
1395
  /**
1401
- * No modo floating o calendário se tornará visível quando o método show() for acionado.
1396
+ * Define se a exibição do ez-calendar será feita pelos métodos `show()` e `hide()`.
1402
1397
  */
1403
1398
  "floating"?: boolean;
1404
1399
  /**
1405
- * Quando o usuário escolhe uma data, esse evento é emitido.
1400
+ * Emitido quando acontece a alteração de valor do calendário.
1406
1401
  */
1407
1402
  "onEzChange"?: (event: CustomEvent<Date>) => void;
1408
1403
  /**
1409
- * Exibe ou não os segundos no calendario
1404
+ * Se true a data considera segundos. Deve ser usado em conjunto com a propriedade `time`.
1410
1405
  */
1411
1406
  "showSeconds"?: boolean;
1412
1407
  /**
1413
- * Exibe ou não as horas e minutos no calendario
1408
+ * Se true a data considera horas e minutos.
1414
1409
  */
1415
1410
  "time"?: boolean;
1416
1411
  /**
1417
- * A data selecionada no calendário
1412
+ * Define o valor do calendário.
1418
1413
  */
1419
1414
  "value"?: Date;
1420
1415
  }
1421
1416
  interface EzCardItem {
1417
+ /**
1418
+ * Determina o conteúdo do card. Deve conter um objeto no formato: `{title: string, key: string, details: any}`.
1419
+ */
1422
1420
  "item"?: CardItem;
1421
+ /**
1422
+ * Emitido sempre que o ez-card é clicado.
1423
+ */
1423
1424
  "onEzClick"?: (event: CustomEvent<CardItem>) => void;
1424
1425
  }
1425
1426
  interface EzCheck {
1426
1427
  /**
1427
- * Deixa o campo disponível ou não para interação com o usuário.
1428
+ * Se false o usuário não pode interagir com o campo.
1428
1429
  */
1429
1430
  "enabled"?: boolean;
1430
1431
  /**
1431
- * Deixa o campo em um estado indeterminado, nem marcado nem desmarcado (não disponível em modo "switch").
1432
+ * Se true ativa o estado indeterminado, nem marcado nem desmarcado (não disponível em modo `switch`).
1432
1433
  */
1433
1434
  "indeterminate"?: boolean;
1434
1435
  /**
1435
- * Título do campo
1436
+ * Texto a ser apresentado como título do campo.
1436
1437
  */
1437
1438
  "label"?: string;
1438
1439
  /**
1439
- * Existem dois modos de visualização: regular e switch. Se esta propriedade for omitida, o componete assume o formato "regular". No modo "regular" a visualização é a tradicional de uma caixinha marcada/desmarcada. No modo "switch" o campo tem uma interface em formato de um pino liga/desliga.
1440
+ * Define o modo de visualização do ez-check.
1440
1441
  */
1441
- "mode"?: string;
1442
+ "mode"?: CheckMode;
1442
1443
  /**
1443
- * Evento disparado ao mudar o estado do check(onEzChange).
1444
+ * Emitido quando acontece a alteração de valor do campo.
1444
1445
  */
1445
1446
  "onEzChange"?: (event: CustomEvent<any>) => void;
1446
1447
  /**
1447
- * Como se trata de um componente binário, o valor alterna entre true e false (marcado / desmarcado)
1448
+ * Define o valor do campo.
1448
1449
  */
1449
1450
  "value"?: boolean;
1450
1451
  }
1451
1452
  interface EzChip {
1452
1453
  /**
1453
- * Deixa o componente disponível ou não para seleção.
1454
+ * Se false o usuário não pode interagir com o ez-chip.
1454
1455
  */
1455
1456
  "enabled"?: boolean;
1456
1457
  /**
1457
- * Título exibido no componente.
1458
+ * Texto a ser apresentado como título do ez-chip.
1458
1459
  */
1459
1460
  "label"?: string;
1460
1461
  /**
1461
- * Define o modo de uso do cjip: label ou action
1462
+ * Define o modo de uso do ez-chip.
1462
1463
  */
1463
1464
  "mode"?: "label" | "action";
1464
1465
  /**
1465
- * Evento disparado ao clicar no chip usando o modo "action" (onActionClick).
1466
+ * Emitido no modo "action" quando o usuário clica no ez-chip.
1466
1467
  */
1467
1468
  "onActionClick"?: (event: CustomEvent<void>) => void;
1468
1469
  /**
1469
- * Evento disparado ao clicar no botão de remoção (onRemoveChip).
1470
+ * Emitido quando o botão de remoção é acionado.
1470
1471
  */
1471
1472
  "onRemoveChip"?: (event: CustomEvent<void>) => void;
1472
1473
  /**
1473
- * Evento disparado quando o estado do componente mudar (onValueChange).
1474
+ * Emitido quando acontece a alteração de valor do ez-chip.
1474
1475
  */
1475
1476
  "onValueChange"?: (event: CustomEvent<boolean>) => void;
1476
1477
  /**
1477
- * Indica se o componente terá a opção de ser removido e qual sua posição: left ou right.
1478
+ * Determina o posicionamento do botão de remover (não disponível no modo `action`). Se não informado, não exibe o botão.
1478
1479
  */
1479
- "removePosition"?: "left" | "right";
1480
+ "removePosition"?: "left" | "right" | undefined;
1480
1481
  /**
1481
- * Indica se o componente está ou não ativado.
1482
+ * Define o valor do ez-chip.
1482
1483
  */
1483
1484
  "value"?: boolean;
1484
1485
  }
@@ -1488,255 +1489,251 @@ declare namespace LocalJSX {
1488
1489
  */
1489
1490
  "conditionalSave"?: Function;
1490
1491
  /**
1491
- * Ativa o ícone para edição do componente.
1492
+ * Se true mostra o ícone para edição do componente.
1492
1493
  */
1493
1494
  "editable"?: boolean;
1494
1495
  /**
1495
- * Define o tamanho do texto e do ícone do componente.
1496
+ * Define o tamanho do texto e do ícone.
1496
1497
  */
1497
1498
  "headerSize"?: "x-small" | "small" | "medium" | "large" | "x-large" | undefined;
1498
1499
  /**
1499
- * Define o local onde o ícone será renderizado.
1500
+ * Define o posicionamento do ícone.
1500
1501
  */
1501
1502
  "iconPlacement"?: "left" | "right";
1502
1503
  /**
1503
- * Título do campo
1504
+ * Texto a ser apresentado como título do componente.
1504
1505
  */
1505
1506
  "label"?: string;
1506
1507
  /**
1507
- * Evento disparado ao mudar o estado do componente (onEzChange).
1508
+ * Emitido quando acontece a alteração de valor do componente.
1508
1509
  */
1509
1510
  "onEzChange"?: (event: CustomEvent<boolean>) => void;
1510
1511
  /**
1511
- * Evento disparado quando o modo de edição da label for aberto e fechado (onEzEditLabelMode).
1512
+ * Emitido quando o modo de edição da label for aberto e fechado (onEzEditLabelMode).
1512
1513
  */
1513
1514
  "onEzEditLabelMode"?: (event: CustomEvent<boolean>) => void;
1514
1515
  /**
1515
- * Evento disparado ao remover o componente (onEzRemove).
1516
+ * Emitido ao remover o componente (onEzRemove).
1516
1517
  */
1517
1518
  "onEzRemove"?: (event: CustomEvent<EzCollapsibleBox>) => void;
1518
1519
  /**
1519
- * Evento disparado ao concluir edição da label (onEzSaveEditLabel).
1520
+ * Emitido ao concluir edição da label (onEzSaveEditLabel).
1520
1521
  */
1521
1522
  "onEzSaveEditLabel"?: (event: CustomEvent<CustomEvent>) => void;
1522
1523
  /**
1523
- * Ativa o ícone para remoção do componente.
1524
+ * Se true mostra o ícone para remoção do componente.
1524
1525
  */
1525
1526
  "removable"?: boolean;
1526
1527
  /**
1527
- * Define se o titulo irá ocupar toda a largura do componente.
1528
+ * Se true o título irá ocupar toda a largura do componente.
1528
1529
  */
1529
1530
  "stretchTitle"?: boolean;
1530
1531
  /**
1531
- * Valor externalizado que garante a exibição ou não do componente.
1532
+ * Define o valor do componente.
1532
1533
  */
1533
1534
  "value"?: boolean;
1534
1535
  }
1535
1536
  interface EzComboBox {
1536
1537
  /**
1537
- * Permite exibir a mensagem de erro.
1538
+ * Se false deixa de exibir a mensagem de erro dentro do campo.
1538
1539
  */
1539
1540
  "canShowError"?: boolean;
1540
1541
  /**
1541
- * Deixa o campo disponível ou não para interação com usuário.
1542
+ * Se false o usuário não pode interagir com o campo.
1542
1543
  */
1543
1544
  "enabled"?: boolean;
1544
1545
  /**
1545
- * Quando um problema de validação, serve como orientação ao usuário
1546
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
1546
1547
  */
1547
1548
  "errorMessage"?: string;
1548
1549
  /**
1549
- * Título do campo
1550
+ * Texto a ser apresentado como título do campo.
1550
1551
  */
1551
1552
  "label"?: string;
1552
1553
  /**
1553
- * Define o modo do tamanho do campo; opções: slim e regular.
1554
+ * Define o tamanho do campo.
1554
1555
  */
1555
- "mode"?: string;
1556
+ "mode"?: "slim" | "regular";
1556
1557
  /**
1557
- * Evento que é disparado ao alterar o valor do componente
1558
+ * Emitido quando acontece a alteração de valor do campo.
1558
1559
  */
1559
1560
  "onEzChange"?: (event: CustomEvent<IOption>) => void;
1560
1561
  /**
1561
- * Função responsável por carregar as opções dinamicamente
1562
+ * Carrega as opções dinamicamente.
1562
1563
  */
1563
- "optionLoader"?: Function;
1564
+ "optionLoader"?: (argument: ISearchArgument) => Promise<Array<IOption>> | Array<IOption> | IOption;
1564
1565
  /**
1565
- * Array no formato "{value: string, label: string}" que alimenta as opções do Combobox
1566
+ * Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`.
1566
1567
  */
1567
1568
  "options"?: Array<IOption>;
1568
1569
  /**
1569
- * Ativa o modo pesquisa do combobox
1570
+ * Se true ativa o modo pesquisa do ez-combo-box.
1570
1571
  */
1571
1572
  "searchMode"?: boolean;
1572
1573
  /**
1573
- * Ajusta a opção de mostrar o "value" para cada opção. Por padrão não mostra
1574
+ * Se true cada opção na lista exibe o `value` junto com `label`.
1574
1575
  */
1575
1576
  "showOptionValue"?: boolean;
1576
1577
  /**
1577
- * Ajusta a opção de mostrar o "value" ao selecionar uma opção. Por padrão não mostra.
1578
+ * Se true a opção selecionada exibe o `value` junto com `label`.
1578
1579
  */
1579
1580
  "showSelectedValue"?: boolean;
1580
1581
  /**
1581
- * Remove a opção vazia da lista de opções
1582
+ * Se true remove a opção vazia da lista.
1582
1583
  */
1583
1584
  "suppressEmptyOption"?: boolean;
1584
1585
  /**
1585
- * Desabilita a digitação dentro do componente.
1586
+ * Se true desabilita a digitação dentro do componente.
1586
1587
  */
1587
1588
  "suppressSearch"?: boolean;
1588
1589
  /**
1589
- * Valor selecionado no campo
1590
+ * Define o valor do campo.
1590
1591
  */
1591
1592
  "value"?: IOption | string;
1592
1593
  }
1593
1594
  interface EzDateInput {
1594
1595
  /**
1595
- * Deixa o campo disponível ou não para uso.
1596
+ * Se false o usuário não pode interagir com o campo.
1596
1597
  */
1597
1598
  "enabled"?: boolean;
1598
1599
  /**
1599
- * Quando um problema de validação, serve como orientação ao usuário
1600
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
1600
1601
  */
1601
1602
  "errorMessage"?: string;
1602
1603
  /**
1603
- * Título do campo
1604
+ * Texto a ser apresentado como título do campo.
1604
1605
  */
1605
1606
  "label"?: string;
1606
1607
  /**
1607
- * Define o modo do tamanho do campo; opções: slim e regular.
1608
+ * Define o tamanho do campo.
1608
1609
  */
1609
- "mode"?: string;
1610
+ "mode"?: "slim" | "regular";
1610
1611
  /**
1611
- * Entre o evento ezStartChange e ezChange, se por algum motivo não foi possível completar a alteração, esse evento é disparado.
1612
+ * Emitido quando não foi possível completar a alteração entre o evento ezStartChange e ezChange.
1612
1613
  */
1613
1614
  "onEzCancelWaitingChange"?: (event: CustomEvent<void>) => void;
1614
1615
  /**
1615
- * Evento disparado ao mudar o estado do componente(onEzChange).
1616
+ * Emitido quando acontece a alteração de valor do campo.
1616
1617
  */
1617
1618
  "onEzChange"?: (event: CustomEvent<Date>) => void;
1618
1619
  /**
1619
- * Evento emitido ao iniciar a alteração (remover ou adicionar um arquivo).
1620
+ * Emitido ao iniciar a alteração (digitação incompleta).
1620
1621
  */
1621
1622
  "onEzStartChange"?: (event: CustomEvent<WaitingChange>) => void;
1622
1623
  /**
1623
- * A data informada pelo usuário
1624
+ * Define o valor do campo.
1624
1625
  */
1625
1626
  "value"?: Date;
1626
1627
  }
1627
1628
  interface EzDateTimeInput {
1628
1629
  /**
1629
- * Deixa o campo disponível ou não para uso.
1630
+ * Se false o usuário não pode interagir com o campo.
1630
1631
  */
1631
1632
  "enabled"?: boolean;
1632
1633
  /**
1633
- * Quando um problema de validação, serve como orientação ao usuário
1634
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
1634
1635
  */
1635
1636
  "errorMessage"?: string;
1636
1637
  /**
1637
- * Título do campo
1638
+ * Texto a ser apresentado como título do campo.
1638
1639
  */
1639
1640
  "label"?: string;
1640
1641
  /**
1641
- * Define o modo do tamanho do campo; opções: slim e regular.
1642
+ * Define o tamanho do campo.
1642
1643
  */
1643
- "mode"?: string;
1644
+ "mode"?: "slim" | "regular";
1644
1645
  /**
1645
- * Entre o evento ezStartChange e ezChange, se por algum motivo não foi possível completar a alteração, esse evento é disparado.
1646
+ * Emitido quando não foi possível completar a alteração entre o evento ezStartChange e ezChange.
1646
1647
  */
1647
1648
  "onEzCancelWaitingChange"?: (event: CustomEvent<void>) => void;
1648
1649
  /**
1649
- * Evento disparado ao mudar o estado do componente(onEzChange).
1650
+ * Emitido quando acontece a alteração de valor do campo.
1650
1651
  */
1651
1652
  "onEzChange"?: (event: CustomEvent<Date>) => void;
1652
1653
  /**
1653
- * Evento emitido ao iniciar a alteração (remover ou adicionar um arquivo).
1654
+ * Emitido ao iniciar a alteração (digitação incompleta).
1654
1655
  */
1655
1656
  "onEzStartChange"?: (event: CustomEvent<WaitingChange>) => void;
1656
1657
  /**
1657
- * Exibe ou não os segundos no input
1658
+ * Se true considera segundos.
1658
1659
  */
1659
1660
  "showSeconds"?: boolean;
1660
1661
  /**
1661
- * A data informada pelo usuário
1662
+ * Define o valor do campo.
1662
1663
  */
1663
1664
  "value"?: Date;
1664
1665
  }
1665
1666
  interface EzDialog {
1666
1667
  /**
1667
- * Define se o componente será utilizado no modo de confirmação.
1668
+ * Define se o ez-dialog será utilizado no modo de confirmação.
1668
1669
  */
1669
1670
  "confirm"?: boolean;
1670
1671
  /**
1671
- * Define se o componente terá o visual padrão, de erro ou de aviso
1672
+ * Define aparência do ez-dialog.
1672
1673
  */
1673
1674
  "dialogType"?: DialogType;
1674
1675
  /**
1675
- * Define o título do componente.
1676
+ * Texto a ser apresentado como título do campo.
1676
1677
  */
1677
1678
  "ezTitle"?: string;
1678
1679
  /**
1679
- * Menssagem exibida dentro do Dialog
1680
+ * Define a menssagem exibida no ez-dialog.
1680
1681
  */
1681
1682
  "message"?: string;
1682
1683
  /**
1683
- * Evento disparado ao clicar no botão de aceitação.
1684
+ * Emitido ao confirmar o ez-dialog.
1684
1685
  */
1685
1686
  "onEzAccept"?: (event: CustomEvent<boolean>) => void;
1686
1687
  /**
1687
- * Evento disparado ao clicar tanto no botão de negação quanto no X.
1688
+ * Emitido ao cancelar o ez-dialog.
1688
1689
  */
1689
1690
  "onEzCancel"?: (event: CustomEvent<boolean>) => void;
1690
1691
  /**
1691
- * Controla a exibição do componente
1692
+ * Define se o ez-dialog está aberto.
1692
1693
  */
1693
1694
  "opened"?: boolean;
1694
1695
  /**
1695
- * Define o ícone a ser exibido ao lado do título do componente
1696
+ * Define o ícone a ser exibido.
1696
1697
  */
1697
1698
  "personalizedIconPath"?: string;
1698
1699
  }
1699
1700
  interface EzFilterInput {
1700
1701
  /**
1701
- * Deixa o campo disponível ou não para uso.
1702
+ * Se false o usuário não pode interagir com o campo.
1702
1703
  */
1703
1704
  "enabled"?: boolean;
1704
1705
  /**
1705
- * Quando um problema de validação, serve como orientação ao usuário
1706
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
1706
1707
  */
1707
1708
  "errorMessage"?: string;
1708
1709
  /**
1709
- * Título do campo
1710
+ * Texto a ser apresentado como título do campo.
1710
1711
  */
1711
1712
  "label"?: string;
1712
1713
  /**
1713
- * Deixa o componente em modo "carregando".
1714
+ * Define o tamanho do campo.
1714
1715
  */
1715
- "loading"?: boolean;
1716
+ "mode"?: "slim" | "regular";
1716
1717
  /**
1717
- * Define o modo do tamanho do campo; opções: slim e regular.
1718
- */
1719
- "mode"?: string;
1720
- /**
1721
- * Evento disparado quando o estado do componente é alterado (onEzChange).
1718
+ * Emitido quando acontece a alteração de valor do campo.
1722
1719
  */
1723
1720
  "onEzChange"?: (event: CustomEvent<string>) => void;
1724
1721
  /**
1725
- * Restringe o que o usuário pode digitar. Cada caractere digitado será testado e deve estar contido nessa string ou será descartado.
1722
+ * Restringe o que o usuário pode digitar.
1726
1723
  */
1727
1724
  "restrict"?: string;
1728
1725
  /**
1729
- * O valor informado pelo usuário
1726
+ * Define o valor do campo.
1730
1727
  */
1731
1728
  "value"?: string;
1732
1729
  }
1733
1730
  interface EzForm {
1734
1731
  /**
1735
- * Configuração dos campos.
1732
+ * Configuração do formulário.
1736
1733
  */
1737
1734
  "config"?: IFormConfig;
1738
1735
  /**
1739
- * Repositório de dados, controla a manipulação dos dados
1736
+ * Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos.
1740
1737
  */
1741
1738
  "dataUnit"?: DataUnit;
1742
1739
  /**
@@ -1744,7 +1741,7 @@ declare namespace LocalJSX {
1744
1741
  */
1745
1742
  "onEzReady"?: (event: CustomEvent<void>) => void;
1746
1743
  /**
1747
- * Validador responsável por checar a integridade das informações do registro
1744
+ * Define um validador responsável pela integridade dos registros.
1748
1745
  */
1749
1746
  "recordsValidator"?: IRecordValidator;
1750
1747
  }
@@ -1754,75 +1751,75 @@ declare namespace LocalJSX {
1754
1751
  */
1755
1752
  "config"?: IGridConfig;
1756
1753
  /**
1757
- * Repositório de dados, controla a manipulação dos dados.
1754
+ * Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos.
1758
1755
  */
1759
1756
  "dataUnit"?: DataUnit;
1760
1757
  /**
1761
- * Habilita a seleção de várias linhas
1758
+ * Habilita a seleção de várias linhas.
1762
1759
  */
1763
1760
  "multipleSelection"?: boolean;
1764
1761
  /**
1765
- * Evento disparado ao realizar alguma modificação na configuração da grid.
1762
+ * Emitido quando acontece a alteração de configuração do grade.
1766
1763
  */
1767
1764
  "onConfigChange"?: (event: CustomEvent<IGridConfig>) => void;
1768
1765
  /**
1769
- * Evento disparado ao mudar o estado das colunas do grid. Ordenação, largura, etc.
1766
+ * Emitido quando acontece a alteração de estado das colunas do grid: Ordenação, largura, etc.
1770
1767
  */
1771
1768
  "onEzColumnStateChange"?: (event: CustomEvent<EzGridColumStateEvent>) => void;
1772
1769
  /**
1773
- * Evento disparado com o duplo clique de uma linha
1770
+ * Emitido com o duplo clique de uma linha
1774
1771
  */
1775
1772
  "onEzDoubleClick"?: (event: CustomEvent<any>) => void;
1776
1773
  /**
1777
- * Evento disparado ao selecionar linhas da grade.
1774
+ * Emitido quando acontece a alteração de seleção de linhas.
1778
1775
  */
1779
1776
  "onEzSelectionChange"?: (event: CustomEvent<Array<any>>) => void;
1780
1777
  /**
1781
- * Endereço do servidor. Se informado, o próprio datagrid controlará a obtenção dos dados, anulando a necessidade de acionar o método "setData(data)"
1778
+ * Endereço do servidor para obtenção dos dados.
1782
1779
  */
1783
1780
  "serverUrl"?: string;
1784
1781
  /**
1785
- * Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }
1782
+ * Define um `IStatusResolver` responsável pelo estado da coluna de status.
1786
1783
  */
1787
1784
  "statusResolver"?: IStatusResolver;
1788
1785
  }
1789
1786
  interface EzIcon {
1790
1787
  /**
1791
- * Path da imagem
1788
+ * Define o endereço da imagem quando não contempladas na biblioteca de ícones.
1792
1789
  */
1793
1790
  "href"?: string;
1794
1791
  /**
1795
- * Nome do icone disponível no pacote de fontes [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html)
1792
+ * Define o ícone a ser usado da biblioteca de ícones: [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html)
1796
1793
  */
1797
1794
  "iconName"?: string;
1798
1795
  /**
1799
- * Tamanho do ícone
1796
+ * Define o tamanho do ícone.
1800
1797
  */
1801
- "size"?: string;
1798
+ "size"?: "x-small" | "small"| "medium" | "large" | "x-large";
1802
1799
  }
1803
1800
  interface EzList {
1804
1801
  /**
1805
1802
  * Define a lista inicial do componente.
1806
1803
  */
1807
- "dataSource"?: any[];
1804
+ "dataSource"?: Array<ListGroup | ListItem>;
1808
1805
  /**
1809
- * Define se o componente terá o comportamento de arrasto de linhas.
1806
+ * Se true habilita `drag and drop` para os itens.
1810
1807
  */
1811
1808
  "ezDraggable"?: boolean;
1812
1809
  /**
1813
- * Define se os items da lista serão selecionáveis.
1810
+ * Se true os itens serão selecionáveis.
1814
1811
  */
1815
1812
  "ezSelectable"?: boolean;
1816
1813
  /**
1817
- * Define se é possível selecionar mais de um registro. /** Função responsável por renderizar um conteúdo dentro do item da lista.
1814
+ * Define um `builder` para construir o `HTMLElement` do item da lista.
1818
1815
  */
1819
1816
  "itemSlotBuilder"?: (item: any, group?: any) => HTMLElement;
1820
1817
  /**
1821
- * Evento disparado ao modificar ordenação nas linhas da grade.
1818
+ * Emitido quando acontece a alteração de estado da lista.
1822
1819
  */
1823
- "onEzChange"?: (event: CustomEvent<ListItem[] | ListGroup[]>) => void;
1820
+ "onEzChange"?: (event: CustomEvent<Array<ListItem|ListGroup>>) => void;
1824
1821
  /**
1825
- * Define se o componente renderizará os itens separados em grupos..
1822
+ * Se true os grupos serão exibidos.
1826
1823
  */
1827
1824
  "useGroups"?: boolean;
1828
1825
  }
@@ -1830,11 +1827,11 @@ declare namespace LocalJSX {
1830
1827
  }
1831
1828
  interface EzModal {
1832
1829
  /**
1833
- * Define o alinhamento do modal. Seus valores podem ser "right" ou "left"
1830
+ * Define o alinhamento do ez-modal.
1834
1831
  */
1835
- "align"?: string;
1832
+ "align"?: "right" | "left";
1836
1833
  /**
1837
- * Define se o modal será fechado ao clicar ESC
1834
+ * Define se o ez-modal será fechado ao clicar `ESC`.
1838
1835
  */
1839
1836
  "closeEsc"?: boolean;
1840
1837
  /**
@@ -1842,177 +1839,177 @@ declare namespace LocalJSX {
1842
1839
  */
1843
1840
  "closeOutsideClick"?: boolean;
1844
1841
  /**
1845
- * Define o tamanho do modal. Devem ser utilizados os tamanhos definidos de colunas como "col-sd-3"
1842
+ * Define o tamanho do ez-modal. Devem ser definidas seguindo grid-layout. Exemplo: `col-sd-3`.
1846
1843
  */
1847
1844
  "modalSize"?: string;
1848
1845
  /**
1849
- * Um evento disparado quando o modal é fechado (onEzCloseModal).
1846
+ * Emitido quando o modal é fechado.
1850
1847
  */
1851
1848
  "onEzCloseModal"?: (event: CustomEvent<boolean>) => void;
1852
1849
  /**
1853
- * Um evento disparado quando o modal é aberto (onEzOpenModal).
1850
+ * Emitido quando o modal é aberto.
1854
1851
  */
1855
1852
  "onEzOpenModal"?: (event: CustomEvent<any>) => void;
1856
1853
  /**
1857
- * Controle de exibição do Modal
1854
+ * Define se o ez-modal está aberto.
1858
1855
  */
1859
1856
  "opened"?: boolean;
1860
1857
  }
1861
1858
  interface EzModalContainer {
1862
1859
  /**
1863
- * Determina o texto do botão de cancelar
1860
+ * Define o texto do botão de cancelamento.
1864
1861
  */
1865
1862
  "cancelButtonLabel"?: string;
1866
1863
  /**
1867
- * Variação de estado do botão de cancelar: [HIDDEN|ENABLED|DISABLED]
1864
+ * Define o estado do botão de cancelamento.
1868
1865
  */
1869
- "cancelButtonStatus"?: string;
1866
+ "cancelButtonStatus"?: "HIDDEN"|"ENABLED"|"DISABLED";
1870
1867
  /**
1871
- * Subtítulo (opcional), geralmente usado para orientação do usuário
1868
+ * Texto do subtítulo, geralmente usado para orientação do usuário.
1872
1869
  */
1873
1870
  "modalSubTitle"?: string;
1874
1871
  /**
1875
- * Título do modal
1872
+ * Texto a ser apresentado como título do modal.
1876
1873
  */
1877
1874
  "modalTitle"?: string;
1878
1875
  /**
1879
- * Determina o texto do botão de Ok
1876
+ * Determina o texto do botão de confirmação.
1880
1877
  */
1881
1878
  "okButtonLabel"?: string;
1882
1879
  /**
1883
- * Variação de estado do botão de ok: [HIDDEN|ENABLED|DISABLED]
1880
+ * Define o estado do botão de confirmação.
1884
1881
  */
1885
- "okButtonStatus"?: string;
1882
+ "okButtonStatus"?: "HIDDEN"|"ENABLED"|"DISABLED";
1886
1883
  /**
1887
1884
  * Representa a interação com o usuário. OK - Quando o botão é acionado CANCEL - Quando o botão de cancelar é acionado CLOSE - Quando o botão de fechar é acionado. LOAD - Quando o modal é carregado (eventualmente pode ser usado para dar foco a um elemento específico)
1888
1885
  */
1889
1886
  "onEzModalAction"?: (event: CustomEvent<string>) => void;
1890
1887
  /**
1891
- * Determina se o cabeçalho com o título deverá ser mostrado
1888
+ * Define se o cabeçalho será mostrado.
1892
1889
  */
1893
1890
  "showTitleBar"?: boolean;
1894
1891
  }
1895
1892
  interface EzNumberInput {
1896
1893
  /**
1897
- * Deixa o campo disponível ou não para uso.
1894
+ * Se false, o usuário não pode interagir com o campo.
1898
1895
  */
1899
1896
  "enabled"?: boolean;
1900
1897
  /**
1901
- * Quando um problema de validação, serve como orientação ao usuário
1898
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
1902
1899
  */
1903
1900
  "errorMessage"?: string;
1904
1901
  /**
1905
- * Título do campo
1902
+ * Texto a ser apresentado como título do campo.
1906
1903
  */
1907
1904
  "label"?: string;
1908
1905
  /**
1909
- * Define o modo do tamanho do campo; opções: slim e regular.
1906
+ * Define o tamanho do campo.
1910
1907
  */
1911
- "mode"?: string;
1908
+ "mode"?: "slim" | "regular";
1912
1909
  /**
1913
- * Entre o evento ezStartChange e ezChange, se por algum motivo não foi possível completar a alteração, esse evento é disparado.
1910
+ * Emitido quando não foi possível completar a alteração entre o evento ezStartChange e ezChange.
1914
1911
  */
1915
1912
  "onEzCancelWaitingChange"?: (event: CustomEvent<void>) => void;
1916
1913
  /**
1917
- * Evento disparado quando o estado do componente é alterado (onEzChange).
1914
+ * Emitido quando acontece a alteração de valor do campo.
1918
1915
  */
1919
1916
  "onEzChange"?: (event: CustomEvent<number>) => void;
1920
1917
  /**
1921
- * Evento emitido ao iniciar a alteração (remover ou adicionar um arquivo).
1918
+ * Emitido ao iniciar a alteração (digitação incompleta).
1922
1919
  */
1923
1920
  "onEzStartChange"?: (event: CustomEvent<WaitingChange>) => void;
1924
1921
  /**
1925
- * Precisão decimal, ou seja, quantas casas decimais podem ser exibidas. Caso a quantidade de casas decimais do valor seja maior que precision, haverá arredondamento
1922
+ * Define quantas casas decimais serão exibidas. Caso haja mais casas haverá arredondamento.
1926
1923
  */
1927
1924
  "precision"?: number;
1928
1925
  /**
1929
- * Esse atributo determina qual é o número mínimo de casas depois da vírgula. Exemplo: Digamos que a precision seja igual a 4, assim qualquer número será representado com 4 casas decimais mesmo que iguais a zero: 1,0100. Se prettiprecision igual a 2, como não há necessidade de mais de duas casas decimais o valor exibido será 1,01. Por outro lado, até a quarta casa não haverá arredondamento (1,1234 = 1,1234) mas a partir da quinta casa sim (1,12345 = 1,1235).
1926
+ * Define qual é o mínimo de casas depois da vírgula. Exemplo: 1,1 será exibido como 1,1000 quando `prettyPrecision = 4`.
1930
1927
  */
1931
1928
  "prettyPrecision"?: number;
1932
1929
  /**
1933
- * O valor informado pelo usuário
1930
+ * Define o valor do campo.
1934
1931
  */
1935
1932
  "value"?: number;
1936
1933
  }
1937
1934
  interface EzPopover {
1938
1935
  /**
1939
- * No modo floating = false o popover só se tornará visível quando o método show() for acionado.
1936
+ * Define que será fechado automaticamente quando o usuário clicar fora do conteúdo.
1940
1937
  */
1941
1938
  "autoClose"?: boolean;
1942
1939
  /**
1943
- * Offset bottom do popover em relação ao componente pai
1940
+ * Define a distância de baixo. Devem ser usados valores válidos de CSS.
1944
1941
  */
1945
1942
  "bottom"?: string;
1946
1943
  /**
1947
- * Ajusta o comportamento da largura do popover. Opções: "100% e "fit-content" (default)
1944
+ * Ajusta o comportamento da largura do popover.
1948
1945
  */
1949
- "boxWidth"?: string;
1946
+ "boxWidth"?: "full-width" | "fit-content";
1950
1947
  /**
1951
- * Array de componente(s) que irá(ão) abrir o popover.
1948
+ * Define as tags que serão consideradas conteúdo.
1952
1949
  */
1953
1950
  "innerElement"?: Array<string> | string;
1954
1951
  /**
1955
- * Offset left do popover em relação ao componente pai
1952
+ * Define a distância do lado esquerdo. Devem ser usados valores válidos de CSS.
1956
1953
  */
1957
1954
  "left"?: string;
1958
1955
  /**
1959
- * Evento disparado ao exibir/ocultar o componente.
1956
+ * Emitido quando acontece a alteração de estado do componente.
1960
1957
  */
1961
1958
  "onEzVisibilityChange"?: (event: CustomEvent<boolean>) => void;
1962
1959
  /**
1963
- * Externaliza estado atual do componente.
1960
+ * Define se o ez-popover está aberto.
1964
1961
  */
1965
1962
  "opened"?: boolean;
1966
1963
  /**
1967
- * Offset right do popover em relação ao componente pai
1964
+ * Define a distância do lado direito. Devem ser usados valores válidos de CSS.
1968
1965
  */
1969
1966
  "right"?: string;
1970
1967
  /**
1971
- * Offset top do popover em relação ao componente pai
1968
+ * Define a distância do topo. Devem ser usados valores válidos de CSS.
1972
1969
  */
1973
1970
  "top"?: string;
1974
1971
  }
1975
1972
  interface EzPopup {
1976
1973
  /**
1977
- * Título do componente.
1974
+ * Texto a ser apresentado como título do componente.
1978
1975
  */
1979
1976
  "ezTitle"?: string;
1980
1977
  /**
1981
- * Define se o componente utilizará um cabeçalho com botão de fechamento.
1978
+ * Define altura do componente.
1982
1979
  */
1983
- "heightMode"?: string;
1980
+ "heightMode"?: "auto" | "full";
1984
1981
  /**
1985
- * Evento disparado ao clicar no botão de fechar (onEzClosePopup).
1982
+ * Emitido ao clicar no botão de fechar (onEzClosePopup).
1986
1983
  */
1987
1984
  "onEzClosePopup"?: (event: CustomEvent<any>) => void;
1988
1985
  /**
1989
- * Controla a exibição do componente.
1986
+ * Define se o ez-popover está aberto.
1990
1987
  */
1991
1988
  "opened"?: boolean;
1992
1989
  /**
1993
- * Define o width que o componente deve ter, seguindo o grid system. Os valores devem estar compreendidos em [x-small | small | medium | large | x-large].
1990
+ * Define a largura do ez-popup.
1994
1991
  */
1995
- "size"?: string;
1992
+ "size"?: "x-small" | "small" | "medium" | "large" | "x-large";
1996
1993
  /**
1997
- * Define se o componente utilizará um cabeçalho com botão de fechamento.
1994
+ * Define se o componente utilizará cabeçalho.
1998
1995
  */
1999
1996
  "useHeader"?: boolean;
2000
1997
  }
2001
1998
  interface EzRadioButton {
2002
1999
  /**
2003
- * Define a direção em que os itens são apresentadoss, podendo ser horizontal ou vertical.
2000
+ * Define a direção dos itens.
2004
2001
  */
2005
2002
  "direction"?: "vertical" | "horizontal";
2006
2003
  /**
2007
- * Define se o componente está habilitado ou desabilitado
2004
+ * Se false o usuário não pode interagir com o campo.
2008
2005
  */
2009
2006
  "enabled"?: boolean;
2010
2007
  /**
2011
- * Determina a descrição do grupo
2008
+ * Texto a ser apresentado como título do campo.
2012
2009
  */
2013
2010
  "label"?: string;
2014
2011
  /**
2015
- * Evento disparado quando uma opção for selecionada
2012
+ * Emitido quando acontece a alteração de valor do campo.
2016
2013
  */
2017
2014
  "onEzChange"?: (event: CustomEvent<any>) => void;
2018
2015
  /**
@@ -2020,73 +2017,69 @@ declare namespace LocalJSX {
2020
2017
  */
2021
2018
  "options"?: Array<Radio>;
2022
2019
  /**
2023
- * Representa o valor atualmente selecionado entre as opções
2020
+ * Define o valor do campo.
2024
2021
  */
2025
2022
  "value"?: any;
2026
2023
  }
2027
2024
  interface EzScroller {
2028
2025
  /**
2029
- * Determina de o efeito de sombreado está ativo.
2026
+ * Define se haverá efeito de sombreado.
2030
2027
  */
2031
2028
  "activeShadow"?: boolean;
2032
2029
  /**
2033
- * Determina se haverá scroll na direção Vertical, Horizontal ou Ambos. Por padrão, a direção é "Ambos".
2030
+ * Define a direção em que haverá scroll.
2034
2031
  */
2035
2032
  "direction"?: EzScrollDirection;
2036
2033
  /**
2037
- * Determina se o scroll estará bloqueado quando necessário.
2034
+ * Define se o `scroll` estará bloqueado.
2038
2035
  */
2039
2036
  "locked"?: boolean;
2040
2037
  }
2041
2038
  interface EzSearch {
2042
2039
  /**
2043
- * Deixa o campo disponível ou não.
2040
+ * Se false o usuário não pode interagir com o campo.
2044
2041
  */
2045
2042
  "enabled"?: boolean;
2046
2043
  /**
2047
- * Quando um problema de validação, serve como orientação ao usuário
2044
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
2048
2045
  */
2049
2046
  "errorMessage"?: string;
2050
2047
  /**
2051
- * Título do campo
2048
+ * Texto a ser apresentado como título do campo.
2052
2049
  */
2053
2050
  "label"?: string;
2054
2051
  /**
2055
- * Define o modo do tamanho do campo; opções: slim e regular.
2052
+ * Define o tamanho do campo.
2056
2053
  */
2057
- "mode"?: string;
2054
+ "mode"?: "slim" | "regular";
2058
2055
  /**
2059
- * Um evento disparado quando o estado do componente é alterado (onEzChange).
2056
+ * Emitido quando acontece a alteração de valor do campo.
2060
2057
  */
2061
2058
  "onEzChange"?: (event: CustomEvent<IOption>) => void;
2062
2059
  /**
2063
- * Evento emitido ao clicar para abrir o popup
2064
- */
2065
- "onShowPopup"?: (event: CustomEvent<any>) => void;
2066
- /**
2067
- * Função responsável por carregar as opções dinamicamente
2060
+ * Carrega as opções dinamicamente.
2068
2061
  */
2069
- "optionLoader"?: Function;
2062
+ "optionLoader"?: (argument: ISearchArgument) => Promise<Array<IOption>> | Array<IOption> | IOption;
2070
2063
  /**
2071
- * Ajusta a opção de mostrar o "value" para cada opção.
2064
+ * Se false cada opção na lista deve exibir somente o `label`.
2072
2065
  */
2073
2066
  "showOptionValue"?: boolean;
2074
2067
  /**
2075
- * Ajusta a opção de mostrar o "value" ao selecionar uma opção.
2068
+ * Se false a opção selecionada deve exibir somente o `label`.
2076
2069
  */
2077
2070
  "showSelectedValue"?: boolean;
2078
2071
  /**
2079
- * Remove a opção vazia da lista de opções
2072
+ * Se true remove a opção vazia da lista.
2080
2073
  */
2081
2074
  "suppressEmptyOption"?: boolean;
2082
2075
  /**
2083
- * Código do registro selecionado
2076
+ * Define o valor do campo.
2084
2077
  */
2085
2078
  "value"?: IOption | string;
2086
2079
  }
2087
2080
  interface EzTabselector {
2088
2081
  /**
2089
- * Evento emitido ao clicar para abrir o popup (ezChange). O detail desse evento carrega tanto o tabKey quanto o index da aba selecionada.
2082
+ * Emitido quando acontece a alteração de valor do componente.
2090
2083
  */
2091
2084
  "onEzChange"?: (event: CustomEvent<Tab>) => void;
2092
2085
  /**
@@ -2098,175 +2091,167 @@ declare namespace LocalJSX {
2098
2091
  */
2099
2092
  "selectedTab"?: string;
2100
2093
  /**
2101
- * Define o nome das abas do componente, separadas por vírgulas ",". Opcionalmente pode-se construir um array de objetos do tipo Tab, nesse caso o tabKey e o índice serão respeitados.
2094
+ * Define o nome das abas do componente. Podendo serem separadas por vírgula "," ou em um Array de configuração.
2102
2095
  */
2103
2096
  "tabs"?: string | Array<Tab>;
2104
2097
  }
2105
2098
  interface EzTextArea {
2106
2099
  /**
2107
- * Permite exibir a mensagem de erro.
2100
+ * Se false deixa de exibir a mensagem de erro dentro do campo.
2108
2101
  */
2109
2102
  "canShowError"?: boolean;
2110
2103
  /**
2111
- * Deixa o campo disponível ou não para digitação.
2104
+ * Se false o usuário não pode interagir com o campo.
2112
2105
  */
2113
2106
  "enabled"?: boolean;
2114
2107
  /**
2115
- * Quando um problema de validação, serve como orientação ao usuário
2108
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
2116
2109
  */
2117
2110
  "errorMessage"?: string;
2118
2111
  /**
2119
- * Título do campo
2112
+ * Texto a ser apresentado como título do campo.
2120
2113
  */
2121
2114
  "label"?: string;
2122
2115
  /**
2123
- * Deixa o componente em modo "carregando".
2116
+ * Define o tamanho do campo.
2124
2117
  */
2125
- "loading"?: boolean;
2118
+ "mode"?: "slim" | "regular";
2126
2119
  /**
2127
- * Define o modo do tamanho do campo; opções: slim e regular.
2128
- */
2129
- "mode"?: string;
2130
- /**
2131
- * Evento disparado quando o estado do componente é alterado (onEzChange).
2120
+ * Emitido quando acontece a alteração de valor do campo.
2132
2121
  */
2133
2122
  "onEzChange"?: (event: CustomEvent<string>) => void;
2134
2123
  /**
2135
- * Ajusta o número de linhas e consequentemente o height do textarea. Valor default: 4
2124
+ * Define o número de linhas.
2136
2125
  */
2137
2126
  "rows"?: number;
2138
2127
  /**
2139
- * Valor digitado pelo usuário. Este valor é o que fica visível no campo.
2128
+ * Define o valor do campo.
2140
2129
  */
2141
2130
  "value"?: string;
2142
2131
  }
2143
2132
  interface EzTextEdit {
2144
2133
  /**
2145
- * Disparado ao cancelar uma edição
2134
+ * Emitido ao cancelar uma edição
2146
2135
  */
2147
2136
  "onCancelEdition"?: (event: CustomEvent<any>) => void;
2148
2137
  /**
2149
- * Evento emitido ao salvar uma edição
2138
+ * Emitido ao salvar uma edição
2150
2139
  */
2151
2140
  "onSaveEdition"?: (event: CustomEvent<any>) => void;
2152
2141
  /**
2153
- * Define atributos do estilo
2142
+ * Define atributos do estilo.
2154
2143
  */
2155
2144
  "styled"?: IStyled;
2156
2145
  /**
2157
- * Valor manipulado pelo componente através do input
2146
+ * Define o valor do campo.
2158
2147
  */
2159
2148
  "value"?: string;
2160
2149
  }
2161
2150
  interface EzTextInput {
2162
2151
  /**
2163
- * Permite exibir a mensagem de erro.
2152
+ * Se false deixa de exibir a mensagem de erro dentro do campo.
2164
2153
  */
2165
2154
  "canShowError"?: boolean;
2166
2155
  /**
2167
- * Deixa o campo disponível ou não para digitação.
2156
+ * Se false o usuário não pode interagir com o campo.
2168
2157
  */
2169
2158
  "enabled"?: boolean;
2170
2159
  /**
2171
- * Quando um problema de validação, serve como orientação ao usuário
2160
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
2172
2161
  */
2173
2162
  "errorMessage"?: string;
2174
2163
  /**
2175
- * Título do campo
2164
+ * Texto a ser apresentado como título do campo.
2176
2165
  */
2177
2166
  "label"?: string;
2178
- /**
2179
- * Deixa o componente em modo "carregando".
2180
- */
2181
- "loading"?: boolean;
2182
2167
  /**
2183
2168
  * Aplica uma máscara no conteúdo conforme o padrão estabelecido
2184
2169
  */
2185
2170
  "mask"?: string;
2186
2171
  /**
2187
- * Define o modo do tamanho do campo; opções: slim e regular.
2172
+ * Define o tamanho do campo.
2188
2173
  */
2189
- "mode"?: string;
2174
+ "mode"?: "slim" | "regular";
2190
2175
  /**
2191
- * Define se o campo contará com bordas ou não
2176
+ * Se true o campo não terá bordas.
2192
2177
  */
2193
2178
  "noBorder"?: boolean;
2194
2179
  /**
2195
- * Evento disparado quando o estado do componente é alterado (onEzChange).
2180
+ * Emitido quando acontece a alteração de valor do campo.
2196
2181
  */
2197
2182
  "onEzChange"?: (event: CustomEvent<string>) => void;
2198
2183
  /**
2199
- * Restringe o que o usuário pode digitar. Cada caractere digitado será testado e deve estar contido nessa string ou será descartado.
2184
+ * Restringe o que o usuário pode digitar.
2200
2185
  */
2201
2186
  "restrict"?: string;
2202
2187
  /**
2203
- * Valor digitado pelo usuário. Este valor é o que fica visível no campo.
2188
+ * Define o valor do campo.
2204
2189
  */
2205
2190
  "value"?: string;
2206
2191
  }
2207
2192
  interface EzTimeInput {
2208
2193
  /**
2209
- * Deixa o campo disponível ou não para digitação.
2194
+ * Se false o usuário não pode interagir com o campo.
2210
2195
  */
2211
2196
  "enabled"?: boolean;
2212
2197
  /**
2213
- * Quando um problema de validação, serve como orientação ao usuário.
2198
+ * Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
2214
2199
  */
2215
2200
  "errorMessage"?: string;
2216
2201
  /**
2217
- * Título do campo
2202
+ * Texto a ser apresentado como título do campo.
2218
2203
  */
2219
2204
  "label"?: string;
2220
2205
  /**
2221
- * Define o modo do tamanho do campo; opções: slim e regular.
2206
+ * Define o tamanho do campo.
2222
2207
  */
2223
- "mode"?: string;
2208
+ "mode"?: "slim" | "regular";
2224
2209
  /**
2225
- * Entre o evento ezStartChange e ezChange, se por algum motivo não foi possível completar a alteração, esse evento é disparado.
2210
+ * Emitido quando não foi possível completar a alteração entre o evento ezStartChange e ezChange.
2226
2211
  */
2227
2212
  "onEzCancelWaitingChange"?: (event: CustomEvent<void>) => void;
2228
2213
  /**
2229
- * Evento disparado quando o estado do componente é alterado (onEzChange).
2214
+ * Emitido quando acontece a alteração de valor do campo.
2230
2215
  */
2231
2216
  "onEzChange"?: (event: CustomEvent<number>) => void;
2232
2217
  /**
2233
- * Evento emitido ao iniciar a alteração (remover ou adicionar um arquivo).
2218
+ * Emitido ao iniciar a alteração (digitação incompleta).
2234
2219
  */
2235
2220
  "onEzStartChange"?: (event: CustomEvent<WaitingChange>) => void;
2236
2221
  /**
2237
- * Define se o componente irá ou não considerar os segundos.
2222
+ * Se true considera segundos.
2238
2223
  */
2239
2224
  "showSeconds"?: boolean;
2240
2225
  /**
2241
- * Valor que será transmitido para o back-end.
2226
+ * Define o valor do campo.
2242
2227
  */
2243
2228
  "value"?: number;
2244
2229
  }
2245
2230
  interface EzToast {
2246
2231
  /**
2247
- * Controla o uso do icone de fechar o toast.
2232
+ * Se false, o usuário não consegue fechar.
2248
2233
  */
2249
2234
  "canClose"?: boolean;
2250
2235
  /**
2251
- * Controla o tempo de exibição do componente em milissegundos.
2236
+ * Define o tempo de exibição em milissegundos.
2252
2237
  */
2253
2238
  "fadeTime"?: number;
2254
2239
  /**
2255
- * Mensagem exibida no componente.
2240
+ * Mensagem a ser exibida no componente.
2256
2241
  */
2257
2242
  "message"?: string;
2258
2243
  /**
2259
- * Adiciona ícone de check no componente.
2244
+ * Se true permite a utilização do slot de ícone.
2260
2245
  */
2261
2246
  "useIcon"?: boolean;
2262
2247
  }
2263
2248
  interface EzUpload {
2264
2249
  /**
2265
- * Deixa o campo disponível ou não para digitação.
2250
+ * Se false o usuário não pode interagir com o campo.
2266
2251
  */
2267
2252
  "enabled"?: boolean;
2268
2253
  /**
2269
- * Título do campo
2254
+ * Texto a ser apresentado como título do campo.
2270
2255
  */
2271
2256
  "label"?: string;
2272
2257
  /**
@@ -2278,15 +2263,15 @@ declare namespace LocalJSX {
2278
2263
  */
2279
2264
  "maxFiles"?: number;
2280
2265
  /**
2281
- * Entre o evento ezStartChange e ezChange, se por algum motivo não foi possível completar a alteração, esse evento é disparado.
2266
+ * Emitido quando não foi possível completar a alteração entre o evento ezStartChange e ezChange.
2282
2267
  */
2283
2268
  "onEzCancelWaitingChange"?: (event: CustomEvent<void>) => void;
2284
2269
  /**
2285
- * Evento emitido ao finalizar o upload de um arquivo (onEzChange).
2270
+ * Emitido quando acontece a alteração de valor do campo.
2286
2271
  */
2287
2272
  "onEzChange"?: (event: CustomEvent<Array<EzFile>>) => void;
2288
2273
  /**
2289
- * Evento emitido ao iniciar a alteração (remover ou adicionar um arquivo).
2274
+ * Emitido ao iniciar a alteração (remover ou adicionar um arquivo).
2290
2275
  */
2291
2276
  "onEzStartChange"?: (event: CustomEvent<WaitingChange>) => void;
2292
2277
  /**
@@ -2302,7 +2287,7 @@ declare namespace LocalJSX {
2302
2287
  */
2303
2288
  "urlUpload"?: string;
2304
2289
  /**
2305
- * Lista de arquivos que será trafegada entre cliente e servidor
2290
+ * Define o valor do campo.
2306
2291
  */
2307
2292
  "value"?: Array<EzFile>;
2308
2293
  }