@sankhyalabs/ezui-docs 5.11.0 → 5.12.0-dev.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.
- package/components/ez-combo-box/readme.md +1 -0
- package/components/ez-form/readme.md +4 -3
- package/components/ez-form-view/readme.md +4 -3
- package/components/ez-grid/subcomponents/readme.md +1 -0
- package/components/ez-multi-selection-list/readme.md +7 -6
- package/components/ez-search/readme.md +1 -0
- package/package.json +1 -1
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
|
|
14
14
|
| `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
|
|
15
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` |
|
|
16
17
|
| `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
|
|
17
18
|
| `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
|
|
18
19
|
| `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
|
|
@@ -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
|
|
@@ -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
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
|
|
14
14
|
| `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
|
|
15
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` |
|
|
16
17
|
| `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
|
|
17
18
|
| `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
|
|
18
19
|
| `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
|