@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
@@ -7,32 +7,31 @@
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. | `boolean` | `true` |
13
- | `errorMessage` | `error-message` | Quando 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
- | `optionLoader` | -- | Função responsável por carregar as opções dinamicamente | `Function` | `undefined` |
17
- | `showOptionValue` | `show-option-value` | Ajusta a opção de mostrar o "value" para cada opção. | `boolean` | `true` |
18
- | `showSelectedValue` | `show-selected-value` | Ajusta a opção de mostrar o "value" ao selecionar uma opção. | `boolean` | `true` |
19
- | `suppressEmptyOption` | `suppress-empty-option` | Remove a opção vazia da lista de opções | `boolean` | `false` |
20
- | `value` | `value` | Código do registro selecionado | `IOption \| 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
+ | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
17
+ | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
18
+ | `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
19
+ | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
20
+ | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
21
21
 
22
22
 
23
23
  ## Events
24
24
 
25
- | Event | Description | Type |
26
- | ----------- | -------------------------------------------------------------------------- | ---------------------- |
27
- | `ezChange` | Um evento disparado quando o estado do componente é alterado (onEzChange). | `CustomEvent<IOption>` |
28
- | `showPopup` | Evento emitido ao clicar para abrir o popup | `CustomEvent<any>` |
25
+ | Event | Description | Type |
26
+ | ---------- | ------------------------------------------------------ | ---------------------- |
27
+ | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<IOption>` |
29
28
 
30
29
 
31
30
  ## Methods
32
31
 
33
32
  ### `isInvalid() => Promise<boolean>`
34
33
 
35
- Retorna informando se o campo está inválido (true | false)
34
+ Retorna se o conteúdo é inválido.
36
35
 
37
36
  #### Returns
38
37
 
@@ -42,7 +41,7 @@ Type: `Promise<boolean>`
42
41
 
43
42
  ### `setBlur() => Promise<void>`
44
43
 
45
- Remove o foco no componente de pesquisa
44
+ Remove o foco do campo.
46
45
 
47
46
  #### Returns
48
47
 
@@ -52,7 +51,7 @@ Type: `Promise<void>`
52
51
 
53
52
  ### `setFocus() => Promise<void>`
54
53
 
55
- Realiza o foco no componente de pesquisa
54
+ Aplica o foco no campo.
56
55
 
57
56
  #### Returns
58
57
 
@@ -7,18 +7,18 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------- | ----------- |
12
- | `selectedIndex` | `selected-index` | Define o index da aba selecionada. | `number` | `undefined` |
13
- | `selectedTab` | `selected-tab` | Define a aba selecionada. | `string` | `undefined` |
14
- | `tabs` | `tabs` | Define o nome das abas do componente, separadas por vírgulas ",". Opcionalmente pode-se construir um array de objetos do tipo Tab, nesse caso o tabKey e o índice serão respeitados. | `Tab[] \| string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------- | ---------------- | ------------------------------------------------------------------------------------------------------------- | ----------------- | ----------- |
12
+ | `selectedIndex` | `selected-index` | Define o index da aba selecionada. | `number` | `undefined` |
13
+ | `selectedTab` | `selected-tab` | Define a aba selecionada. | `string` | `undefined` |
14
+ | `tabs` | `tabs` | Define o nome das abas do componente. Podendo serem separadas por vírgula "," ou em um Array de configuração. | `Tab[] \| string` | `undefined` |
15
15
 
16
16
 
17
17
  ## Events
18
18
 
19
- | Event | Description | Type |
20
- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
21
- | `ezChange` | Evento emitido ao clicar para abrir o popup (ezChange). O detail desse evento carrega tanto o tabKey quanto o index da aba selecionada. | `CustomEvent<Tab>` |
19
+ | Event | Description | Type |
20
+ | ---------- | ----------------------------------------------------------- | ------------------ |
21
+ | `ezChange` | Emitido quando acontece a alteração de valor do componente. | `CustomEvent<Tab>` |
22
22
 
23
23
 
24
24
  ## Dependencies
@@ -42,3 +42,10 @@ graph TD;
42
42
  ----------------------------------------------
43
43
 
44
44
 
45
+
46
+
47
+ ## CSS Variables
48
+ | Variable | Description |
49
+ |-|-|
50
+ | --tabselector--backward-icon | Contém o ícone de voltar para a aba anterior. |
51
+ | --tabselector--forward-icon | Contém o ícone de avançar para a aba posterior. |
@@ -7,30 +7,29 @@
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 digitação. | `boolean` | `true` |
14
- | `errorMessage` | `error-message` | Quando um problema de validação, serve como orientação ao usuário | `string` | `undefined` |
15
- | `label` | `label` | Título do campo | `string` | `undefined` |
16
- | `loading` | `loading` | Deixa o componente em modo "carregando". | `boolean` | `undefined` |
17
- | `mode` | `mode` | Define o modo do tamanho do campo; opções: slim e regular. | `string` | `"regular"` |
18
- | `rows` | `rows` | Ajusta o número de linhas e consequentemente o height do textarea. Valor default: 4 | `number` | `4` |
19
- | `value` | `value` | Valor digitado pelo usuário. Este valor é o que fica visível no campo. | `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
+ | `rows` | `rows` | Define o número de linhas. | `number` | `4` |
18
+ | `value` | `value` | Define o valor do campo. | `string` | `undefined` |
20
19
 
21
20
 
22
21
  ## Events
23
22
 
24
- | Event | Description | Type |
25
- | ---------- | ----------------------------------------------------------------------- | --------------------- |
26
- | `ezChange` | Evento disparado quando o estado do componente é alterado (onEzChange). | `CustomEvent<string>` |
23
+ | Event | Description | Type |
24
+ | ---------- | ------------------------------------------------------ | --------------------- |
25
+ | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<string>` |
27
26
 
28
27
 
29
28
  ## Methods
30
29
 
31
30
  ### `isInvalid() => Promise<boolean>`
32
31
 
33
- Retorna informando se o campo está inválido (true | false)
32
+ Retorna se o conteúdo é inválido.
34
33
 
35
34
  #### Returns
36
35
 
@@ -40,7 +39,7 @@ Type: `Promise<boolean>`
40
39
 
41
40
  ### `setBlur() => Promise<void>`
42
41
 
43
- Remove o foco no componente de input
42
+ Remove o foco do campo.
44
43
 
45
44
  #### Returns
46
45
 
@@ -50,7 +49,7 @@ Type: `Promise<void>`
50
49
 
51
50
  ### `setFocus() => Promise<void>`
52
51
 
53
- Faz o foco no componente de input
52
+ Aplica o foco no campo.
54
53
 
55
54
  #### Returns
56
55
 
@@ -75,3 +74,28 @@ graph TD;
75
74
  ----------------------------------------------
76
75
 
77
76
 
77
+
78
+
79
+ ## CSS Variables
80
+ | Variable | Description |
81
+ |-|-|
82
+ | --text-area--width | Define a largura do componente. |
83
+ | --text-area--border-radius | Define o raio da borda do input do componente. |
84
+ | --text-area--font-size | Define o tamanho da fonte do input e label do componente. |
85
+ | --text-area--font-family | Define a família da fonte do input, label e caixa de mensagem do componente. |
86
+ | --text-area--font-weight | Define o peso da fonte do label do componente. |
87
+ | --text-area--color | Define a cor da fonte do input e label do componente. |
88
+ | --text-area\_\_input--background-color | Define a cor de fundo do input. |
89
+ | --text-area\_\_input--border | Define o estilo da borda do input. |
90
+ | --text-area\_\_input--border-color | Define a cor da borda do input. |
91
+ | --text-area\_\_input--focus--border-color | Define a cor da borda do input quando focado. |
92
+ | --text-area\_\_input--disabled--background-color | Define a cor de fundo do input quando desabilitado. |
93
+ | --text-area\_\_input--disabled--color | Define a cor do texto do input. |
94
+ | --text-area\_\_input--error--border-color | Define a cor da borda do input quando com erro. |
95
+ | --text-area\_\_message\_box--font-size | Define o tamanho da fonte da mensagem abaixo do input. |
96
+ | --text-area\_\_message\_box--info--color | Define a cor da fonte da mensagem quando info. |
97
+ | --text-area\_\_message\_box--error--color | Define a cor da fonte da mensagem quando erro. |
98
+ | --text-area\_\_label--floating--top | Define o posicionamento do label. |
99
+ | --text-area\_\_label--padding-top | Define o espaçamento superior do label. |
100
+ | --text-area\_\_label--padding-left | Define o espaçamento esquerdo do label. |
101
+ | --text-area\_\_label--padding-right | Define o espaçamento direito do label. |
@@ -7,25 +7,25 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------- | --------- | ------------------------------------------------- | --------- | ----------- |
12
- | `styled` | -- | Define atributos do estilo | `IStyled` | `undefined` |
13
- | `value` | `value` | Valor manipulado pelo componente através do input | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------- | --------- | --------------------------- | --------- | ----------- |
12
+ | `styled` | -- | Define atributos do estilo. | `IStyled` | `undefined` |
13
+ | `value` | `value` | Define o valor do campo. | `string` | `undefined` |
14
14
 
15
15
 
16
16
  ## Events
17
17
 
18
- | Event | Description | Type |
19
- | --------------- | ----------------------------------- | ------------------ |
20
- | `cancelEdition` | Disparado ao cancelar uma edição | `CustomEvent<any>` |
21
- | `saveEdition` | Evento emitido ao salvar uma edição | `CustomEvent<any>` |
18
+ | Event | Description | Type |
19
+ | --------------- | ------------------------------ | ------------------ |
20
+ | `cancelEdition` | Emitido ao cancelar uma edição | `CustomEvent<any>` |
21
+ | `saveEdition` | Emitido ao salvar uma edição | `CustomEvent<any>` |
22
22
 
23
23
 
24
24
  ## Methods
25
25
 
26
26
  ### `applyFocusSelect() => Promise<void>`
27
27
 
28
- Aplica focus no campo.
28
+ Aplica foco no campo.
29
29
 
30
30
  #### Returns
31
31
 
@@ -7,32 +7,31 @@
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 digitação. | `boolean` | `true` |
14
- | `errorMessage` | `error-message` | Quando um problema de validação, serve como orientação ao usuário | `string` | `undefined` |
15
- | `label` | `label` | Título do campo | `string` | `undefined` |
16
- | `loading` | `loading` | Deixa o componente em modo "carregando". | `boolean` | `undefined` |
17
- | `mask` | `mask` | Aplica uma máscara no conteúdo conforme o padrão estabelecido | `string` | `undefined` |
18
- | `mode` | `mode` | Define o modo do tamanho do campo; opções: slim e regular. | `string` | `"regular"` |
19
- | `noBorder` | `no-border` | Define se o campo contará com bordas ou não | `boolean` | `false` |
20
- | `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` |
21
- | `value` | `value` | Valor digitado pelo usuário. Este valor é o que fica visível no campo. | `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
+ | `mask` | `mask` | Aplica uma máscara no conteúdo conforme o padrão estabelecido | `string` | `undefined` |
17
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
18
+ | `noBorder` | `no-border` | Se true o campo não terá bordas. | `boolean` | `false` |
19
+ | `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
20
+ | `value` | `value` | Define o valor do campo. | `string` | `undefined` |
22
21
 
23
22
 
24
23
  ## Events
25
24
 
26
- | Event | Description | Type |
27
- | ---------- | ----------------------------------------------------------------------- | --------------------- |
28
- | `ezChange` | Evento disparado quando o estado do componente é alterado (onEzChange). | `CustomEvent<string>` |
25
+ | Event | Description | Type |
26
+ | ---------- | ------------------------------------------------------ | --------------------- |
27
+ | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<string>` |
29
28
 
30
29
 
31
30
  ## Methods
32
31
 
33
32
  ### `isInvalid() => Promise<boolean>`
34
33
 
35
- Retorna informando se o campo está inválido (true | false)
34
+ Retorna se o conteúdo é inválido.
36
35
 
37
36
  #### Returns
38
37
 
@@ -42,7 +41,7 @@ Type: `Promise<boolean>`
42
41
 
43
42
  ### `setBlur() => Promise<void>`
44
43
 
45
- Remove o foco no componente de input
44
+ Remove o foco do campo.
46
45
 
47
46
  #### Returns
48
47
 
@@ -52,7 +51,7 @@ Type: `Promise<void>`
52
51
 
53
52
  ### `setFocus() => Promise<void>`
54
53
 
55
- Faz o foco no componente de input
54
+ Aplica o foco no campo.
56
55
 
57
56
  #### Returns
58
57
 
@@ -91,3 +90,33 @@ graph TD;
91
90
  ----------------------------------------------
92
91
 
93
92
 
93
+
94
+
95
+ ## CSS Variables
96
+ | Variable | Description |
97
+ |-|-|
98
+ | --ez-text-input--height | Define a altura do componente. |
99
+ | --ez-text-input--width | Define a largura do componente. |
100
+ | --ez-text-input\_\_icon--width | Define a largura do slot que contém o ícone. |
101
+ | --ez-text-input--height--slim | Define a altura do componente em modo "slim". |
102
+ | --ez-text-input--border-radius | Define o raio da borda do input do componente. |
103
+ | --ez-text-input--font-size | Define o tamanho da fonte do input e label do componente. |
104
+ | --ez-text-input--font-family | Define a família da fonte do input, label e caixa de mensagem do componente. |
105
+ | --ez-text-input--font-weight | Define o peso da fonte do label do componente. |
106
+ | --ez-text-input--color | Define a cor da fonte do input e label do componente. |
107
+ | --ez-text-input\_\_input--background-color | Define a cor de fundo do input. |
108
+ | --ez-text-input\_\_input--border | Define o estilo da borda do input. |
109
+ | --ez-text-input\_\_input--border-color | Define a cor da borda do input. |
110
+ | --ez-text-input\_\_input--focus--border-color | Define a cor da borda do input quando focado. |
111
+ | --ez-text-input\_\_input--disabled--background-color | Define a cor de fundo do input quando desabilitado. |
112
+ | --ez-text-input\_\_input--disabled--color | Define a cor do texto do input. |
113
+ | --ez-text-input\_\_input--error--border-color | Define a cor da borda do input quando com erro. |
114
+ | --ez-text-input\_\_input--noborder-color | Define a cor do input quando não possuir borda |
115
+ | --ez-text-input\_\_input--padding | Define o padding do input |
116
+ | --ez-text-input\_\_message\_box--font-size | Define o tamanho da fonte da mensagem abaixo do input. |
117
+ | --ez-text-input\_\_message\_box--info--color | Define a cor da fonte da mensagem quando info. |
118
+ | --ez-text-input\_\_message\_box--error--color | Define a cor da fonte da mensagem quando erro. |
119
+ | --ez-text-input\_\_label--floating--top | Define o posicionamento do label. |
120
+ | --ez-text-input\_\_label--padding-top | Define o posicionamento do label. |
121
+ | --ez-text-input\_\_label--padding-left | Define o espaçamento esquerdo do label. |
122
+ | --ez-text-input\_\_label--padding-right | Define o espaçamento direito do label. |
@@ -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 digitação. | `boolean` | `true` |
13
- | `errorMessage` | `error-message` | Quando 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` | Define se o componente irá ou não considerar os segundos. | `boolean` | `false` |
17
- | `value` | `value` | Valor que será transmitido para o back-end. | `number` | `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` | `value` | Define o valor do campo. | `number` | `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 quando o estado do componente é alterado (onEzChange). | `CustomEvent<number>` |
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<number>` |
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 input
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
- Faz o foco no componente de input
53
+ Aplica o foco no campo.
54
54
 
55
55
  #### Returns
56
56
 
@@ -7,23 +7,23 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ---------- | ----------- | ------------------------------------------------------------ | --------- | ----------- |
12
- | `canClose` | `can-close` | Controla o uso do icone de fechar o toast. | `boolean` | `true` |
13
- | `fadeTime` | `fade-time` | Controla o tempo de exibição do componente em milissegundos. | `number` | `5000` |
14
- | `message` | `message` | Mensagem exibida no componente. | `string` | `undefined` |
15
- | `useIcon` | `use-icon` | Adiciona ícone de check no componente. | `boolean` | `false` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------- | ----------- | ---------------------------------------------- | --------- | ----------- |
12
+ | `canClose` | `can-close` | Se false, o usuário não consegue fechar. | `boolean` | `true` |
13
+ | `fadeTime` | `fade-time` | Define o tempo de exibição em milissegundos. | `number` | `5000` |
14
+ | `message` | `message` | Mensagem a ser exibida no componente. | `string` | `undefined` |
15
+ | `useIcon` | `use-icon` | Se true permite a utilização do slot de ícone. | `boolean` | `false` |
16
16
 
17
17
 
18
18
  ## Methods
19
19
 
20
- ### `show(message: string, fadeTime: number, useIcon: boolean, canClose?: boolean) => Promise<unknown>`
20
+ ### `show(message: string, fadeTime: number, useIcon: boolean, canClose?: boolean) => Promise<void>`
21
21
 
22
- Exibe o componente na tela.
22
+ Exibe o ez-toast.
23
23
 
24
24
  #### Returns
25
25
 
26
- Type: `Promise<unknown>`
26
+ Type: `Promise<void>`
27
27
 
28
28
 
29
29
 
@@ -31,3 +31,12 @@ Type: `Promise<unknown>`
31
31
  ----------------------------------------------
32
32
 
33
33
 
34
+
35
+
36
+ ## CSS Variables
37
+ | Variable | Description |
38
+ |-|-|
39
+ | --ez-toast\_\_btn\_\_close\_\_image | Contém o ícone de fechamento do toast. |
40
+ | --ez-toast\_\_container-z-index | Define a camada em que o container será exibido. |
41
+ | --ez-toast\_\_container--background-color | Define a cor de fundo do container. |
42
+ | --ez-toast\_\_icon--padding-left | Define o espaçamento à esquerda do ícone. |
@@ -9,30 +9,30 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ---------------- | ----------------- | --------------------------------------------------------------------------- | ---------- | ----------- |
12
- | `enabled` | `enabled` | Deixa o campo disponível ou não para digitação. | `boolean` | `true` |
13
- | `label` | `label` | Título do campo | `string` | `undefined` |
12
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
13
+ | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
14
14
  | `maxFileSize` | `max-file-size` | Define o tamanho máximo (em bytes) de cada arquivo que pode ser transferido | `number` | `undefined` |
15
15
  | `maxFiles` | `max-files` | Define um limite para a quantidade de arquivos | `number` | `undefined` |
16
16
  | `requestHeaders` | `request-headers` | Headers para a requisição Http | `any` | `undefined` |
17
17
  | `urlDelete` | `url-delete` | Define a URL de deleção | `string` | `undefined` |
18
18
  | `urlUpload` | `url-upload` | Define a URL de upload | `string` | `undefined` |
19
- | `value` | -- | Lista de arquivos que será trafegada entre cliente e servidor | `EzFile[]` | `undefined` |
19
+ | `value` | -- | Define o valor do campo. | `EzFile[]` | `undefined` |
20
20
 
21
21
 
22
22
  ## Events
23
23
 
24
- | Event | Description | Type |
25
- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
26
- | `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>` |
27
- | `ezChange` | Evento emitido ao finalizar o upload de um arquivo (onEzChange). | `CustomEvent<EzFile[]>` |
28
- | `ezStartChange` | Evento emitido ao iniciar a alteração (remover ou adicionar um arquivo). | `CustomEvent<WaitingChange>` |
24
+ | Event | Description | Type |
25
+ | ----------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------- |
26
+ | `ezCancelWaitingChange` | Emitido quando não foi possível completar a alteração entre o evento ezStartChange e ezChange. | `CustomEvent<void>` |
27
+ | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<EzFile[]>` |
28
+ | `ezStartChange` | Emitido ao iniciar a alteração (remover ou adicionar um arquivo). | `CustomEvent<WaitingChange>` |
29
29
 
30
30
 
31
31
  ## Methods
32
32
 
33
33
  ### `addFiles(files: Array<File>) => Promise<void>`
34
34
 
35
- Método responsável por adicionar um ou mais arquivos ao componente.
35
+ Adiciona arquivos.
36
36
 
37
37
  #### Returns
38
38
 
@@ -42,7 +42,7 @@ Type: `Promise<void>`
42
42
 
43
43
  ### `setBlur() => Promise<void>`
44
44
 
45
- Remove o foco no componente de upload
45
+ Remove o foco do campo.
46
46
 
47
47
  #### Returns
48
48
 
@@ -52,7 +52,7 @@ Type: `Promise<void>`
52
52
 
53
53
  ### `setFocus() => Promise<void>`
54
54
 
55
- Realiza o foco no componente de upload
55
+ Aplica o foco no campo.
56
56
 
57
57
  #### Returns
58
58
 
@@ -77,3 +77,25 @@ graph TD;
77
77
  ----------------------------------------------
78
78
 
79
79
 
80
+
81
+
82
+ ## CSS Variables
83
+ | Variable | Description |
84
+ |-|-|
85
+ | --ez-upload--height | Define a altura do componente. |
86
+ | --ez-upload--width | Define a largura do componente. |
87
+ | --ez-upload\_\_icon--width | Define a largura do slot que contém o ícone. |
88
+ | --ez-upload\_\_container--background-color | Define a cor de fundo do container. |
89
+ | --ez-upload\_\_color--primary | Define a cor de fundo do container. |
90
+ | --ez-upload--padding--extra-small | Define os espaçamentos extra pequenos no componente. |
91
+ | --ez-upload--padding--small | Define os espaçamentos pequenos no componente. |
92
+ | --ez-upload--padding--medium | Define os espaçamentos médios no componente. |
93
+ | --ez-upload--padding--large | Define os espaçamentos grandes no componente. |
94
+ | --ez-upload\_\_border--color | Define a cor das bordas no componente. |
95
+ | --ez-upload--text-shadow | Define as sombras dos textos do componente. |
96
+ | --ez-upload--text--primary | Define a cor dos textos do componente. |
97
+ | --ez-upload--font-size | Define o tamanho dos textos do componente. |
98
+ | --ez-upload--font-family | Define a família dos textos do componente. |
99
+ | --ez-upload--font-weight | Define o peso dos textos do componente. |
100
+ | --ez-upload\_\_btn\_\_cancel-image | Contém o ícone de cancelamento. |
101
+ | --ez-upload\_\_file-icon-image | Contém o ícone de arquivo. |
@@ -9,7 +9,7 @@
9
9
 
10
10
  ### `getSelectedIndex() => Promise<number>`
11
11
 
12
- Retorna o index que está atualmente ativo e sendo exibido.
12
+ Obtem o índice selecionado.
13
13
 
14
14
  #### Returns
15
15
 
@@ -19,7 +19,7 @@ Type: `Promise<number>`
19
19
 
20
20
  ### `show(index: number) => Promise<void>`
21
21
 
22
- Exibe a aba desejada de acordo com o index passado na tela fazendo com a ativa atual seja removida ou oculta dependendo da hidePolicy.
22
+ Exibe a visão de acordo com o índice.
23
23
 
24
24
  #### Returns
25
25
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "2.3.1",
3
+ "version": "2.3.2",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [