@sankhyalabs/ezui-docs 0.0.0-feat-dev-KB-130570.5 → 0.0.0-feat-dev-KB-134690.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 (14) hide show
  1. package/components/ez-button/readme.md +4 -0
  2. package/components/ez-classic-combo-box/readme.md +1 -0
  3. package/components/ez-classic-text-area/readme.md +20 -19
  4. package/components/ez-form-view/readme.md +2 -0
  5. package/components/ez-grid/readme.md +22 -6
  6. package/components/ez-grid-pagination/readme.md +72 -0
  7. package/components/ez-grid-view/readme.md +7 -3
  8. package/components/ez-icon/readme.md +2 -0
  9. package/components/ez-popover/readme.md +2 -0
  10. package/components/ez-record-navigation/readme.md +58 -0
  11. package/components/ez-search/readme.md +4 -3
  12. package/components/ez-search-plus/readme.md +4 -3
  13. package/components/ez-tooltip/readme.md +2 -0
  14. package/package.json +1 -1
package/components/ez-button/readme.md CHANGED
@@ -56,11 +56,13 @@ Type: `Promise<void>`
56
56
  - [ez-dialog](../ez-dialog)
57
57
  - [ez-double-list](../ez-double-list)
58
58
  - [ez-grid](../ez-grid)
59
+ - [ez-grid-pagination](../ez-grid-pagination)
59
60
  - [ez-guide-navigator](../ez-guide-navigator)
60
61
  - [ez-image-input](../ez-image-input)
61
62
  - [ez-modal-container](../ez-modal-container)
62
63
  - [ez-pagination](../ez-pagination)
63
64
  - [ez-popup](../ez-popup)
65
+ - [ez-record-navigation](../ez-record-navigation)
64
66
  - [ez-search](../ez-search)
65
67
  - [ez-sidebar-navigator](../ez-sidebar-navigator)
66
68
  - [ez-split-item](../ez-split-panel/structure/item)
@@ -82,11 +84,13 @@ graph TD;
82
84
  ez-dialog --> ez-button
83
85
  ez-double-list --> ez-button
84
86
  ez-grid --> ez-button
87
+ ez-grid-pagination --> ez-button
85
88
  ez-guide-navigator --> ez-button
86
89
  ez-image-input --> ez-button
87
90
  ez-modal-container --> ez-button
88
91
  ez-pagination --> ez-button
89
92
  ez-popup --> ez-button
93
+ ez-record-navigation --> ez-button
90
94
  ez-search --> ez-button
91
95
  ez-sidebar-navigator --> ez-button
92
96
  ez-split-item --> ez-button
package/components/ez-classic-combo-box/readme.md CHANGED
@@ -10,6 +10,7 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | --------------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | ----------- |
12
12
  | `enabled` | `enabled` | Define se o combo box está habilitado. | `boolean` | `true` |
13
+ | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
13
14
  | `helpText` | `help-text` | Texto de ajuda exibido abaixo do combo box. | `string` | `undefined` |
14
15
  | `iconClickable` | `icon-clickable` | Define se o ícone é clicável | `boolean` | `false` |
15
16
  | `iconName` | `icon-name` | Nome do ícone. | `string` | `undefined` |
package/components/ez-classic-text-area/readme.md CHANGED
@@ -7,25 +7,26 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------------- | ---------------------- | -------------------------------------------------------------- | ------------------------------------------------ | ---------------------------- |
12
- | `enabled` | `enabled` | Define se a textarea está habilitada | `boolean` | `true` |
13
- | `helpText` | `help-text` | Texto de ajuda exibido abaixo da textarea | `string` | `undefined` |
14
- | `label` | `label` | Texto do rótulo exibido acima da área de texto | `string` | `''` |
15
- | `leftIconClickable` | `left-icon-clickable` | Define se o ícone da esquerda é clicável | `boolean` | `false` |
16
- | `leftIconName` | `left-icon-name` | Nome do ícone à esquerda | `string` | `undefined` |
17
- | `leftIconTooltip` | `left-icon-tooltip` | Título do ícone à esquerda (tooltip) | `string` | `undefined` |
18
- | `maxlength` | `maxlength` | Número máximo de caracteres permitidos | `number` | `undefined` |
19
- | `name` | `name` | Nome da textarea | `string` | `StringUtils.generateUUID()` |
20
- | `placeholder` | `placeholder` | Texto de placeholder exibido quando a área de texto está vazia | `string` | `''` |
21
- | `readonly` | `readonly` | Se a área de texto é somente leitura | `boolean` | `false` |
22
- | `resize` | `resize` | Comportamento de redimensionamento da área de texto | `"both" \| "horizontal" \| "none" \| "vertical"` | `'vertical'` |
23
- | `rightIconClickable` | `right-icon-clickable` | Define se o ícone da direita é clicável | `boolean` | `false` |
24
- | `rightIconName` | `right-icon-name` | Nome do ícone à direita | `string` | `undefined` |
25
- | `rightIconTooltip` | `right-icon-tooltip` | Título do ícone à direita (tooltip) | `string` | `undefined` |
26
- | `rows` | `rows` | Define o número de linhas da área de texto | `number` | `5` |
27
- | `state` | `state` | Estado visual da textarea: default, error, success ou warning | `"default" \| "error" \| "success" \| "warning"` | `"default"` |
28
- | `value` | `value` | Valor atual da área de texto | `string` | `''` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------- | ---------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------ | ---------------------------- |
12
+ | `enabled` | `enabled` | Define se a textarea está habilitada | `boolean` | `true` |
13
+ | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido | `string` | `undefined` |
14
+ | `helpText` | `help-text` | Texto de ajuda exibido abaixo da textarea | `string` | `undefined` |
15
+ | `label` | `label` | Texto do rótulo exibido acima da área de texto | `string` | `''` |
16
+ | `leftIconClickable` | `left-icon-clickable` | Define se o ícone da esquerda é clicável | `boolean` | `false` |
17
+ | `leftIconName` | `left-icon-name` | Nome do ícone à esquerda | `string` | `undefined` |
18
+ | `leftIconTooltip` | `left-icon-tooltip` | Título do ícone à esquerda (tooltip) | `string` | `undefined` |
19
+ | `maxlength` | `maxlength` | Número máximo de caracteres permitidos | `number` | `undefined` |
20
+ | `name` | `name` | Nome da textarea | `string` | `StringUtils.generateUUID()` |
21
+ | `placeholder` | `placeholder` | Texto de placeholder exibido quando a área de texto está vazia | `string` | `''` |
22
+ | `readonly` | `readonly` | Se a área de texto é somente leitura | `boolean` | `false` |
23
+ | `resize` | `resize` | Comportamento de redimensionamento da área de texto | `"both" \| "horizontal" \| "none" \| "vertical"` | `'vertical'` |
24
+ | `rightIconClickable` | `right-icon-clickable` | Define se o ícone da direita é clicável | `boolean` | `false` |
25
+ | `rightIconName` | `right-icon-name` | Nome do ícone à direita | `string` | `undefined` |
26
+ | `rightIconTooltip` | `right-icon-tooltip` | Título do ícone à direita (tooltip) | `string` | `undefined` |
27
+ | `rows` | `rows` | Define o número de linhas da área de texto | `number` | `5` |
28
+ | `state` | `state` | Estado visual da textarea: default, error, success ou warning | `"default" \| "error" \| "success" \| "warning"` | `"default"` |
29
+ | `value` | `value` | Valor atual da área de texto | `string` | `''` |
29
30
 
30
31
 
31
32
  ## Events
package/components/ez-form-view/readme.md CHANGED
@@ -214,6 +214,8 @@ graph TD;
214
214
  | Variable | Description |
215
215
  |-|-|
216
216
  | --ez-form-view\_\_item--min-width | Define o tamanho mínimo dos itens do formulário. |
217
+ | --ez-form-view\_\_long-item--min-width | Define o tamanho mínimo dos itens do formulário. |
217
218
  | --ez-form-view\_\_item--max-width | Define o tamanho máximo dos itens do formulário. |
219
+ | --ez-form-view\_\_long-item--max-width | Define o tamanho máximo dos itens longos do formulário. |
218
220
  | --ez-form-view\_\_item--gap | Define o colunas entre itens do formulário. |
219
221
  | --ez-form-view\_\_item--padding | Define o padding do formulário. |
package/components/ez-grid/readme.md CHANGED
@@ -20,10 +20,11 @@
20
20
  | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
