@sankhyalabs/ezui-docs 2.3.1 → 2.3.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 (34) hide show
  1. package/components/ez-actions-button/readme.md +28 -16
  2. package/components/ez-button/readme.md +45 -10
  3. package/components/ez-calendar/readme.md +47 -15
  4. package/components/ez-card-item/readme.md +21 -6
  5. package/components/ez-check/readme.md +59 -14
  6. package/components/ez-chip/readme.md +38 -14
  7. package/components/ez-collapsible-box/readme.md +34 -19
  8. package/components/ez-combo-box/readme.md +58 -21
  9. package/components/ez-date-input/readme.md +23 -15
  10. package/components/ez-date-time-input/readme.md +24 -16
  11. package/components/ez-dialog/readme.md +39 -23
  12. package/components/ez-filter-input/readme.md +14 -15
  13. package/components/ez-form/readme.md +6 -26
  14. package/components/ez-grid/readme.md +36 -31
  15. package/components/ez-icon/readme.md +11 -5
  16. package/components/ez-list/readme.md +57 -19
  17. package/components/ez-loading-bar/readme.md +2 -2
  18. package/components/ez-modal/readme.md +18 -11
  19. package/components/ez-modal-container/readme.md +9 -9
  20. package/components/ez-number-input/readme.md +17 -17
  21. package/components/ez-popover/readme.md +25 -16
  22. package/components/ez-popup/readme.md +25 -10
  23. package/components/ez-radio-button/readme.md +40 -10
  24. package/components/ez-scroller/readme.md +11 -5
  25. package/components/ez-search/readme.md +17 -18
  26. package/components/ez-tabselector/readme.md +15 -8
  27. package/components/ez-text-area/readme.md +40 -16
  28. package/components/ez-text-edit/readme.md +9 -9
  29. package/components/ez-text-input/readme.md +47 -18
  30. package/components/ez-time-input/readme.md +16 -16
  31. package/components/ez-toast/readme.md +18 -9
  32. package/components/ez-upload/readme.md +33 -11
  33. package/components/ez-view-stack/readme.md +2 -2
  34. package/package.json +1 -1
package/components/ez-combo-box/readme.md CHANGED
@@ -7,35 +7,35 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------------- | ----------------------- | ------------------------------------------------------------------------------------ | ------------------- | ----------- |
12
- | `canShowError` | `can-show-error` | Permite exibir a mensagem de erro. | `boolean` | `true` |
13
- | `enabled` | `enabled` | Deixa o campo disponível ou não para interação com usuário. | `boolean` | `true` |
14
- | `errorMessage` | `error-message` | Quando há um problema de validação, serve como orientação ao usuário | `string` | `undefined` |
15
- | `label` | `label` | Título do campo | `string` | `undefined` |
16
- | `mode` | `mode` | Define o modo do tamanho do campo; opções: slim e regular. | `string` | `"regular"` |
17
- | `optionLoader` | -- | Função responsável por carregar as opções dinamicamente | `Function` | `undefined` |
18
- | `options` | -- | Array no formato "{value: string, label: string}" que alimenta as opções do Combobox | `IOption[]` | `undefined` |
19
- | `searchMode` | `search-mode` | Ativa o modo pesquisa do combobox | `boolean` | `undefined` |
20
- | `showOptionValue` | `show-option-value` | Ajusta a opção de mostrar o "value" para cada opção. Por padrão não mostra | `boolean` | `false` |
21
- | `showSelectedValue` | `show-selected-value` | Ajusta a opção de mostrar o "value" ao selecionar uma opção. Por padrão não mostra. | `boolean` | `false` |
22
- | `suppressEmptyOption` | `suppress-empty-option` | Remove a opção vazia da lista de opções | `boolean` | `false` |
23
- | `suppressSearch` | `suppress-search` | Desabilita a digitação dentro do componente. | `boolean` | `false` |
24
- | `value` | `value` | Valor selecionado no campo | `IOption \| string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ----------- |
12
+ | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
13
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
14
+ | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
15
+ | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
16
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
17
+ | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
18
+ | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
19
+ | `searchMode` | `search-mode` | Se true ativa o modo pesquisa do ez-combo-box. | `boolean` | `undefined` |
20
+ | `showOptionValue` | `show-option-value` | Se true cada opção na lista exibe o `value` junto com `label`. | `boolean` | `false` |
21
+ | `showSelectedValue` | `show-selected-value` | Se true a opção selecionada exibe o `value` junto com `label`. | `boolean` | `false` |
22
+ | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
23
+ | `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
24
+ | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
25
25
 
26
26
 
27
27
  ## Events
28
28
 
29
- | Event | Description | Type |
30
- | ---------- | ------------------------------------------------------- | ---------------------- |
31
- | `ezChange` | Evento que é disparado ao alterar o valor do componente | `CustomEvent<IOption>` |
29
+ | Event | Description | Type |
30
+ | ---------- | ------------------------------------------------------ | ---------------------- |
31
+ | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<IOption>` |
32
32
 
33
33
 
34
34
  ## Methods
35
35
 
36
36
  ### `isInvalid() => Promise<boolean>`
37
37
 
38
- Retorna informando se o campo está inválido (true | false)
38
+ Retorna se o conteúdo é inválido.
39
39
 
40
40
  #### Returns
41
41
 
@@ -45,7 +45,7 @@ Type: `Promise<boolean>`
45
45
 
46
46
  ### `setBlur() => Promise<void>`
47
47
 
48
- Remove o foco no componente de seleção
48
+ Remove o foco do campo.
49
49
 
50
50
  #### Returns
51
51
 
@@ -55,7 +55,7 @@ Type: `Promise<void>`
55
55
 
56
56
  ### `setFocus() => Promise<void>`
57
57
 
58
- Realiza o foco no componente de seleção
58
+ Aplica o foco no campo.
59
59
 
60
60
  #### Returns
61
61
 
@@ -89,3 +89,40 @@ graph TD;
89
89
  ----------------------------------------------
90
90
 
91
91
 
92
+
93
+
94
+ ## CSS Variables
95
+ | Variable | Description |
96
+ |-|-|
97
+ | --ez-combo-box--height | Define altura do input. |
98
+ | --ez-combo-box--width | Define largura do input. |
99
+ | --ez-combo-box\_\_icon--width | Define largura do slot do ícone do input. |
100
+ | --ez-combo-box--border-radius | Define o raio da borda do input. |
101
+ | --ez-combo-box--border-radius-small | Define o raio da borda do input quando pequeno. |
102
+ | --ez-combo-box--font-size | Define o tamanho da fonte dentro do input. |
103
+ | --ez-combo-box--font-family | Define a família da fonte dentro do input. |
104
+ | --ez-combo-box--font-weight--large | Define o peso da fonte dentro do input quando pesada. |
105
+ | --ez-combo-box--font-weight--medium | Define o peso da fonte dentro do input quando média. |
106
+ | --ez-combo-box--background-color--xlight | Define a cor de fundo da lista de opções. |
107
+ | --ez-combo-box--background-medium | Define a cor de fundo dos itens da lista de opções. |
108
+ | --ez-combo-box--line-height | Define a altura da linha do texto dentro do input. |
109
+ | --ez-combo-box\_\_input--background-color | Define a cor de fundo do input. |
110
+ | --ez-combo-box\_\_input--border | Define o estilo da borda do input. |
111
+ | --ez-combo-box\_\_input--border-color | Define a cor da borda do input. |
112
+ | --ez-combo-box\_\_input--focus--border-color | Define a cor da borda do input quando focado. |
113
+ | --ez-combo-box\_\_input--disabled--background-color | Define a cor de fundo do input quando desabilitado. |
114
+ | --ez-combo-box\_\_input--disabled--color | Define a cor do texto dentro do input quando desabilitado. |
115
+ | --ez-combo-box\_\_input--error--border-color | Define a cor da borda do input quando com erro. |
116
+ | --ez-combo-box\_\_btn--color | Define a cor do botão de pesquisa do componente. |
117
+ | --ez-combo-box\_\_btn-disabled--color | Define a cor do botão de pesquisa do componente quando desabilitado. |
118
+ | --ez-combo-box\_\_btn-hover--color | Define a cor do botão de pesquisa do componente quando o mouse está sobre ele. |
119
+ | --ez-combo-box\_\_label--color | Define a cor do label. |
120
+ | --ez-combo-box\_\_list-title--primary | Define a cor do texto da lista de opções. |
121
+ | --ez-combo-box\_\_list-text--primary | Define a cor do texto do value da lista de opções. |
122
+ | --ez-combo-box\_\_list-height | Define a altura do box da lista de opções. |
123
+ | --ez-combo-box--space--medium | Define um espaçamento mediano entre elementos do componente. |
124
+ | --ez-combo-box--space--small | Define um espaçamento pequeno entre elementos do componente. |
125
+ | --ez-combo-box\_\_list-scrollbar--background-color-primary | Define a cor da barra de rolagem do componente. |
126
+ | --ez-combo-box\_\_list-scrollbar--background-color-secondary | Define a cor de fundo da barra de rolagem do componente. |
127
+ | --ez-combo-box\_\_list-scrollbar--border-radius | Define o raio da borda da barra de rolagem do componente. |
128
+ | --ez-combo-box\_\_list-scrollbar--width | Define a largura da barra de rolagem do componente. |
package/components/ez-date-input/readme.md CHANGED
@@ -7,29 +7,29 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------- | --------------- | -------------------------------------------------------------------- | --------- | ----------- |
12
- | `enabled` | `enabled` | Deixa o campo disponível ou não para uso. | `boolean` | `true` |
13
- | `errorMessage` | `error-message` | Quando há um problema de validação, serve como orientação ao usuário | `string` | `undefined` |
14
- | `label` | `label` | Título do campo | `string` | `undefined` |
15
- | `mode` | `mode` | Define o modo do tamanho do campo; opções: slim e regular. | `string` | `"regular"` |
16
- | `value` | -- | A data informada pelo usuário | `Date` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | --------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `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
+ | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
15
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
16
+ | `value` | -- | Define o valor do campo. | `Date` | `undefined` |
17
17
 
18
18
 
19
19
  ## Events
20
20
 
21
- | Event | Description | Type |
22
- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
23
- | `ezCancelWaitingChange` | Entre o evento ezStartChange e ezChange, se por algum motivo não foi possível completar a alteração, esse evento é disparado. | `CustomEvent<void>` |
24
- | `ezChange` | Evento disparado ao mudar o estado do componente(onEzChange). | `CustomEvent<Date>` |
25
- | `ezStartChange` | Evento emitido ao iniciar a alteração (remover ou adicionar um arquivo). | `CustomEvent<WaitingChange>` |
21
+ | Event | Description | Type |
22
+ | ----------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------- |
23
+ | `ezCancelWaitingChange` | Emitido quando não foi possível completar a alteração entre o evento ezStartChange e ezChange. | `CustomEvent<void>` |
24
+ | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<Date>` |
25
+ | `ezStartChange` | Emitido ao iniciar a alteração (digitação incompleta). | `CustomEvent<WaitingChange>` |
26
26
 
27
27
 
28
28
  ## Methods
29
29
 
30
30
  ### `isInvalid() => Promise<boolean>`
31
31
 
32
- Retorna informando se o campo está inválido (true | false)
32
+ Retorna se o conteúdo é inválido.
33
33
 
34
34
  #### Returns
35
35
 
@@ -39,7 +39,7 @@ Type: `Promise<boolean>`
39
39
 
40
40
  ### `setBlur() => Promise<void>`
41
41
 
42
- Remove o foco no componente de data
42
+ Remove o foco do campo.
43
43
 
44
44
  #### Returns
45
45
 
@@ -49,7 +49,7 @@ Type: `Promise<void>`
49
49
 
50
50
  ### `setFocus() => Promise<void>`
51
51
 
52
- Realiza o foco no componente de data
52
+ Aplica o foco no campo.
53
53
 
54
54
  #### Returns
55
55
 
@@ -81,3 +81,11 @@ graph TD;
81
81
  ----------------------------------------------
82
82
 
83
83
 
84
+
85
+
86
+ ## CSS Variables
87
+ | Variable | Description |
88
+ |-|-|
89
+ | --ez-date-input\_\_input--background-color | Define a cor de fundo do input. |
90
+ | --ez-date-input\_\_input--border-color | Define a cor da borda do input. |
91
+ | --ez-date-input\_\_calendar-image | Contém a imagem do calendário. |
package/components/ez-date-time-input/readme.md CHANGED
@@ -7,30 +7,30 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------- | --------------- | -------------------------------------------------------------------- | --------- | ----------- |
12
- | `enabled` | `enabled` | Deixa o campo disponível ou não para uso. | `boolean` | `true` |
13
- | `errorMessage` | `error-message` | Quando há um problema de validação, serve como orientação ao usuário | `string` | `undefined` |
14
- | `label` | `label` | Título do campo | `string` | `undefined` |
15
- | `mode` | `mode` | Define o modo do tamanho do campo; opções: slim e regular. | `string` | `"regular"` |
16
- | `showSeconds` | `show-seconds` | Exibe ou não os segundos no input | `boolean` | `false` |
17
- | `value` | -- | A data informada pelo usuário | `Date` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | --------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `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
+ | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
15
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
16
+ | `showSeconds` | `show-seconds` | Se true considera segundos. | `boolean` | `false` |
17
+ | `value` | -- | Define o valor do campo. | `Date` | `undefined` |
18
18
 
19
19
 
20
20
  ## Events
21
21
 
22
- | Event | Description | Type |
23
- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
24
- | `ezCancelWaitingChange` | Entre o evento ezStartChange e ezChange, se por algum motivo não foi possível completar a alteração, esse evento é disparado. | `CustomEvent<void>` |
25
- | `ezChange` | Evento disparado ao mudar o estado do componente(onEzChange). | `CustomEvent<Date>` |
26
- | `ezStartChange` | Evento emitido ao iniciar a alteração (remover ou adicionar um arquivo). | `CustomEvent<WaitingChange>` |
22
+ | Event | Description | Type |
23
+ | ----------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------- |
24
+ | `ezCancelWaitingChange` | Emitido quando não foi possível completar a alteração entre o evento ezStartChange e ezChange. | `CustomEvent<void>` |
25
+ | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<Date>` |
26
+ | `ezStartChange` | Emitido ao iniciar a alteração (digitação incompleta). | `CustomEvent<WaitingChange>` |
27
27
 
28
28
 
29
29
  ## Methods
30
30
 
31
31
  ### `isInvalid() => Promise<boolean>`
32
32
 
33
- Retorna informando se o campo está inválido (true | false)
33
+ Retorna se o conteúdo é inválido.
34
34
 
35
35
  #### Returns
36
36
 
@@ -40,7 +40,7 @@ Type: `Promise<boolean>`
40
40
 
41
41
  ### `setBlur() => Promise<void>`
42
42
 
43
- Remove o foco no componente de datetime
43
+ Remove o foco do campo.
44
44
 
45
45
  #### Returns
46
46
 
@@ -50,7 +50,7 @@ Type: `Promise<void>`
50
50
 
51
51
  ### `setFocus() => Promise<void>`
52
52
 
53
- Realiza o foco no componente de datetime
53
+ Aplica o foco no campo.
54
54
 
55
55
  #### Returns
56
56
 
@@ -82,3 +82,11 @@ graph TD;
82
82
  ----------------------------------------------
83
83
 
84
84
 
85
+
86
+
87
+ ## CSS Variables
88
+ | Variable | Description |
89
+ |-|-|
90
+ | --ez-date-input\_\_input--background-color | Define a cor de fundo do input. |
91
+ | --ez-date-input\_\_input--border-color | Define a cor da borda do input. |
92
+ | --ez-date-input\_\_calendar-image | Contém a imagem do calendário. |
package/components/ez-dialog/readme.md CHANGED
@@ -7,39 +7,29 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ---------------------- | ------------------------ | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ----------- |
12
- | `confirm` | `confirm` | Define se o componente será utilizado no modo de confirmação. | `boolean` | `false` |
13
- | `dialogType` | `dialog-type` | Define se o componente terá o visual padrão, de erro ou de aviso | `DialogType.CRITICAL \| DialogType.DEFAULT \| DialogType.SUCCESS \| DialogType.WARN` | `undefined` |
14
- | `ezTitle` | `ez-title` | Define o título do componente. | `string` | `undefined` |
15
- | `message` | `message` | Menssagem exibida dentro do Dialog | `string` | `undefined` |
16
- | `opened` | `opened` | Controla a exibição do componente | `boolean` | `false` |
17
- | `personalizedIconPath` | `personalized-icon-path` | Define o ícone a ser exibido ao lado do título do componente | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------------- | ------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ----------- |
12
+ | `confirm` | `confirm` | Define se o ez-dialog será utilizado no modo de confirmação. | `boolean` | `false` |
13
+ | `dialogType` | `dialog-type` | Define aparência do ez-dialog. | `DialogType.CRITICAL \| DialogType.DEFAULT \| DialogType.SUCCESS \| DialogType.WARN` | `undefined` |
14
+ | `ezTitle` | `ez-title` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
15
+ | `message` | `message` | Define a menssagem exibida no ez-dialog. | `string` | `undefined` |
16
+ | `opened` | `opened` | Define se o ez-dialog está aberto. | `boolean` | `false` |
17
+ | `personalizedIconPath` | `personalized-icon-path` | Define o ícone a ser exibido. | `string` | `undefined` |
18
18
 
19
19
 
20
20
  ## Events
21
21
 
22
- | Event | Description | Type |
23
- | ---------- | ----------------------------------------------------------------- | ---------------------- |
24
- | `ezAccept` | Evento disparado ao clicar no botão de aceitação. | `CustomEvent<boolean>` |
25
- | `ezCancel` | Evento disparado ao clicar tanto no botão de negação quanto no X. | `CustomEvent<boolean>` |
22
+ | Event | Description | Type |
23
+ | ---------- | --------------------------------- | ---------------------- |
24
+ | `ezAccept` | Emitido ao confirmar o ez-dialog. | `CustomEvent<boolean>` |
25
+ | `ezCancel` | Emitido ao cancelar o ez-dialog. | `CustomEvent<boolean>` |
26
26
 
27
27
 
28
28
  ## Methods
29
29
 
30
- ### `handleButtonClick(selectedOption: boolean) => Promise<void>`
31
-
32
- Lida com o clique nos botões de dentro do componente.
33
-
34
- #### Returns
35
-
36
- Type: `Promise<void>`
37
-
38
-
39
-
40
30
  ### `show(title: string, message: string, dialogType: DialogType, confirm: boolean, icon: string, labelCancel: string, labelConfirm: string, btnConfirmDanger: boolean) => Promise<boolean>`
41
31
 
42
- Faz com que o componente seja exibido.
32
+ Exibe o ez-dialog.
43
33
 
44
34
  #### Returns
45
35
 
@@ -67,3 +57,29 @@ graph TD;
67
57
  ----------------------------------------------
68
58
 
69
59
 
60
+
61
+
62
+ ## CSS Variables
63
+ | Variable | Description |
64
+ |-|-|
65
+ | --dialog\_\_container-padding | Define o espaçamento do container. |
66
+ | --dialog\_\_btn\_\_close--background-color | Define a cor de fundo do botão de fechar. |
67
+ | --dialog\_\_btn\_\_no--padding-right | Define o espaçamento direito do botão de negação. |
68
+ | --dialog\_\_btn\_\_close\_\_image | Contém a imagem do ícone de fechamento. |
69
+ | --dialog\_\_title--font-pattern | Define o estilo da mensagem exibida no título. |
70
+ | --dialog\_\_title--padding-left | Define o espaçamento a esquerda do título. |
71
+ | --dialog\_\_title\_\_container--padding-bottom | Define o espaçamento abaixo do container do título. |
72
+ | --dialog\_\_title--weight--large | Define o peso do título. |
73
+ | --dialog\_\_body--font-pattern | Define o estilo do texto da mensagem. |
74
+ | --dialog\_\_body--text-shadow | Define a sombra do texto da mensagem. |
75
+ | --dialog\_\_body--text-weight--medium | Define o peso do texto da mensagem. |
76
+ | --dialog\_\_body--padding-bottom | Define o espaçamento inferior do texto da mensagem. |
77
+ | --dialog\_\_body--font-size | Define o tamanho do texto da mensagem. |
78
+ | --dialog\_\_body--color | Define a cor do texto da mensagem. |
79
+ | --dialog\_\_icon--color | Define a cor dos ícones dos indicadores de modo. |
80
+ | --dialog\_\_critical--background-color | Define a cor do indicador do dialog de erro. |
81
+ | --dialog\_\_warning--background-color | Define a cor do indicador do dialog de alert. |
82
+ | --dialog\_\_success--background-color | Define a cor do indicador do dialog de sucesso. |
83
+ | --dialog-z-index | Define a camada que o dialog será exibido. |
84
+ | --dialog--warning\_\_image | Contém a imagem do ícone de alerta. |
85
+ | --dialog--critical\_\_image | Contém a imagem do ícone crítico. |
package/components/ez-filter-input/readme.md CHANGED
@@ -7,29 +7,28 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------- | ----------- |
12
- | `enabled` | `enabled` | Deixa o campo disponível ou não para uso. | `boolean` | `true` |
13
- | `errorMessage` | `error-message` | Quando há um problema de validação, serve como orientação ao usuário | `string` | `undefined` |
14
- | `label` | `label` | Título do campo | `string` | `undefined` |
15
- | `loading` | `loading` | Deixa o componente em modo "carregando". | `boolean` | `undefined` |
16
- | `mode` | `mode` | Define o modo do tamanho do campo; opções: slim e regular. | `string` | `"regular"` |
17
- | `restrict` | `restrict` | Restringe o que o usuário pode digitar. Cada caractere digitado será testado e deve estar contido nessa string ou será descartado. | `string` | `undefined` |
18
- | `value` | `value` | O valor informado pelo usuário | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | --------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `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
+ | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
15
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
16
+ | `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
17
+ | `value` | `value` | Define o valor do campo. | `string` | `undefined` |
19
18
 
20
19
 
21
20
  ## Events
22
21
 
23
- | Event | Description | Type |
24
- | ---------- | ----------------------------------------------------------------------- | --------------------- |
25
- | `ezChange` | Evento disparado quando o estado do componente é alterado (onEzChange). | `CustomEvent<string>` |
22
+ | Event | Description | Type |
23
+ | ---------- | ------------------------------------------------------ | --------------------- |
24
+ | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<string>` |
26
25
 
27
26
 
28
27
  ## Methods
29
28
 
30
29
  ### `isInvalid() => Promise<boolean>`
31
30
 
32
- Retorna informando se o campo está inválido (true | false)
31
+ Retorna se o conteúdo é inválido.
33
32
 
34
33
  #### Returns
35
34
 
@@ -39,7 +38,7 @@ Type: `Promise<boolean>`
39
38
 
40
39
  ### `setBlur() => Promise<void>`
41
40
 
42
- Remove o foco no componente de input
41
+ Remove o foco do campo.
43
42
 
44
43
  #### Returns
45
44
 
@@ -49,7 +48,7 @@ Type: `Promise<void>`
49
48
 
50
49
  ### `setFocus() => Promise<void>`
51
50
 
52
- Realiza o foco no componente de input
51
+ Aplica o foco no campo.
53
52
 
54
53
  #### Returns
55
54
 
package/components/ez-form/readme.md CHANGED
@@ -7,11 +7,11 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------ | --------- | -------------------------------------------------------------------------- | ------------------ | ----------- |
12
- | `config` | -- | Configuração dos campos. | `IFormConfig` | `undefined` |
13
- | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados | `DataUnit` | `undefined` |
14
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro | `IRecordValidator` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | --------- | --------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
12
+ | `config` | -- | Configuração do formulário. | `IFormConfig` | `undefined` |
13
+ | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
14
+ | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
15
15
 
16
16
 
17
17
  ## Events
@@ -23,29 +23,9 @@
23
23
 
24
24
  ## Methods
25
25
 
26
- ### `cancel() => Promise<void>`
27
-
28
-
29
-
30
- #### Returns
31
-
32
- Type: `Promise<void>`
33
-
34
-
35
-
36
- ### `submit() => Promise<void>`
37
-
38
-
39
-
40
- #### Returns
41
-
42
- Type: `Promise<void>`
43
-
44
-
45
-
46
26
  ### `validate() => Promise<void>`
47
27
 
48
-
28
+ Realiza validação no conteúdo de todos os campos.
49
29
 
50
30
  #### Returns
51
31
 
package/components/ez-grid/readme.md CHANGED
@@ -7,40 +7,40 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ----------- |
12
- | `config` | -- | Configuração de exibição da grade. | `IGridConfig` | `undefined` |
13
- | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
14
- | `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas | `boolean` | `undefined` |
15
- | `serverUrl` | `server-url` | Endereço do servidor. Se informado, o próprio datagrid controlará a obtenção dos dados, anulando a necessidade de acionar o método "setData(data)" | `string` | `undefined` |
16
- | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `IStatusResolver` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------- | -------------------- | --------------------------------------------------------------------------------------------------------- | ----------------- | ----------- |
12
+ | `config` | -- | Configuração de exibição da grade. | `IGridConfig` | `undefined` |
13
+ | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
14
+ | `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas. | `boolean` | `undefined` |
15
+ | `serverUrl` | `server-url` | Endereço do servidor para obtenção dos dados. | `string` | `undefined` |
16
+ | `statusResolver` | -- | Define um `IStatusResolver` responsável pelo estado da coluna de status. | `IStatusResolver` | `undefined` |
17
17
 
18
18
 
19
19
  ## Events
20
20
 
21
- | Event | Description | Type |
22
- | --------------------- | -------------------------------------------------------------------------------- | ------------------------------------ |
23
- | `configChange` | Evento disparado ao realizar alguma modificação na configuração da grid. | `CustomEvent<IGridConfig>` |
24
- | `ezColumnStateChange` | Evento disparado ao mudar o estado das colunas do grid. Ordenação, largura, etc. | `CustomEvent<EzGridColumStateEvent>` |
25
- | `ezDoubleClick` | Evento disparado com o duplo clique de uma linha | `CustomEvent<any>` |
26
- | `ezSelectionChange` | Evento disparado ao selecionar linhas da grade. | `CustomEvent<any[]>` |
21
+ | Event | Description | Type |
22
+ | --------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------ |
23
+ | `configChange` | Emitido quando acontece a alteração de configuração do grade. | `CustomEvent<IGridConfig>` |
24
+ | `ezColumnStateChange` | Emitido quando acontece a alteração de estado das colunas do grid: Ordenação, largura, etc. | `CustomEvent<EzGridColumStateEvent>` |
25
+ | `ezDoubleClick` | Emitido com o duplo clique de uma linha | `CustomEvent<any>` |
26
+ | `ezSelectionChange` | Emitido quando acontece a alteração de seleção de linhas. | `CustomEvent<any[]>` |
27
27
 
28
28
 
29
29
  ## Methods
30
30
 
31
- ### `addColumnMenuItem(label: string, name: string, action: Function) => Promise<any>`
31
+ ### `addColumnMenuItem(label: string, name: string, action: Function) => Promise<void>`
32
32
 
33
33
  Adiciona item de menu nas colunas.
34
34
 
35
35
  #### Returns
36
36
 
37
- Type: `Promise<any>`
37
+ Type: `Promise<void>`
38
38
 
39
39
 
40
40
 
41
41
  ### `getColumns() => Promise<Array<EzGridColumn>>`
42
42
 
43
- Método retornar o estado atual das colunas do grid.
43
+ Obtém a lista de definição de colunas.
44
44
 
45
45
  #### Returns
46
46
 
@@ -50,7 +50,7 @@ Type: `Promise<EzGridColumn[]>`
50
50
 
51
51
  ### `getColumnsState() => Promise<Array<EzGridColumn>>`
52
52
 
53
- Método retornar o estado atual das colunas do grid.
53
+ Obtém o estado atual das colunas.
54
54
 
55
55
  #### Returns
56
56
 
@@ -60,7 +60,7 @@ Type: `Promise<EzGridColumn[]>`
60
60
 
61
61
  ### `getSelection() => Promise<Array<any>>`
62
62
 
63
- Retorna as linhas selecionadas na grade.
63
+ Obtém as linhas selecionadas.
64
64
 
65
65
  #### Returns
66
66
 
@@ -68,44 +68,43 @@ Type: `Promise<any[]>`
68
68
 
69
69
 
70
70
 
71
- ### `quickFilter(term: string) => Promise<any>`
71
+ ### `quickFilter(term: string) => Promise<void>`
72
72
 
73
- Método para fazer um filtro rápido na grid.
73
+ Aplica um filtro rápido.
74
74
 
75
75
  #### Returns
76
76
 
77
- Type: `Promise<any>`
77
+ Type: `Promise<void>`
78
78
 
79
79
 
80
80
 
81
- ### `setColumnsDef(cols: Array<EzGridColumn>) => Promise<any>`
81
+ ### `setColumnsDef(cols: Array<EzGridColumn>) => Promise<void>`
82
82
 
83
- Método responsável por receber a definição das colunas
83
+ Aplica a definição de colunas.
84
84
 
85
85
  #### Returns
86
86
 
87
- Type: `Promise<any>`
87
+ Type: `Promise<void>`
88
88
 
89
89
 
90
90
 
91
- ### `setColumnsState(state: Array<EzGridColumnConfig>) => Promise<any>`
91
+ ### `setColumnsState(state: Array<EzGridColumnConfig>) => Promise<void>`
92
92
 
93
- Método responsável por aplicar estado pré-existente nas colunas do grid.
93
+ Aplica o estado das colunas.
94
94
 
95
95
  #### Returns
96
96
 
97
- Type: `Promise<any>`
97
+ Type: `Promise<void>`
98
98
 
99
99
 
100
100
 
101
- ### `setData(data: Array<any>) => Promise<any>`
101
+ ### `setData(data: Array<any>) => Promise<void>`
102
102
 
103
- Método de carga dos registros. Os objetos deste array devem conter atributos
104
- para as colunas desejadas.
103
+ Insere os registros no ez-grid.
105
104
 
106
105
  #### Returns
107
106
 
108
- Type: `Promise<any>`
107
+ Type: `Promise<void>`
109
108
 
110
109
 
111
110
 
@@ -127,3 +126,9 @@ graph TD;
127
126
  ----------------------------------------------
128
127
 
129
128
 
129
+
130
+
131
+ ## CSS Variables
132
+ | Variable | Description |
133
+ |-|-|
134
+ | --ezgrid\_\_header--background-color | Define a cor de fundo do header do componente. |