@sankhyalabs/ezui-docs 7.1.2 → 7.2.0-dev.10

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 (37) hide show
  1. package/components/ez-button/readme.md +10 -0
  2. package/components/ez-calendar/readme.md +4 -0
  3. package/components/ez-card-item/readme.md +4 -0
  4. package/components/ez-classic-combo-box/readme.md +12 -3
  5. package/components/ez-classic-date-input/readme.md +111 -0
  6. package/components/ez-classic-date-time-input/readme.md +111 -0
  7. package/components/ez-classic-input/readme.md +22 -1
  8. package/components/ez-classic-number-input/readme.md +107 -0
  9. package/components/ez-classic-search/readme.md +162 -0
  10. package/components/ez-classic-search/subcomponent/classic-search-list/readme.md +72 -0
  11. package/components/ez-classic-search-plus/readme.md +169 -0
  12. package/components/ez-classic-search-plus/subcomponent/ez-search-result-list/readme.md +90 -0
  13. package/components/ez-classic-text-area/readme.md +25 -19
  14. package/components/ez-classic-time-input/readme.md +88 -0
  15. package/components/ez-empty-card/readme.md +2 -2
  16. package/components/ez-form/readme.md +47 -9
  17. package/components/ez-form-view/readme.md +57 -6
  18. package/components/ez-grid/readme.md +23 -6
  19. package/components/ez-grid/subcomponents/readme.md +1 -0
  20. package/components/ez-grid-pagination/readme.md +92 -0
  21. package/components/ez-grid-view/readme.md +8 -3
  22. package/components/ez-guide-navigator/readme.md +2 -0
  23. package/components/ez-icon/readme.md +6 -0
  24. package/components/ez-image-input/readme.md +77 -0
  25. package/components/ez-modal/readme.md +2 -1
  26. package/components/ez-multi-selection-list/readme.md +2 -0
  27. package/components/ez-popover/readme.md +2 -0
  28. package/components/ez-popover-plus/readme.md +8 -0
  29. package/components/ez-popup/readme.md +2 -0
  30. package/components/ez-record-navigation/readme.md +59 -0
  31. package/components/ez-scroller/readme.md +20 -6
  32. package/components/ez-search/readme.md +7 -1
  33. package/components/ez-sidebar-navigator/readme.md +2 -0
  34. package/components/ez-skeleton/readme.md +4 -0
  35. package/components/ez-split-button/readme.md +2 -0
  36. package/components/ez-tooltip/readme.md +6 -0
  37. package/package.json +1 -1
@@ -0,0 +1,77 @@
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. |
@@ -38,4 +38,5 @@
38
38
  |-|-|
39
39
  | --ez-modal-z-index | Define a camada em que o componente será exibido. |
40
40
  | --ez-modal-vertical-padding | Define o espaçamento vertical do conteúdo do modal. |
41
- | --ez-modal-content-padding | Define o padding entre o conteúdo e o modal |
41
+ | --ez-modal-content-padding | Define o padding entre o conteúdo e o modal |
42
+ | --ez-modal-content-min-width | Define a largura mínima do conteúdo do modal |
@@ -65,10 +65,12 @@ graph TD;
65
65
  ez-filter-input --> ez-icon
66
66
  ez-text-input --> ez-tooltip
67
67
  ez-text-input --> ez-icon
68
+ ez-search --> ez-button
68
69
  ez-search --> ez-text-input
69
70
  ez-search --> ez-icon
70
71
  ez-search --> ez-popover-plus
71
72
  ez-search --> search-list
73
+ ez-button --> ez-icon
72
74
  ez-popover-plus --> ez-popover-core
73
75
  search-list --> ez-card-item
74
76
  filter-column --> ez-multi-selection-list
@@ -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
 
@@ -93,6 +93,10 @@ Type: `Promise<void>`
93
93
 
94
94
  ### Used by
95
95
 
96
+ - [ez-classic-date-input](../ez-classic-date-input)
97
+ - [ez-classic-date-time-input](../ez-classic-date-time-input)
98
+ - [ez-classic-search](../ez-classic-search)
99
+ - [ez-classic-search-plus](../ez-classic-search-plus)
96
100
  - [ez-combo-box](../ez-combo-box)
97
101
  - [ez-date-input](../ez-date-input)
98
102
  - [ez-date-time-input](../ez-date-time-input)
@@ -108,6 +112,10 @@ Type: `Promise<void>`
108
112
  ```mermaid
109
113
  graph TD;
110
114
  ez-popover-plus --> ez-popover-core
115
+ ez-classic-date-input --> ez-popover-plus
116
+ ez-classic-date-time-input --> ez-popover-plus
117
+ ez-classic-search --> ez-popover-plus
118
+ ez-classic-search-plus --> ez-popover-plus
111
119
  ez-combo-box --> ez-popover-plus
112
120
  ez-date-input --> ez-popover-plus
113
121
  ez-date-time-input --> ez-popover-plus
@@ -31,6 +31,7 @@
31
31
 
32
32
  ### Used by
33
33
 
34
+ - [ez-image-input](../ez-image-input)
34
35
  - [ez-link-builder](../ez-rich-text/ez-link-builder)
35
36
  - [ez-simple-image-uploader](../ez-rich-text/ez-simple-image-uploader)
36
37
 
@@ -43,6 +44,7 @@
43
44
  graph TD;
44
45
  ez-popup --> ez-button
45
46
  ez-button --> ez-icon
47
+ ez-image-input --> ez-popup
46
48
  ez-link-builder --> ez-popup
47
49
  ez-simple-image-uploader --> ez-popup
48
50
  style ez-popup fill:#f9f,stroke:#333,stroke-width:4px
@@ -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
+
@@ -7,11 +7,13 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------- | --------------- | -------------------------------------- | -------------------------------------------------------------------------------------- | ----------- |
12
- | `activeShadow` | `active-shadow` | Define se haverá efeito de sombreado. | `boolean` | `false` |
13
- | `direction` | `direction` | Define a direção em que haverá scroll. | `EzScrollDirection.BOTH \| EzScrollDirection.HORIZONTAL \| EzScrollDirection.VERTICAL` | `undefined` |
14
- | `locked` | `locked` | Define se o `scroll` estará bloqueado. | `boolean` | `false` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------- | ----------------- | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | ---------------------------------- |
12
+ | `activeShadow` | `active-shadow` | Define se haverá efeito de sombreado. | `boolean` | `false` |
13
+ | `direction` | `direction` | Define a direção em que haverá scroll. | `EzScrollDirection.BOTH \| EzScrollDirection.HORIZONTAL \| EzScrollDirection.VERTICAL` | `undefined` |
14
+ | `locked` | `locked` | Define se o `scroll` estará bloqueado. | `boolean` | `false` |
15
+ | `navigationMode` | `navigation-mode` | Define o modo de navegação: 'scrollbar' (padrão) ou 'buttons' (botões de carrossel). | `EzScrollNavigationMode.BUTTONS \| EzScrollNavigationMode.SCROLLBAR` | `EzScrollNavigationMode.SCROLLBAR` |
16
+ | `scrollAmount` | `scroll-amount` | Define a quantidade de pixels que será rolado ao clicar nos botões de navegação. | `number` | `200` |
15
17
 
16
18
 
17
19
  ## Dependencies
@@ -21,9 +23,17 @@
21
23
  - [ez-guide-navigator](../ez-guide-navigator)
22
24
  - [ez-sidebar-navigator](../ez-sidebar-navigator)
23
25
 
26
+ ### Depends on
27
+
28
+ - [ez-button](../ez-button)
29
+ - [ez-icon](../ez-icon)
30
+
24
31
  ### Graph
25
32
  ```mermaid
26
33
  graph TD;
34
+ ez-scroller --> ez-button
35
+ ez-scroller --> ez-icon
36
+ ez-button --> ez-icon
27
37
  ez-guide-navigator --> ez-scroller
28
38
  ez-sidebar-navigator --> ez-scroller
29
39
  style ez-scroller fill:#f9f,stroke:#333,stroke-width:4px
@@ -38,6 +48,7 @@ graph TD;
38
48
  | Variable | Description |
39
49
  |-|-|
40
50
  | --ez-scroller--box-shadow-color | Define a cor de efeito de sombreado com componente. |
51
+ | --ez-scroller\_\_nav-button--spacing | Define o espaçamento entre os botões de navegação e o conteúdo. |
41
52
  | --ez-scroller\_\_scrollbar--color-default | Define a cor da barra de rolagem do componente. |
42
53
  | --ez-scroller\_\_scrollbar--color-background | Define a cor de fundo da barra de rolagem do componente. |
43
54
  | --ez-scroller\_\_scrollbar--color-hover | Define a cor do hover na barra de rolagem do componente. |
@@ -45,4 +56,7 @@ graph TD;
45
56
  | --ez-scroller\_\_scrollbar--border-radius | Define o raio da borda da barra de rolagem do componente. |
46
57
  | --ez-scroller\_\_scrollbar--width | Define a largura da barra de rolagem do componente. |
47
58
  | --ez-scroller\_\_max-height | Define o a altura máxima do componente. |
48
- | --ez-scroller\_\_scrollbar--padding-right | Define o espaçamento interno direito da barra de rolagem do componente. |
59
+ | --ez-scroller\_\_scrollbar--padding-right | Define o espaçamento interno direito da barra de rolagem do componente. |
60
+ | --ez-scroller\_\_nav-button--size | Define o tamanho do botão de navegação. |
61
+ | --ez-scroller\_\_nav-button--border-radius | Define o raio da borda do botão de navegação. |
62
+ | --ez-scroller\_\_nav-button--gradient-width | Define a largura do gradiente ao lado do botão. |
@@ -16,7 +16,7 @@
16
16
  | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
17
17
  | `ensureClearButtonVisible` | `ensure-clear-button-visible` | Garante que o botão de limpar pesquisa está sempre visível | `boolean` | `false` |
18
18
  | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
19
- | `hideDescriptionInput` | `hide-description-input` | Se true o campo de de apresentação não será exibido. | `boolean` | `false` |
19
+ | `hideDescriptionInput` | `hide-description-input` | Se true o campo de descrição não será exibido. | `boolean` | `false` |
20
20
  | `hideErrorOnFocusOut` | `hide-error-on-focus-out` | Quando verdadeiro deixa de exibir a mensagem de erro (se existente) quando focar em um elemento diferente. | `boolean` | `true` |
21
21
  | `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Define se deve ignorar o limite de caracteres mínimo para realizar uma pesquisa | `boolean` | `false` |
22
22
  | `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
@@ -25,10 +25,12 @@
25
25
  | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
26
26
  | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument, ctxProperties?: any) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
27
27
  | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
28
+ | `showMore` | `show-more` | Informa se deve exibir a opção de mostrar mais resultados. | `boolean` | `undefined` |
28
29
  | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
29
30
  | `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
30
31
  | `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` |
31
32
  | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
33
+ | `suppressInputPersist` | `suppress-input-persist` | Informa se o valor da opção selecionada deve persistir no input de texto. | `boolean` | `false` |
32
34
  | `suppressPreLoad` | `suppress-pre-load` | Se true, desabilita pré-load das opções ao carregar componente | `boolean` | `true` |
33
35
  | `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
34
36
  | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
@@ -106,6 +108,7 @@ Type: `Promise<void>`
106
108
 
107
109
  ### Depends on
108
110
 
111
+ - [ez-button](../ez-button)
109
112
  - [ez-text-input](../ez-text-input)
110
113
  - [ez-icon](../ez-icon)
111
114
  - [ez-popover-plus](../ez-popover-plus)
@@ -114,10 +117,12 @@ Type: `Promise<void>`
114
117
  ### Graph
115
118
  ```mermaid
116
119
  graph TD;
120
+ ez-search --> ez-button
117
121
  ez-search --> ez-text-input
118
122
  ez-search --> ez-icon
119
123
  ez-search --> ez-popover-plus
120
124
  ez-search --> search-list
125
+ ez-button --> ez-icon
121
126
  ez-text-input --> ez-tooltip
122
127
  ez-text-input --> ez-icon
123
128
  ez-popover-plus --> ez-popover-core
@@ -139,6 +144,7 @@ graph TD;
139
144
  |-|-|
140
145
  | --ez-search--height | Define altura do input. |
141
146
  | --ez-search--width | Define largura do input. |
147
+ | --ez-search--min-width | Define largura mínima do input. |
142
148
  | --ez-search\_\_icon--width | Define largura do slot do ícone do input. |
143
149
  | --ez-search--border-radius | Define o raio da borda do input. |
144
150
  | --ez-search--border-radius-small | Define o raio da borda do input quando pequeno. |
@@ -74,6 +74,8 @@ graph TD;
74
74
  ez-sidebar-navigator --> ez-scroller
75
75
  ez-sidebar-button --> ez-icon
76
76
  ez-button --> ez-icon
77
+ ez-scroller --> ez-button
78
+ ez-scroller --> ez-icon
77
79
  style ez-sidebar-navigator fill:#f9f,stroke:#333,stroke-width:4px
78
80
  ```
79
81
 
@@ -25,13 +25,17 @@
25
25
 
26
26
  ### Used by
27
27
 
28
+ - [ez-classic-search-result-list](../ez-classic-search-plus/subcomponent/ez-search-result-list)
28
29
  - [ez-dropdown](../ez-dropdown)
30
+ - [ez-image-input](../ez-image-input)
29
31
  - [ez-search-result-list](../ez-search-plus/subcomponent/ez-search-result-list)
30
32
 
31
33
  ### Graph
32
34
  ```mermaid
33
35
  graph TD;
36
+ ez-classic-search-result-list --> ez-skeleton
34
37
  ez-dropdown --> ez-skeleton
38
+ ez-image-input --> ez-skeleton
35
39
  ez-search-result-list --> ez-skeleton
36
40
  style ez-skeleton fill:#f9f,stroke:#333,stroke-width:4px
37
41
  ```
@@ -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
@@ -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": "7.1.2",
3
+ "version": "7.2.0-dev.10",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [