@sankhyalabs/ezui-docs 0.0.0-feat-dev-KB-137482.0 → 0.0.0-feat-dev-KB-134690.5

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 (10) hide show
  1. package/components/ez-button/readme.md +4 -0
  2. package/components/ez-grid/readme.md +23 -6
  3. package/components/ez-grid-pagination/readme.md +75 -0
  4. package/components/ez-grid-view/readme.md +8 -3
  5. package/components/ez-icon/readme.md +2 -0
  6. package/components/ez-popover/readme.md +2 -0
  7. package/components/ez-record-navigation/readme.md +59 -0
  8. package/components/ez-split-button/readme.md +2 -0
  9. package/components/ez-tooltip/readme.md +6 -0
  10. 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-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,10 @@ 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-tooltip
324
+ ez-grid-pagination --> ez-button
308
325
  ez-grid-view --> ez-grid
309
326
  style ez-grid fill:#f9f,stroke:#333,stroke-width:4px
310
327
  ```
package/components/ez-grid-pagination/readme.md ADDED
@@ -0,0 +1,75 @@
1
+ # ez-grid-pagination
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------ | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | ----------- |
12
+ | `buttonsSize` | `buttons-size` | Define o modo de visualização atual da grid. | `"large" \| "medium" \| "small" \| "x-small"` | `"small"` |
13
+ | `dataUnit` | -- | DataUnit associada à grid. | `DataUnit` | `undefined` |
14
+ | `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'` |
15
+ | `paginationTextPosition` | `pagination-text-position` | Define o texto da paginação à esquerda ou à direita. | `"left" \| "right"` | `'left'` |
16
+
17
+
18
+ ## Events
19
+
20
+ | Event | Description | Type |
21
+ | ------------ | -------------------------------------------- | ----------------------------------- |
22
+ | `pageChange` | Evento disparado quando a página é alterada. | `CustomEvent<"next" \| "previous">` |
23
+
24
+
25
+ ## Methods
26
+
27
+ ### `nextPage() => Promise<void>`
28
+
29
+ Navega para a próxima página.
30
+
31
+ #### Returns
32
+
33
+ Type: `Promise<void>`
34
+
35
+ ---
36
+
37
+ ### `previousPage() => Promise<void>`
38
+
39
+ Navega para a página anterior.
40
+
41
+ #### Returns
42
+
43
+ Type: `Promise<void>`
44
+
45
+
46
+
47
+
48
+ ## Dependencies
49
+
50
+ ### Used by
51
+
52
+ - [ez-grid](../ez-grid)
53
+
54
+ ### Depends on
55
+
56
+ - [ez-popover](../ez-popover)
57
+ - [ez-icon](../ez-icon)
58
+ - [ez-tooltip](../ez-tooltip)
59
+ - [ez-button](../ez-button)
60
+
61
+ ### Graph
62
+ ```mermaid
63
+ graph TD;
64
+ ez-grid-pagination --> ez-popover
65
+ ez-grid-pagination --> ez-icon
66
+ ez-grid-pagination --> ez-tooltip
67
+ ez-grid-pagination --> ez-button
68
+ ez-button --> ez-icon
69
+ ez-grid --> ez-grid-pagination
70
+ style ez-grid-pagination fill:#f9f,stroke:#333,stroke-width:4px
71
+ ```
72
+
73
+ ----------------------------------------------
74
+
75
+
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,10 @@ 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-tooltip
183
+ ez-grid-pagination --> ez-button
179
184
  style ez-grid-view fill:#f9f,stroke:#333,stroke-width:4px
180
185
  ```
181
186
 
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,59 @@
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
+ | `disabled` | `disabled` | Desabilita a navegação entre os registros. | `boolean` | `false` |
14
+ | `primaryKeys` | -- | Chaves primárias dos registros, usadas para visualizar o registro atual. | `string[]` | `undefined` |
15
+ | `textPosition` | `text-position` | | `"left" \| "right"` | `'right'` |
16
+
17
+
18
+ ## Methods
19
+
20
+ ### `nextRecord() => Promise<void>`
21
+
22
+ Navega para a próxima página.
23
+
24
+ #### Returns
25
+
26
+ Type: `Promise<void>`
27
+
28
+ ---
29
+
30
+ ### `previousRecord() => Promise<void>`
31
+
32
+ Navega para a página anterior.
33
+
34
+ #### Returns
35
+
36
+ Type: `Promise<void>`
37
+
38
+
39
+
40
+
41
+ ## Dependencies
42
+
43
+ ### Depends on
44
+
45
+ - [ez-tooltip](../ez-tooltip)
46
+ - [ez-button](../ez-button)
47
+
48
+ ### Graph
49
+ ```mermaid
50
+ graph TD;
51
+ ez-record-navigation --> ez-tooltip
52
+ ez-record-navigation --> ez-button
53
+ ez-button --> ez-icon
54
+ style ez-record-navigation fill:#f9f,stroke:#333,stroke-width:4px
55
+ ```
56
+
57
+ ----------------------------------------------
58
+
59
+
package/components/ez-split-button/readme.md CHANGED
@@ -97,12 +97,14 @@ Type: `Promise<void>`
97
97
 
98
98
  ### Depends on
99
99
 
100
+ - [ez-tooltip](../ez-tooltip)
100
101
  - [ez-icon](../ez-icon)
101
102
  - [ez-dropdown](../ez-dropdown)
102
103
 
103
104
  ### Graph
104
105
  ```mermaid
105
106
  graph TD;
107
+ ez-split-button --> ez-tooltip
106
108
  ez-split-button --> ez-icon
107
109
  ez-split-button --> ez-dropdown
108
110
  ez-dropdown --> ez-skeleton
package/components/ez-tooltip/readme.md CHANGED
@@ -26,7 +26,10 @@
26
26
  ### Used by
27
27
 
28
28
  - [ez-chip](../ez-chip)
29
+ - [ez-grid-pagination](../ez-grid-pagination)
30
+ - [ez-record-navigation](../ez-record-navigation)
29
31
  - [ez-simple-image-uploader](../ez-rich-text/ez-simple-image-uploader)
32
+ - [ez-split-button](../ez-split-button)
30
33
  - [ez-text-area](../ez-text-area)
31
34
  - [ez-text-input](../ez-text-input)
32
35
 
@@ -34,7 +37,10 @@
34
37
  ```mermaid
35
38
  graph TD;
36
39
  ez-chip --> ez-tooltip
40
+ ez-grid-pagination --> ez-tooltip
41
+ ez-record-navigation --> ez-tooltip
37
42
  ez-simple-image-uploader --> ez-tooltip
43
+ ez-split-button --> ez-tooltip
38
44
  ez-text-area --> ez-tooltip
39
45
  ez-text-input --> ez-tooltip
40
46
  style ez-tooltip fill:#f9f,stroke:#333,stroke-width:4px
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "0.0.0-feat-dev-KB-137482.0",
3
+ "version": "0.0.0-feat-dev-KB-134690.5",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [