@sankhyalabs/ezui-docs 7.3.1-rc.1 → 7.3.1

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 (39) hide show
  1. package/components/ez-button/readme.md +0 -12
  2. package/components/ez-calendar/readme.md +0 -4
  3. package/components/ez-card-item/readme.md +0 -4
  4. package/components/ez-classic-combo-box/readme.md +3 -12
  5. package/components/ez-classic-input/readme.md +1 -22
  6. package/components/ez-classic-text-area/readme.md +19 -25
  7. package/components/ez-empty-card/readme.md +2 -2
  8. package/components/ez-form/readme.md +9 -47
  9. package/components/ez-form-view/readme.md +6 -57
  10. package/components/ez-grid/readme.md +6 -24
  11. package/components/ez-grid/subcomponents/readme.md +0 -1
  12. package/components/ez-grid-view/readme.md +3 -9
  13. package/components/ez-guide-navigator/readme.md +0 -2
  14. package/components/ez-icon/readme.md +0 -6
  15. package/components/ez-modal/readme.md +1 -2
  16. package/components/ez-multi-select-input/readme.md +0 -2
  17. package/components/ez-multi-selection-list/readme.md +0 -2
  18. package/components/ez-popover/readme.md +0 -13
  19. package/components/ez-popover-plus/readme.md +0 -8
  20. package/components/ez-popup/readme.md +0 -2
  21. package/components/ez-scroller/readme.md +6 -20
  22. package/components/ez-search/readme.md +1 -7
  23. package/components/ez-sidebar-navigator/readme.md +0 -2
  24. package/components/ez-skeleton/readme.md +0 -4
  25. package/components/ez-split-button/readme.md +0 -2
  26. package/components/ez-tabselector/readme.md +3 -5
  27. package/components/ez-tooltip/readme.md +0 -6
  28. package/package.json +1 -1
  29. package/components/ez-classic-date-input/readme.md +0 -111
  30. package/components/ez-classic-date-time-input/readme.md +0 -111
  31. package/components/ez-classic-number-input/readme.md +0 -107
  32. package/components/ez-classic-search/readme.md +0 -162
  33. package/components/ez-classic-search/subcomponent/classic-search-list/readme.md +0 -72
  34. package/components/ez-classic-search-plus/readme.md +0 -169
  35. package/components/ez-classic-search-plus/subcomponent/ez-search-result-list/readme.md +0 -90
  36. package/components/ez-classic-time-input/readme.md +0 -88
  37. package/components/ez-grid-pagination/readme.md +0 -95
  38. package/components/ez-image-input/readme.md +0 -77
  39. package/components/ez-record-navigation/readme.md +0 -59
@@ -1,90 +0,0 @@
1
- # ez-classic-search-result-list
2
-
3
-
4
-
5
- <!-- Auto Generated Below -->
6
-
7
-
8
- ## Properties
9
-
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | ------------------- | ----------- | ------------------- | ----------- |
12
- | `showLoading` | `show-loading` | | `boolean` | `undefined` |
13
- | `showOptionValue` | `show-option-value` | | `boolean` | `true` |
14
- | `value` | `value` | | `IOption \| string` | `undefined` |
15
- | `visibleOptions` | -- | | `IOption[]` | `[]` |
16
-
17
-
18
- ## Events
19
-
20
- | Event | Description | Type |
21
- | ------------- | ----------- | ---------------------- |
22
- | `changeValue` | | `CustomEvent<IOption>` |
23
-
24
-
25
- ## Methods
26
-
27
- ### `cancelSelection() => Promise<void>`
28
-
29
-
30
-
31
- #### Returns
32
-
33
- Type: `Promise<void>`
34
-
35
- ---
36
-
37
- ### `nextOption() => Promise<void>`
38
-
39
-
40
-
41
- #### Returns
42
-
43
- Type: `Promise<void>`
44
-
45
- ---
46
-
47
- ### `previousOption() => Promise<void>`
48
-
49
-
50
-
51
- #### Returns
52
-
53
- Type: `Promise<void>`
54
-
55
- ---
56
-
57
- ### `selectCurrentItem() => Promise<void>`
58
-
59
-
60
-
61
- #### Returns
62
-
63
- Type: `Promise<void>`
64
-
65
-
66
-
67
-
68
- ## Dependencies
69
-
70
- ### Used by
71
-
72
- - [ez-classic-search-plus](../..)
73
-
74
- ### Depends on
75
-
76
- - [ez-card-item](../../../ez-card-item)
77
- - [ez-skeleton](../../../ez-skeleton)
78
-
79
- ### Graph
80
- ```mermaid
81
- graph TD;
82
- ez-classic-search-result-list --> ez-card-item
83
- ez-classic-search-result-list --> ez-skeleton
84
- ez-classic-search-plus --> ez-classic-search-result-list
85
- style ez-classic-search-result-list fill:#f9f,stroke:#333,stroke-width:4px
86
- ```
87
-
88
- ----------------------------------------------
89
-
90
-
@@ -1,88 +0,0 @@
1
- # ez-classic-time-input
2
-
3
-
4
-
5
- <!-- Auto Generated Below -->
6
-
7
-
8
- ## Properties
9
-
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------ | ------------------------- | --------------------------------------------------------------------------------- | ---------------------------------- | ----------- |
12
- | `alternativePlaceholder` | `alternative-placeholder` | Texto alternativo ser apresentado como título do campo. | `string` | `undefined` |
13
- | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
14
- | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
15
- | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
16
- | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
17
- | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
18
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
19
- | `required` | `required` | Define se o campo é obrigatório | `boolean` | `false` |
20
- | `showSeconds` | `show-seconds` | Se true considera segundos. | `boolean` | `false` |
21
- | `size` | `size` | Tamanho do input | `"default" \| "small" \| "xsmall"` | `"default"` |
22
- | `value` | `value` | Define o valor do campo. | `number` | `undefined` |
23
-
24
-
25
- ## Events
26
-
27
- | Event | Description | Type |
28
- | ----------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------- |
29
- | `ezCancelWaitingChange` | Emitido quando não foi possível completar a alteração entre o evento ezStartChange e ezChange. | `CustomEvent<void>` |
30
- | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<number>` |
31
- | `ezStartChange` | Emitido ao iniciar a alteração (digitação incompleta). | `CustomEvent<WaitingChange>` |
32
-
33
-
34
- ## Methods
35
-
36
- ### `isInvalid() => Promise<boolean>`
37
-
38
- Retorna se o conteúdo é inválido.
39
-
40
- #### Returns
41
-
42
- Type: `Promise<boolean>`
43
-
44
- ---
45
-
46
- ### `setBlur() => Promise<void>`
47
-
48
- Remove o foco do campo.
49
-
50
- #### Returns
51
-
52
- Type: `Promise<void>`
53
-
54
- ---
55
-
56
- ### `setFocus({ selectText }: TFocusOptions) => Promise<void>`
57
-
58
- Aplica o foco no campo.
59
-
60
- #### Returns
61
-
62
- Type: `Promise<void>`
63
-
64
-
65
-
66
-
67
- ## Dependencies
68
-
69
- ### Used by
70
-
71
- - [ez-form-view](../ez-form-view)
72
-
73
- ### Depends on
74
-
75
- - [ez-classic-input](../ez-classic-input)
76
-
77
- ### Graph
78
- ```mermaid
79
- graph TD;
80
- ez-classic-time-input --> ez-classic-input
81
- ez-classic-input --> ez-icon
82
- ez-form-view --> ez-classic-time-input
83
- style ez-classic-time-input fill:#f9f,stroke:#333,stroke-width:4px
84
- ```
85
-
86
- ----------------------------------------------
87
-
88
-
@@ -1,95 +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
- | `buttonsSize` | `buttons-size` | Define o modo de visualização atual da grid. | `"large" \| "medium" \| "small" \| "x-small"` | `'large'` |
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
- ### `firstPage() => Promise<void>`
28
-
29
- Navega para a primeira página.
30
-
31
- #### Returns
32
-
33
- Type: `Promise<void>`
34
-
35
- ---
36
-
37
- ### `lastPage() => Promise<void>`
38
-
39
- Navega para a primeira página.
40
-
41
- #### Returns
42
-
43
- Type: `Promise<void>`
44
-
45
- ---
46
-
47
- ### `nextPage() => Promise<void>`
48
-
49
- Navega para a próxima página.
50
-
51
- #### Returns
52
-
53
- Type: `Promise<void>`
54
-
55
- ---
56
-
57
- ### `previousPage() => Promise<void>`
58
-
59
- Navega para a página anterior.
60
-
61
- #### Returns
62
-
63
- Type: `Promise<void>`
64
-
65
-
66
-
67
-
68
- ## Dependencies
69
-
70
- ### Used by
71
-
72
- - [ez-grid](../ez-grid)
73
-
74
- ### Depends on
75
-
76
- - [ez-icon](../ez-icon)
77
- - [ez-button](../ez-button)
78
- - [ez-popover](../ez-popover)
79
- - [ez-tooltip](../ez-tooltip)
80
-
81
- ### Graph
82
- ```mermaid
83
- graph TD;
84
- ez-grid-pagination --> ez-icon
85
- ez-grid-pagination --> ez-button
86
- ez-grid-pagination --> ez-popover
87
- ez-grid-pagination --> ez-tooltip
88
- ez-button --> ez-icon
89
- ez-grid --> ez-grid-pagination
90
- style ez-grid-pagination fill:#f9f,stroke:#333,stroke-width:4px
91
- ```
92
-
93
- ----------------------------------------------
94
-
95
-
@@ -1,77 +0,0 @@
1
- # ez-image-input
2
-
3
-
4
-
5
- <!-- Auto Generated Below -->
6
-
7
-
8
- ## Properties
9
-
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------- | --------------- | ---------------------------------------------------------- | --------- | ------------------ |
12
- | `accept` | `accept` | Tipos de arquivo aceitos | `string` | `'image/*'` |
13
- | `enabled` | `enabled` | Define se o componente está habilitado | `boolean` | `true` |
14
- | `label` | `label` | Label exibido na área de upload | `string` | `undefined` |
15
- | `loading` | `loading` | Define se o componente está em estado de carregamento | `boolean` | `false` |
16
- | `maxFileSize` | `max-file-size` | Define o tamanho máximo do arquivo em bytes (padrão: 20MB) | `number` | `20 * 1024 * 1024` |
17
- | `name` | `name` | Nome do componente | `string` | `undefined` |
18
- | `value` | `value` | Valor da imagem em base64 | `string` | `undefined` |
19
-
20
-
21
- ## Events
22
-
23
- | Event | Description | Type |
24
- | ---------- | ------------------------------------------------ | --------------------- |
25
- | `ezChange` | Evento disparado quando uma imagem é selecionada | `CustomEvent<string>` |
26
- | `ezError` | Evento disparado quando ocorre um erro | `CustomEvent<string>` |
27
-
28
-
29
- ## Dependencies
30
-
31
- ### Used by
32
-
33
- - [ez-form-view](../ez-form-view)
34
-
35
- ### Depends on
36
-
37
- - [ez-skeleton](../ez-skeleton)
38
- - [ez-button](../ez-button)
39
- - [ez-icon](../ez-icon)
40
- - [ez-popup](../ez-popup)
41
-
42
- ### Graph
43
- ```mermaid
44
- graph TD;
45
- ez-image-input --> ez-skeleton
46
- ez-image-input --> ez-button
47
- ez-image-input --> ez-icon
48
- ez-image-input --> ez-popup
49
- ez-button --> ez-icon
50
- ez-popup --> ez-button
51
- ez-form-view --> ez-image-input
52
- style ez-image-input fill:#f9f,stroke:#333,stroke-width:4px
53
- ```
54
-
55
- ----------------------------------------------
56
-
57
-
58
-
59
-
60
- ## CSS Variables
61
- | Variable | Description |
62
- |-|-|
63
- | --ez-image-input--container-height | Define a altura do container de imagem. |
64
- | --ez-image-input--container-width | Define a largura do container de imagem. |
65
- | --ez-image-input--background-color | Define a cor de fundo do container. |
66
- | --ez-image-input--border-color | Define a cor da borda do container. |
67
- | --ez-image-input--border-color-hover | Define a cor da borda no estado de hover. |
68
- | --ez-image-input--border-color-dragging | Define a cor da borda quando está sendo arrastado. |
69
- | --ez-image-input--border-color-disabled | Define a cor da borda quando está desabilitado. |
70
- | --ez-image-input--label-color | Define a cor do texto do label. |
71
- | --ez-image-input--icon-color | Define a cor do ícone. |
72
- | --ez-image-input--border-radius | Define o raio da borda do container. |
73
- | --ez-image-input--border-width | Define a largura da borda. |
74
- | --ez-image-input--remove-button-bg | Define a cor de fundo do botão de remover. |
75
- | --ez-image-input--remove-button-bg-hover | Define a cor de fundo do botão de remover no hover. |
76
- | --ez-image-input--remove-button-color | Define a cor do ícone do botão de remover. |
77
- | --ez-image-input--remove-button-border | Define a borda do botão de remover. |
@@ -1,59 +0,0 @@
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
-