@sankhyalabs/ezui-docs 5.11.0-dev.1 → 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.
Files changed (7) hide show
  1. package/components/ez-combo-box/readme.md +18 -16
  2. package/components/ez-form/readme.md +4 -3
  3. package/components/ez-form-view/readme.md +4 -3
  4. package/components/ez-grid/subcomponents/readme.md +1 -0
  5. package/components/ez-multi-selection-list/readme.md +7 -6
  6. package/components/ez-search/readme.md +15 -13
  7. package/package.json +1 -1
package/components/ez-combo-box/readme.md CHANGED
@@ -7,22 +7,24 @@
7
7
 
8
8
  ## Properties
9
9
 
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
- | `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
17
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
18
- | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
19
- | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
20
- | `searchMode` | `search-mode` | Se true ativa o modo pesquisa do ez-combo-box. | `boolean` | `undefined` |
21
- | `showOptionValue` | `show-option-value` | Se true cada opção na lista exibe o `value` junto com `label`. | `boolean` | `false` |
22
- | `showSelectedValue` | `show-selected-value` | Se true a opção selecionada exibe o `value` junto com `label`. | `boolean` | `false` |
23
- | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
24
- | `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
25
- | `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
+ | `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` |
26
28
 
27
29
 
28
30
  ## Events
package/components/ez-form/readme.md CHANGED
@@ -16,9 +16,10 @@
16
16
 
17
17
  ## Events
18
18
 
19
- | Event | Description | Type |
20
- | --------- | ------------------------------------------------------------ | ------------------- |
21
- | `ezReady` | Evento disparado quando o formulário está disponível na DOM. | `CustomEvent<void>` |
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
package/components/ez-form-view/readme.md CHANGED
@@ -14,9 +14,10 @@
14
14
 
15
15
  ## Events
16
16
 
17
- | Event | Description | Type |
18
- | ---------------- | ------------------------------------------------------------------- | ---------------------------- |
19
- | `ezContentReady` | Evento emitido quando o componente foi totalmente carregado na DOM. | `CustomEvent<HTMLElement[]>` |
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
package/components/ez-grid/subcomponents/readme.md CHANGED
@@ -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
 
package/components/ez-multi-selection-list/readme.md CHANGED
@@ -7,12 +7,13 @@
7
7
 
8
8
  ## Properties
9
9
 
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
- | `options` | -- | Opções de filtros a serem exibidas na listagem. | `IMultiSelectionOption[]` | `undefined` |
15
- | `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` |
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
package/components/ez-search/readme.md CHANGED
@@ -7,19 +7,21 @@
7
7
 
8
8
  ## Properties
9
9
 
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
- | `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
17
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
18
- | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
19
- | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
20
- | `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
21
- | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
22
- | `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
+ | `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` |
23
25
 
24
26
 
25
27
  ## Events
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "5.11.0-dev.1",
3
+ "version": "5.11.0-dev.10",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [