@sankhyalabs/ezui-docs 0.0.0-feat-dev-41261.2 → 0.0.0-feat-dev-KB-66081.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -7,25 +7,24 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `canShowError`
|
|
13
|
-
| `enabled`
|
|
14
|
-
| `errorMessage`
|
|
15
|
-
| `hideErrorOnFocusOut`
|
|
16
|
-
| `isTextSearch`
|
|
17
|
-
| `label`
|
|
18
|
-
| `limitCharsToSearch`
|
|
19
|
-
| `listOptionsPosition`
|
|
20
|
-
| `mode`
|
|
21
|
-
| `optionLoader`
|
|
22
|
-
| `options`
|
|
23
|
-
| `showOptionValue`
|
|
24
|
-
| `showSelectedValue`
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `value` | `value` | Define o valor do 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
|
+
| `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` |
|
|
16
|
+
| `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
|
|
17
|
+
| `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
|
|
18
|
+
| `limitCharsToSearch` | `limit-chars-to-search` | Define o limite de caracteres mínimo para realizar uma pesquisa | `number` | `3` |
|
|
19
|
+
| `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
|
|
20
|
+
| `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
|
|
21
|
+
| `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
|
|
22
|
+
| `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
|
|
23
|
+
| `showOptionValue` | `show-option-value` | Se true cada opção na lista exibe o `value` junto com `label`. | `boolean` | `false` |
|
|
24
|
+
| `showSelectedValue` | `show-selected-value` | Se true a opção selecionada exibe o `value` junto com `label`. | `boolean` | `false` |
|
|
25
|
+
| `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
|
|
26
|
+
| `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
|
|
27
|
+
| `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
|
|
29
28
|
|
|
30
29
|
|
|
31
30
|
## Events
|
|
@@ -7,25 +7,27 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `asyncSearch`
|
|
13
|
-
| `canShowError`
|
|
14
|
-
| `enabled`
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------------ | -------------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
|
|
12
|
+
| `asyncSearch` | `async-search` | Define se o campo irá funcionar de forma assíncrona. | `boolean` | `false` |
|
|
13
|
+
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
|
|
14
|
+
| `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
|
|
15
|
+
| `enabledIconClick` | `enabled-icon-click` | Se true permite ao usuário interagir com o ícone de pesquisa | `boolean` | `false` |
|
|
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
|
+
| `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
|
|
20
|
+
| `value` | `value` | Define o valor do campo. | `string` | `undefined` |
|
|
20
21
|
|
|
21
22
|
|
|
22
23
|
## Events
|
|
23
24
|
|
|
24
|
-
| Event | Description | Type
|
|
25
|
-
| ------------- | --------------------------------------------------------------------- |
|
|
26
|
-
| `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<string>`
|
|
27
|
-
| `ezFocusIn` | Emitido quando acontece o foco no campo. | `CustomEvent<void>`
|
|
28
|
-
| `
|
|
25
|
+
| Event | Description | Type |
|
|
26
|
+
| ------------- | --------------------------------------------------------------------- | ---------------------- |
|
|
27
|
+
| `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<string>` |
|
|
28
|
+
| `ezFocusIn` | Emitido quando acontece o foco no campo. | `CustomEvent<void>` |
|
|
29
|
+
| `ezIconClick` | Emitido quando tem interação com o Ícone de pesquisa | `CustomEvent<boolean>` |
|
|
30
|
+
| `ezSearching` | Emitido quando está sendo realizada uma pesquisa no modo asyncSearch. | `CustomEvent<string>` |
|
|
29
31
|
|
|
30
32
|
|
|
31
33
|
## Methods
|
|
@@ -40,6 +42,16 @@ Type: `Promise<void>`
|
|
|
40
42
|
|
|
41
43
|
|
|
42
44
|
|
|
45
|
+
### `handleIconClick() => Promise<void>`
|
|
46
|
+
|
|
47
|
+
Método usado para emitir o evento de clique no ícone
|
|
48
|
+
|
|
49
|
+
#### Returns
|
|
50
|
+
|
|
51
|
+
Type: `Promise<void>`
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
43
55
|
### `isInvalid() => Promise<boolean>`
|
|
44
56
|
|
|
45
57
|
Retorna se o conteúdo é inválido.
|
|
@@ -7,16 +7,17 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute
|
|
11
|
-
| --------------------- |
|
|
12
|
-
| `dataSource` | --
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| --------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----------- |
|
|
12
|
+
| `dataSource` | -- | Define a lista inicial do componente. | `(ListItem \| ListGroup)[]` | `[]` |
|
|
13
|
+
| `disableShortcuts` | `disable-shortcuts` | Desabilita os atalhos de teclado. | `boolean` | `false` |
|
|
14
|
+
| `ezDraggable` | `ez-draggable` | Se true habilita `drag and drop` para os itens. | `boolean` | `false` |
|
|
15
|
+
| `ezSelectable` | `ez-selectable` | Se true os itens serão selecionáveis. | `boolean` | `false` |
|
|
16
|
+
| `hoverFeedback` | `hover-feedback` | Quando verdadeiro, ativa o feedback visual ao efetuar houver nos itens da lista. | `boolean` | `false` |
|
|
17
|
+
| `itemLeftSlotBuilder` | -- | Função builder que possibilita gerar conteúdo dinâmico à esquerda do item da lista. * Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
|
|
18
|
+
| `itemSlotBuilder` | -- | Função builder que possibilita alterar como o item da lista vai ser apresentado. Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
|
|
19
|
+
| `listMode` | `list-mode` | Define o modo de apresentação da lista. | `"check" \| "regular"` | `'regular'` |
|
|
20
|
+
| `useGroups` | `use-groups` | Se true os grupos serão exibidos. | `boolean` | `false` |
|
|
20
21
|
|
|
21
22
|
|
|
22
23
|
## Events
|
|
@@ -25,6 +26,7 @@
|
|
|
25
26
|
| --------------- | ----------------------------------------------------------- | ---------------------------------------- |
|
|
26
27
|
| `ezChange` | Emitido quando acontece a alteração de estado da lista. | `CustomEvent<(ListItem \| ListGroup)[]>` |
|
|
27
28
|
| `ezCheckChange` | Emitido quando acontece a alteração de um item do checkbox. | `CustomEvent<ListItem>` |
|
|
29
|
+
| `ezClickItem` | Emitido sempre que um item da lista for clicado. | `CustomEvent<ListItem>` |
|
|
28
30
|
| `ezDoubleClick` | Emitido quando ocorre um duplo clique em um item da lista. | `CustomEvent<ListItem>` |
|
|
29
31
|
| `ezSelectItem` | Emitido sempre que um item da lista for selecionado. | `CustomEvent<ListItem>` |
|
|
30
32
|
|
|
@@ -81,6 +83,26 @@ Type: `Promise<void>`
|
|
|
81
83
|
|
|
82
84
|
|
|
83
85
|
|
|
86
|
+
### `selectNextItem() => Promise<void>`
|
|
87
|
+
|
|
88
|
+
Seleciona o próximo item.
|
|
89
|
+
|
|
90
|
+
#### Returns
|
|
91
|
+
|
|
92
|
+
Type: `Promise<void>`
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
### `selectPreviousItem() => Promise<void>`
|
|
97
|
+
|
|
98
|
+
Seleciona o item anterior.
|
|
99
|
+
|
|
100
|
+
#### Returns
|
|
101
|
+
|
|
102
|
+
Type: `Promise<void>`
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
84
106
|
### `setSelection(selectedItem: ListItem, scrollToOption?: boolean) => Promise<void>`
|
|
85
107
|
|
|
86
108
|
Aplica seleção nas linhas da lista.
|
|
@@ -7,27 +7,26 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `canShowError`
|
|
13
|
-
| `enabled`
|
|
14
|
-
| `ensureClearButtonVisible`
|
|
15
|
-
| `errorMessage`
|
|
16
|
-
| `hideErrorOnFocusOut`
|
|
17
|
-
| `ignoreLimitCharsToSearch`
|
|
18
|
-
| `isTextSearch`
|
|
19
|
-
| `label`
|
|
20
|
-
| `listOptionsPosition`
|
|
21
|
-
| `mode`
|
|
22
|
-
| `optionLoader`
|
|
23
|
-
| `options`
|
|
24
|
-
| `showOptionValue`
|
|
25
|
-
| `showSelectedValue`
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
| `value` | `value` | Define o valor do 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
|
+
| `ensureClearButtonVisible` | `ensure-clear-button-visible` | Garante que o botão de limpar pesquisa está sempre visível | `boolean` | `false` |
|
|
15
|
+
| `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
|
|
16
|
+
| `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` |
|
|
17
|
+
| `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Define se deve ignorar o limite de caracteres mínimo para realizar uma pesquisa | `boolean` | `false` |
|
|
18
|
+
| `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
|
|
19
|
+
| `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
|
|
20
|
+
| `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
|
|
21
|
+
| `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
|
|
22
|
+
| `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
|
|
23
|
+
| `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
|
|
24
|
+
| `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
|
|
25
|
+
| `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
|
|
26
|
+
| `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
|
|
27
|
+
| `suppressPreLoad` | `suppress-pre-load` | Se true, desabilita pré-load das opções ao carregar componente | `boolean` | `false` |
|
|
28
|
+
| `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
|
|
29
|
+
| `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
|
|
31
30
|
|
|
32
31
|
|
|
33
32
|
## Events
|
|
@@ -17,7 +17,6 @@
|
|
|
17
17
|
| `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
|
|
18
18
|
| `noBorder` | `no-border` | Se true o campo não terá bordas. | `boolean` | `false` |
|
|
19
19
|
| `password` | `password` | Se true o campo não terá bordas. | `boolean` | `false` |
|
|
20
|
-
| `removeMask` | `remove-mask` | Para remover a máscara quando fizer um apply no formulário. | `boolean` | `false` |
|
|
21
20
|
| `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
|
|
22
21
|
| `value` | `value` | Define o valor do campo. | `string` | `undefined` |
|
|
23
22
|
|