@sankhyalabs/ezui-docs 0.0.0-feat-dev-KB-134690.0 → 0.0.0-feat-dev-KB-130570.0

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 (12) hide show
  1. package/components/ez-button/readme.md +0 -2
  2. package/components/ez-classic-combo-box/readme.md +0 -1
  3. package/components/ez-classic-text-area/readme.md +19 -20
  4. package/components/ez-form-view/readme.md +0 -2
  5. package/components/ez-grid/readme.md +5 -21
  6. package/components/ez-grid-view/readme.md +3 -7
  7. package/components/ez-icon/readme.md +0 -2
  8. package/components/ez-popover/readme.md +0 -2
  9. package/components/ez-search/readme.md +3 -4
  10. package/components/ez-search-plus/readme.md +3 -4
  11. package/package.json +1 -1
  12. package/components/ez-grid-pagination/readme.md +0 -74
package/components/ez-button/readme.md CHANGED
@@ -56,7 +56,6 @@ 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)
60
59
  - [ez-guide-navigator](../ez-guide-navigator)
61
60
  - [ez-image-input](../ez-image-input)
62
61
  - [ez-modal-container](../ez-modal-container)
@@ -83,7 +82,6 @@ graph TD;
83
82
  ez-dialog --> ez-button
84
83
  ez-double-list --> ez-button
85
84
  ez-grid --> ez-button
86
- ez-grid-pagination --> ez-button
87
85
  ez-guide-navigator --> ez-button
88
86
  ez-image-input --> ez-button
89
87
  ez-modal-container --> ez-button
package/components/ez-classic-combo-box/readme.md CHANGED
@@ -10,7 +10,6 @@
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` |
14
13
  | `helpText` | `help-text` | Texto de ajuda exibido abaixo do combo box. | `string` | `undefined` |
15
14
  | `iconClickable` | `icon-clickable` | Define se o ícone é clicável | `boolean` | `false` |
16
15
  | `iconName` | `icon-name` | Nome do ícone. | `string` | `undefined` |
package/components/ez-classic-text-area/readme.md CHANGED
@@ -7,26 +7,25 @@
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
- | `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` | `''` |
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` | `''` |
30
29
 
31
30
 
32
31
  ## Events
package/components/ez-form-view/readme.md CHANGED
@@ -214,8 +214,6 @@ 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. |
218
217
  | --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. |
220
218
  | --ez-form-view\_\_item--gap | Define o colunas entre itens do formulário. |
221
219
  | --ez-form-view\_\_item--padding | Define o padding do formulário. |
package/components/ez-grid/readme.md CHANGED
@@ -20,7 +20,6 @@
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` |
24
23
  | `mode` | `mode` | Define o modo de uso da grade | `"complete" \| "simple"` | `"complete"` |
25
24
  | `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas. | `boolean` | `undefined` |
26
25
  | `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` |
@@ -161,16 +160,6 @@ Type: `Promise<any[]>`
161
160
 
162
161
  ---
163
162
 
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
-
174
163
  ### `locateColumn(columnName: string) => Promise<void>`
175
164
 
176
165
  Localiza determinada coluna tornando-a visível.
@@ -280,27 +269,25 @@ Type: `Promise<void>`
280
269
 
281
270
  ### Depends on
282
271
 
283
- - [filter-column](subcomponents)
284
- - [ez-grid-pagination](../ez-grid-pagination)
285
272
  - [ez-popover](../ez-popover)
286
- - [ez-button](../ez-button)
287
273
  - [ez-icon](../ez-icon)
274
+ - [ez-button](../ez-button)
275
+ - [filter-column](subcomponents)
288
276
  - [ez-search](../ez-search)
289
277
 
290
278
  ### Graph
291
279
  ```mermaid
292
280
  graph TD;
293
- ez-grid --> filter-column
294
- ez-grid --> ez-grid-pagination
295
281
  ez-grid --> ez-popover
296
- ez-grid --> ez-button
297
282
  ez-grid --> ez-icon
283
+ ez-grid --> ez-button
284
+ ez-grid --> filter-column
298
285
  ez-grid --> ez-search
286
+ ez-button --> ez-icon
299
287
  filter-column --> ez-popover-plus
300
288
  filter-column --> ez-button
301
289
  filter-column --> ez-multi-selection-list
302
290
  ez-popover-plus --> ez-popover-core
303
- ez-button --> ez-icon
304
291
  ez-multi-selection-list --> ez-check
305
292
  ez-multi-selection-list --> ez-list
306
293
  ez-multi-selection-list --> ez-icon
@@ -318,9 +305,6 @@ graph TD;
318
305
  ez-search --> ez-popover-plus
319
306
  ez-search --> search-list
320
307
  search-list --> ez-card-item
321
- ez-grid-pagination --> ez-popover
322
- ez-grid-pagination --> ez-icon
323
- ez-grid-pagination --> ez-button
324
308
  ez-grid-view --> ez-grid
325
309
  style ez-grid fill:#f9f,stroke:#333,stroke-width:4px
326
310
  ```
package/components/ez-grid-view/readme.md CHANGED
@@ -149,17 +149,16 @@ 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
154
152
  ez-grid --> ez-popover
155
- ez-grid --> ez-button
156
153
  ez-grid --> ez-icon
154
+ ez-grid --> ez-button
155
+ ez-grid --> filter-column
157
156
  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
163
162
  ez-multi-selection-list --> ez-check
164
163
  ez-multi-selection-list --> ez-list
165
164
  ez-multi-selection-list --> ez-icon
@@ -177,9 +176,6 @@ graph TD;
177
176
  ez-search --> ez-popover-plus
178
177
  ez-search --> search-list
179
178
  search-list --> ez-card-item
180
- ez-grid-pagination --> ez-popover
181
- ez-grid-pagination --> ez-icon
182
- ez-grid-pagination --> ez-button
183
179
  style ez-grid-view fill:#f9f,stroke:#333,stroke-width:4px
184
180
  ```
185
181
 
package/components/ez-icon/readme.md CHANGED
@@ -35,7 +35,6 @@
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)
39
38
  - [ez-image-input](../ez-image-input)
40
39
  - [ez-list-item](../ez-list-item)
41
40
  - [ez-modal-container](../ez-modal-container)
@@ -73,7 +72,6 @@ graph TD;
73
72
  ez-file-item --> ez-icon
74
73
  ez-filter-input --> ez-icon
75
74
  ez-grid --> ez-icon
76
- ez-grid-pagination --> ez-icon
77
75
  ez-image-input --> ez-icon
78
76
  ez-list-item --> ez-icon
79
77
  ez-modal-container --> ez-icon
package/components/ez-popover/readme.md CHANGED
@@ -72,14 +72,12 @@ Type: `Promise<void>`
72
72
 
73
73
  - [ez-form](../ez-form)
74
74
  - [ez-grid](../ez-grid)
75
- - [ez-grid-pagination](../ez-grid-pagination)
76
75
 
77
76
  ### Graph
78
77
  ```mermaid
79
78
  graph TD;
80
79
  ez-form --> ez-popover
81
80
  ez-grid --> ez-popover
82
- ez-grid-pagination --> ez-popover
83
81
  style ez-popover fill:#f9f,stroke:#333,stroke-width:4px
84
82
  ```
85
83
 
package/components/ez-search/readme.md CHANGED
@@ -38,10 +38,9 @@
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>` |
44
- | `ezEmptySearch` | Emitido quando a pesquisa retorna um resultado vazio. | `CustomEvent<string>` |
41
+ | Event | Description | Type |
42
+ | ---------- | ------------------------------------------------------ | ---------------------- |
43
+ | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<IOption>` |
45
44
 
46
45
 
47
46
  ## Methods
package/components/ez-search-plus/readme.md CHANGED
@@ -37,10 +37,9 @@
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>` |
43
- | `ezEmptySearch` | Emitido quando a pesquisa retorna um resultado inválido. | `CustomEvent<string>` |
40
+ | Event | Description | Type |
41
+ | ---------- | ------------------------------------------------------ | ---------------------- |
42
+ | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<IOption>` |
44
43
 
45
44
 
46
45
  ## Methods
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "0.0.0-feat-dev-KB-134690.0",
3
+ "version": "0.0.0-feat-dev-KB-130570.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
package/components/ez-grid-pagination/readme.md DELETED
@@ -1,74 +0,0 @@
1
- # ez-grid-pagination
2
-
3
-
4
-
5
- <!-- Auto Generated Below -->
6
-
7
-
8
- ## Properties
9
-
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------ | -------------------------- | ---------------------------------------------------- | ---------------------------------------------------------- | ---------------- |
12
- | `currentPage` | `current-page` | Define o modo de visualização atual da grid. | `VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID` | `VIEW_MODE.GRID` |
13
- | `dataUnit` | -- | DataUnit associada à grid. | `DataUnit` | `undefined` |
14
- | `hidePagination` | `hide-pagination` | Esconder paginação. | `boolean` | `false` |
15
- | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
16
- | `paginationTextPosition` | `pagination-text-position` | Define o texto da paginação à esquerda ou à direita. | `"left" \| "right"` | `'left'` |
17
-
18
-
19
- ## Events
20
-
21
- | Event | Description | Type |
22
- | ------------ | -------------------------------------------- | ----------------------------------- |
23
- | `pageChange` | Evento disparado quando a página é alterada. | `CustomEvent<"next" \| "previous">` |
24
-
25
-
26
- ## Methods
27
-
28
- ### `nextPage() => Promise<void>`
29
-
30
- Navega para a próxima página.
31
-
32
- #### Returns
33
-
34
- Type: `Promise<void>`
35
-
36
- ---
37
-
38
- ### `previousPage() => Promise<void>`
39
-
40
- Navega para a página anterior.
41
-
42
- #### Returns
43
-
44
- Type: `Promise<void>`
45
-
46
-
47
-
48
-
49
- ## Dependencies
50
-
51
- ### Used by
52
-
53
- - [ez-grid](../ez-grid)
54
-
55
- ### Depends on
56
-
57
- - [ez-popover](../ez-popover)
58
- - [ez-icon](../ez-icon)
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-button
67
- ez-button --> ez-icon
68
- ez-grid --> ez-grid-pagination
69
- style ez-grid-pagination fill:#f9f,stroke:#333,stroke-width:4px
70
- ```
71
-
72
- ----------------------------------------------
73
-
74
-