21
21
  | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa inserção de registros no modo grade pela Taskbar. | `boolean` | `true` |
22
22
  | `enableRowTableStriped` | `enable-row-table-striped` | Ativa modo de linhas com cores alternadas. | `boolean` | `true` |
23
+ | `hidePagination` | `hide-pagination` | Esconder paginação. | `boolean` | `false` |
23
24
  | `mode` | `mode` | Define o modo de uso da grade | `"complete" \| "simple"` | `"complete"` |
24
25
  | `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas. | `boolean` | `undefined` |
25
26
  | `outlineMode` | `outline-mode` | Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up) | `boolean` | `false` |
26
- | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
27
+ | `paginationCounterMode` | `pagination-counter-mode` | Define a forma como a paginação irá se comportar. | `"auto" \| "hidden" \| "show"` | `'auto'` |
27
28
  | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
28
29
  | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
29
30
  | `serverUrl` | `server-url` | Endereço do servidor para obtenção dos dados. | `string` | `undefined` |
@@ -160,6 +161,16 @@ Type: `Promise<any[]>`
160
161
 
161
162
  ---
162
163
 
164
+ ### `handlePageChange() => Promise<void>`
165
+
166
+ Manipula a mudança de página da grid.
167
+
168
+ #### Returns
169
+
170
+ Type: `Promise<void>`
171
+
172
+ ---
173
+
163
174
  ### `locateColumn(columnName: string) => Promise<void>`
164
175
 
165
176
  Localiza determinada coluna tornando-a visível.
@@ -269,25 +280,27 @@ Type: `Promise<void>`
269
280
 
270
281
  ### Depends on
271
282
 
283
+ - [filter-column](subcomponents)
284
+ - [ez-grid-pagination](../ez-grid-pagination)
272
285
  - [ez-popover](../ez-popover)
273
- - [ez-icon](../ez-icon)
274
286
  - [ez-button](../ez-button)
275
- - [filter-column](subcomponents)
287
+ - [ez-icon](../ez-icon)
276
288
  - [ez-search](../ez-search)
277
289
 
278
290
  ### Graph
279
291
  ```mermaid
280
292
  graph TD;
293
+ ez-grid --> filter-column
294
+ ez-grid --> ez-grid-pagination
281
295
  ez-grid --> ez-popover
282
- ez-grid --> ez-icon
283
296
  ez-grid --> ez-button
284
- ez-grid --> filter-column
297
+ ez-grid --> ez-icon
285
298
  ez-grid --> ez-search
286
- ez-button --> ez-icon
287
299
  filter-column --> ez-popover-plus
288
300
  filter-column --> ez-button
289
301
  filter-column --> ez-multi-selection-list
290
302
  ez-popover-plus --> ez-popover-core
303
+ ez-button --> ez-icon
291
304
  ez-multi-selection-list --> ez-check
292
305
  ez-multi-selection-list --> ez-list
293
306
  ez-multi-selection-list --> ez-icon
@@ -305,6 +318,9 @@ graph TD;
305
318
  ez-search --> ez-popover-plus
306
319
  ez-search --> search-list
307
320
  search-list --> ez-card-item
321
+ ez-grid-pagination --> ez-popover
322
+ ez-grid-pagination --> ez-icon
323
+ ez-grid-pagination --> ez-button
308
324
  ez-grid-view --> ez-grid
309
325
  style ez-grid fill:#f9f,stroke:#333,stroke-width:4px
310
326
  ```
package/components/ez-grid-pagination/readme.md ADDED
@@ -0,0 +1,72 @@
1
+ # ez-grid-pagination
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------ | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | ----------- |
12
+ | `dataUnit` | -- | DataUnit associada à grid. | `DataUnit` | `undefined` |
13
+ | `paginationCounterMode` | `pagination-counter-mode` | Define a visibilidade do contador de paginação. - `show`: Sempre exibe o contador (ex: "1-10 de 100") - `hidden`: Oculta o contador (exibe apenas os botões) - `auto`: Exibe/oculta baseado no espaço disponível (responsivo) | `"auto" \| "hidden" \| "show"` | `'auto'` |
14
+ | `paginationTextPosition` | `pagination-text-position` | Define o texto da paginação à esquerda ou à direita. | `"left" \| "right"` | `'left'` |
15
+
16
+
17
+ ## Events
18
+
19
+ | Event | Description | Type |
20
+ | ------------ | -------------------------------------------- | ----------------------------------- |
21
+ | `pageChange` | Evento disparado quando a página é alterada. | `CustomEvent<"next" \| "previous">` |
22
+
23
+
24
+ ## Methods
25
+
26
+ ### `nextPage() => Promise<void>`
27
+
28
+ Navega para a próxima página.
29
+
30
+ #### Returns
31
+
32
+ Type: `Promise<void>`
33
+
34
+ ---
35
+
36
+ ### `previousPage() => Promise<void>`
37
+
38
+ Navega para a página anterior.
39
+
40
+ #### Returns
41
+
42
+ Type: `Promise<void>`
43
+
44
+
45
+
46
+
47
+ ## Dependencies
48
+
49
+ ### Used by
50
+
51
+ - [ez-grid](../ez-grid)
52
+
53
+ ### Depends on
54
+
55
+ - [ez-popover](../ez-popover)
56
+ - [ez-icon](../ez-icon)
57
+ - [ez-button](../ez-button)
58
+
59
+ ### Graph
60
+ ```mermaid
61
+ graph TD;
62
+ ez-grid-pagination --> ez-popover
63
+ ez-grid-pagination --> ez-icon
64
+ ez-grid-pagination --> ez-button
65
+ ez-button --> ez-icon
66
+ ez-grid --> ez-grid-pagination
67
+ style ez-grid-pagination fill:#f9f,stroke:#333,stroke-width:4px
68
+ ```
69
+
70
+ ----------------------------------------------
71
+
72
+
package/components/ez-grid-view/readme.md CHANGED
@@ -149,16 +149,17 @@ Type: `Promise<void>`
149
149
  ```mermaid
150
150
  graph TD;
151
151
  ez-grid-view --> ez-grid
152
+ ez-grid --> filter-column
153
+ ez-grid --> ez-grid-pagination
152
154
  ez-grid --> ez-popover
153
- ez-grid --> ez-icon
154
155
  ez-grid --> ez-button
155
- ez-grid --> filter-column
156
+ ez-grid --> ez-icon
156
157
  ez-grid --> ez-search
157
- ez-button --> ez-icon
158
158
  filter-column --> ez-popover-plus
159
159
  filter-column --> ez-button
160
160
  filter-column --> ez-multi-selection-list
161
161
  ez-popover-plus --> ez-popover-core
162
+ ez-button --> ez-icon
162
163
  ez-multi-selection-list --> ez-check
163
164
  ez-multi-selection-list --> ez-list
164
165
  ez-multi-selection-list --> ez-icon
@@ -176,6 +177,9 @@ graph TD;
176
177
  ez-search --> ez-popover-plus
177
178
  ez-search --> search-list
178
179
  search-list --> ez-card-item
180
+ ez-grid-pagination --> ez-popover
181
+ ez-grid-pagination --> ez-icon
182
+ ez-grid-pagination --> ez-button
179
183
  style ez-grid-view fill:#f9f,stroke:#333,stroke-width:4px
180
184
  ```
181
185
 
package/components/ez-icon/readme.md CHANGED
@@ -35,6 +35,7 @@
35
35
  - [ez-file-item](../ez-file-item)
36
36
  - [ez-filter-input](../ez-filter-input)
37
37
  - [ez-grid](../ez-grid)
38
+ - [ez-grid-pagination](../ez-grid-pagination)
38
39
  - [ez-image-input](../ez-image-input)
39
40
  - [ez-list-item](../ez-list-item)
40
41
  - [ez-modal-container](../ez-modal-container)
@@ -72,6 +73,7 @@ graph TD;
72
73
  ez-file-item --> ez-icon
73
74
  ez-filter-input --> ez-icon
74
75
  ez-grid --> ez-icon
76
+ ez-grid-pagination --> ez-icon
75
77
  ez-image-input --> ez-icon
76
78
  ez-list-item --> ez-icon
77
79
  ez-modal-container --> ez-icon
package/components/ez-popover/readme.md CHANGED
@@ -72,12 +72,14 @@ Type: `Promise<void>`
72
72
 
73
73
  - [ez-form](../ez-form)
74
74
  - [ez-grid](../ez-grid)
75
+ - [ez-grid-pagination](../ez-grid-pagination)
75
76
 
76
77
  ### Graph
77
78
  ```mermaid
78
79
  graph TD;
79
80
  ez-form --> ez-popover
80
81
  ez-grid --> ez-popover
82
+ ez-grid-pagination --> ez-popover
81
83
  style ez-popover fill:#f9f,stroke:#333,stroke-width:4px
82
84
  ```
83
85
 
package/components/ez-record-navigation/readme.md ADDED
@@ -0,0 +1,58 @@
1
+ # ez-record-navigation
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | --------------- | ------------------------------------------------------------------------ | ------------------- | ----------- |
12
+ | `dataUnit` | -- | DataUnit. | `DataUnit` | `undefined` |
13
+ | `primaryKeys` | -- | Chaves primárias dos registros, usadas para visualizar o registro atual. | `string[]` | `undefined` |
14
+ | `textPosition` | `text-position` | | `"left" \| "right"` | `'right'` |
15
+
16
+
17
+ ## Methods
18
+
19
+ ### `nextRecord() => Promise<void>`
20
+
21
+ Navega para a próxima página.
22
+
23
+ #### Returns
24
+
25
+ Type: `Promise<void>`
26
+
27
+ ---
28
+
29
+ ### `previousRecord() => Promise<void>`
30
+
31
+ Navega para a página anterior.
32
+
33
+ #### Returns
34
+
35
+ Type: `Promise<void>`
36
+
37
+
38
+
39
+
40
+ ## Dependencies
41
+
42
+ ### Depends on
43
+
44
+ - [ez-tooltip](../ez-tooltip)
45
+ - [ez-button](../ez-button)
46
+
47
+ ### Graph
48
+ ```mermaid
49
+ graph TD;
50
+ ez-record-navigation --> ez-tooltip
51
+ ez-record-navigation --> ez-button
52
+ ez-button --> ez-icon
53
+ style ez-record-navigation fill:#f9f,stroke:#333,stroke-width:4px
54
+ ```
55
+
56
+ ----------------------------------------------
57
+
58
+
package/components/ez-search/readme.md CHANGED
@@ -38,9 +38,10 @@
38
38
 
39
39
  ## Events
40
40
 
41
- | Event | Description | Type |
42
- | ---------- | ------------------------------------------------------ | ---------------------- |
43
- | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<IOption>` |
41
+ | Event | Description | Type |
42
+ | --------------- | ------------------------------------------------------ | ---------------------- |
43
+ | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<IOption>` |
44
+ | `ezEmptySearch` | Emitido quando a pesquisa retorna um resultado vazio. | `CustomEvent<string>` |
44
45
 
45
46
 
46
47
  ## Methods
package/components/ez-search-plus/readme.md CHANGED
@@ -37,9 +37,10 @@
37
37
 
38
38
  ## Events
39
39
 
40
- | Event | Description | Type |
41
- | ---------- | ------------------------------------------------------ | ---------------------- |
42
- | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<IOption>` |
40
+ | Event | Description | Type |
41
+ | --------------- | -------------------------------------------------------- | ---------------------- |
42
+ | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<IOption>` |
43
+ | `ezEmptySearch` | Emitido quando a pesquisa retorna um resultado inválido. | `CustomEvent<string>` |
43
44
 
44
45
 
45
46
  ## Methods
package/components/ez-tooltip/readme.md CHANGED
@@ -26,6 +26,7 @@
26
26
  ### Used by
27
27
 
28
28
  - [ez-chip](../ez-chip)
29
+ - [ez-record-navigation](../ez-record-navigation)
29
30
  - [ez-simple-image-uploader](../ez-rich-text/ez-simple-image-uploader)
30
31
  - [ez-text-area](../ez-text-area)
31
32
  - [ez-text-input](../ez-text-input)
@@ -34,6 +35,7 @@
34
35
  ```mermaid
35
36
  graph TD;
36
37
  ez-chip --> ez-tooltip
38
+ ez-record-navigation --> ez-tooltip
37
39
  ez-simple-image-uploader --> ez-tooltip
38
40
  ez-text-area --> ez-tooltip
39
41
  ez-text-input --> ez-tooltip
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "0.0.0-feat-dev-KB-130570.5",
3
+ "version": "0.0.0-feat-dev-KB-134690.2",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [