@sankhyalabs/ezui-docs 5.10.8 → 5.11.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.
- package/components/ez-calendar/readme.md +11 -1
- package/components/ez-combo-box/readme.md +28 -15
- package/components/ez-date-input/readme.md +10 -0
- package/components/ez-date-time-input/readme.md +10 -0
- package/components/ez-form/readme.md +4 -3
- package/components/ez-form-view/readme.md +4 -3
- package/components/ez-grid/readme.md +3 -0
- package/components/ez-grid/subcomponents/readme.md +1 -0
- package/components/ez-multi-selection-list/readme.md +7 -6
- package/components/ez-number-input/readme.md +11 -1
- package/components/ez-search/readme.md +25 -12
- package/components/ez-text-area/readme.md +1 -0
- package/components/ez-text-input/readme.md +1 -1
- package/components/ez-time-input/readme.md +1 -1
- package/package.json +1 -1
|
@@ -24,9 +24,19 @@
|
|
|
24
24
|
|
|
25
25
|
## Methods
|
|
26
26
|
|
|
27
|
+
### `fitHorizontal(rightOffset: number) => Promise<void>`
|
|
28
|
+
|
|
29
|
+
Ajusta o posicionamento horizontal do ez-calendar conforme a disponibilidade de espaço.
|
|
30
|
+
|
|
31
|
+
#### Returns
|
|
32
|
+
|
|
33
|
+
Type: `Promise<void>`
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
27
37
|
### `fitVertical(topOffset: number, bottomOffset: number) => Promise<void>`
|
|
28
38
|
|
|
29
|
-
Ajusta o posicionamento do ez-calendar conforme a disponibilidade de espaço.
|
|
39
|
+
Ajusta o posicionamento vertical do ez-calendar conforme a disponibilidade de espaço.
|
|
30
40
|
|
|
31
41
|
#### Returns
|
|
32
42
|
|
|
@@ -7,21 +7,24 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute
|
|
11
|
-
| --------------------- |
|
|
12
|
-
| `canShowError` | `can-show-error`
|
|
13
|
-
| `enabled` | `enabled`
|
|
14
|
-
| `errorMessage` | `error-message`
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
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
|
+
| `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
|
|
19
|
+
| `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
|
|
20
|
+
| `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
|
|
21
|
+
| `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
|
|
22
|
+
| `searchMode` | `search-mode` | Se true ativa o modo pesquisa do ez-combo-box. | `boolean` | `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` |
|
|
25
28
|
|
|
26
29
|
|
|
27
30
|
## Events
|
|
@@ -43,6 +46,16 @@ Type: `Promise<void>`
|
|
|
43
46
|
|
|
44
47
|
|
|
45
48
|
|
|
49
|
+
### `getValueAsync() => Promise<unknown>`
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
#### Returns
|
|
54
|
+
|
|
55
|
+
Type: `Promise<unknown>`
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
46
59
|
### `isInvalid() => Promise<boolean>`
|
|
47
60
|
|
|
48
61
|
Retorna se o conteúdo é inválido.
|
|
@@ -16,9 +16,10 @@
|
|
|
16
16
|
|
|
17
17
|
## Events
|
|
18
18
|
|
|
19
|
-
| Event
|
|
20
|
-
|
|
|
21
|
-
| `ezReady`
|
|
19
|
+
| Event | Description | Type |
|
|
20
|
+
| ---------------- | ------------------------------------------------------------------------------- | ------------------------ |
|
|
21
|
+
| `ezReady` | Evento disparado quando o formulário está disponível na DOM. | `CustomEvent<void>` |
|
|
22
|
+
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<FormItems>` |
|
|
22
23
|
|
|
23
24
|
|
|
24
25
|
## Methods
|
|
@@ -14,9 +14,10 @@
|
|
|
14
14
|
|
|
15
15
|
## Events
|
|
16
16
|
|
|
17
|
-
| Event | Description
|
|
18
|
-
| ---------------- |
|
|
19
|
-
| `ezContentReady` | Evento emitido quando o componente foi totalmente carregado na DOM.
|
|
17
|
+
| Event | Description | Type |
|
|
18
|
+
| ---------------- | ------------------------------------------------------------------------------- | ---------------------------- |
|
|
19
|
+
| `ezContentReady` | Evento emitido quando o componente foi totalmente carregado na DOM. | `CustomEvent<HTMLElement[]>` |
|
|
20
|
+
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<FormItems>` |
|
|
20
21
|
|
|
21
22
|
|
|
22
23
|
## Methods
|
|
@@ -9,13 +9,16 @@
|
|
|
9
9
|
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
|
11
11
|
| ------------------------ | -------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
|
|
12
|
+
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
|
12
13
|
| `columnfilterDataSource` | -- | Define um `IMultiSelectionListDataSource` responsável por alimentar o filtro de colunas. | `IMultiSelectionListDataSource` | `undefined` |
|
|
13
14
|
| `config` | -- | Configuração de exibição da grade. | `IGridConfig` | `undefined` |
|
|
14
15
|
| `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
|
|
15
16
|
| `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas. | `boolean` | `undefined` |
|
|
17
|
+
| `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
|
|
16
18
|
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
|
|
17
19
|
| `serverUrl` | `server-url` | Endereço do servidor para obtenção dos dados. | `string` | `undefined` |
|
|
18
20
|
| `statusResolver` | -- | Define um `IStatusResolver` responsável pelo estado da coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
|
21
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
|
19
22
|
|
|
20
23
|
|
|
21
24
|
## Events
|
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
| `dataSource` | -- | | `IMultiSelectionListDataSource` | `undefined` |
|
|
15
15
|
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
|
16
16
|
| `gridHeaderHidden` | `grid-header-hidden` | | `boolean` | `false` |
|
|
17
|
+
| `noHeaderTaskBar` | `no-header-task-bar` | | `boolean` | `false` |
|
|
17
18
|
| `opened` | `opened` | | `boolean` | `true` |
|
|
18
19
|
| `options` | -- | | `IMultiSelectionOption[]` | `undefined` |
|
|
19
20
|
|
|
@@ -7,12 +7,13 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `columnName`
|
|
13
|
-
| `dataSource`
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ----------- |
|
|
12
|
+
| `columnName` | `column-name` | Nome da coluna onde serão aplicadas as opções selecionadas. | `string` | `undefined` |
|
|
13
|
+
| `dataSource` | -- | Classe que implementa o método fetchData, responsável por realizar a pesquisa dos dados, com base no termo informado pelo usuário. | `IMultiSelectionListDataSource` | `undefined` |
|
|
14
|
+
| `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
|
|
15
|
+
| `options` | -- | Opções de filtros a serem exibidas na listagem. | `IMultiSelectionOption[]` | `undefined` |
|
|
16
|
+
| `useOptions` | `use-options` | Indica se deve ser exibida lista de opções do atributo options (true), ou se deve utilizar o datasource (false) | `boolean` | `false` |
|
|
16
17
|
|
|
17
18
|
|
|
18
19
|
## Events
|
|
@@ -30,6 +30,16 @@
|
|
|
30
30
|
|
|
31
31
|
## Methods
|
|
32
32
|
|
|
33
|
+
### `getValueAsync() => Promise<number>`
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
#### Returns
|
|
38
|
+
|
|
39
|
+
Type: `Promise<number>`
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
33
43
|
### `isInvalid() => Promise<boolean>`
|
|
34
44
|
|
|
35
45
|
Retorna se o conteúdo é inválido.
|
|
@@ -50,7 +60,7 @@ Type: `Promise<void>`
|
|
|
50
60
|
|
|
51
61
|
|
|
52
62
|
|
|
53
|
-
### `setFocus() => Promise<void>`
|
|
63
|
+
### `setFocus(options?: TFocusOptions) => Promise<void>`
|
|
54
64
|
|
|
55
65
|
Aplica o foco no campo.
|
|
56
66
|
|
|
@@ -7,18 +7,21 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute
|
|
11
|
-
| --------------------- |
|
|
12
|
-
| `canShowError` | `can-show-error`
|
|
13
|
-
| `enabled` | `enabled`
|
|
14
|
-
| `errorMessage` | `error-message`
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
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
|
+
| `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
|
|
19
|
+
| `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
|
|
20
|
+
| `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
|
|
21
|
+
| `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
|
|
22
|
+
| `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
|
|
23
|
+
| `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
|
|
24
|
+
| `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
|
|
22
25
|
|
|
23
26
|
|
|
24
27
|
## Events
|
|
@@ -40,6 +43,16 @@ Type: `Promise<void>`
|
|
|
40
43
|
|
|
41
44
|
|
|
42
45
|
|
|
46
|
+
### `getValueAsync() => Promise<unknown>`
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
#### Returns
|
|
51
|
+
|
|
52
|
+
Type: `Promise<unknown>`
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
43
56
|
### `isInvalid() => Promise<boolean>`
|
|
44
57
|
|
|
45
58
|
Retorna se o conteúdo é inválido.
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
|
11
11
|
| -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
|
|
12
12
|
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
|
|
13
|
+
| `enableResize` | `enable-resize` | Ativa a opção de fazer resize do input. | `boolean` | `false` |
|
|
13
14
|
| `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
|
|
14
15
|
| `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
|
|
15
16
|
| `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
|