@sankhyalabs/ezui-docs
Advanced tools
Comparing version 0.0.0-hotfix-rc-KB-74336.0 to 0.0.0-hotfix-rc-KB-75052.0
@@ -30,2 +30,15 @@ # ez-double-list | ||
## Methods | ||
### `resetSelectedLists() => Promise<void>` | ||
#### Returns | ||
Type: `Promise<void>` | ||
## Dependencies | ||
@@ -32,0 +45,0 @@ |
@@ -15,2 +15,3 @@ # ez-grid | ||
| `columnfilterDataSource` | -- | Define um `IMultiSelectionListDataSource` responsável por alimentar o filtro de colunas. | `IMultiSelectionListDataSource` | `undefined` | | ||
| `compact` | `compact` | Define se a grade deve ser exibida em modo compacto | `boolean` | `false` | | ||
| `config` | -- | Configuração de exibição da grade. | `IGridConfig` | `undefined` | | ||
@@ -21,4 +22,5 @@ | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` | | ||
| `enableLockManger` | `enable-lock-manger` | Ativa inserção de registros no modo grade. | `boolean` | `true` | | ||
| `enableRowTableStriped` | `enable-row-table-striped` | Ativa modo de linhas com cores alternadas. | `boolean` | `true` | | ||
| `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas. | `boolean` | `undefined` | | ||
| `outlineMode` | `outline-mode` | Altera visualmente as sombras e bordas do componente Quando true, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando false, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up) | `boolean` | `false` | | ||
| `outlineMode` | `outline-mode` | Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up) | `boolean` | `false` | | ||
| `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'show'` | | ||
@@ -29,2 +31,3 @@ | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` | | ||
| `statusResolver` | -- | Define um `IStatusResolver` responsável pelo estado da coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` | | ||
| `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de chechbox deve ser suprimida | `boolean` | `false` | | ||
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` | | ||
@@ -31,0 +34,0 @@ |
@@ -25,8 +25,9 @@ # ez-list | ||
| Event | Description | Type | | ||
| --------------- | ----------------------------------------------------------- | ---------------------------------------- | | ||
| `ezChange` | Emitido quando acontece a alteração de estado da lista. | `CustomEvent<(ListItem \| ListGroup)[]>` | | ||
| `ezCheckChange` | Emitido quando acontece a alteração de um item do checkbox. | `CustomEvent<ListItem>` | | ||
| `ezDoubleClick` | Emitido quando ocorre um duplo clique em um item da lista. | `CustomEvent<ListItem>` | | ||
| `ezSelectItem` | Emitido sempre que um item da lista for selecionado. | `CustomEvent<ListItem \| ListItem[]>` | | ||
| Event | Description | Type | | ||
| ----------------------- | -------------------------------------------------------------- | ---------------------------------------- | | ||
| `ezChange` | Emitido quando acontece a alteração de estado da lista. | `CustomEvent<(ListItem \| ListGroup)[]>` | | ||
| `ezCheckChange` | Emitido quando acontece a alteração de um item do checkbox. | `CustomEvent<ListItem>` | | ||
| `ezDoubleClick` | Emitido quando ocorre um duplo clique em um item da lista. | `CustomEvent<ListItem>` | | ||
| `ezSelectItem` | Emitido sempre que um item da lista for selecionado. | `CustomEvent<ListItem>` | | ||
| `ezSelectMultipleItems` | Emitido sempre que um ou vários item da lista for selecionado. | `CustomEvent<ListItem[]>` | | ||
@@ -33,0 +34,0 @@ |
@@ -10,25 +10,26 @@ # ez-search | ||
| Property | Attribute | Description | Type | Default | | ||
| ---------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ----------- | | ||
| `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` | | ||
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` | | ||
| `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` | | ||
| `ensureClearButtonVisible` | `ensure-clear-button-visible` | Garante que o botão de limpar pesquisa está sempre visível | `boolean` | `false` | | ||
| `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` | | ||
| `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` | | ||
| `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Define se deve ignorar o limite de caracteres mínimo para realizar uma pesquisa | `boolean` | `false` | | ||
| `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` | | ||
| `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` | | ||
| `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` | | ||
| `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` | | ||
| `noMargin` | `no-margin` | Quando verdadeiro, o campo não terá espaçamento externo. | `boolean` | `false` | | ||
| `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` | | ||
| `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` | | ||
| `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` | | ||
| `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` | | ||
| `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` | | ||
| `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` | | ||
| `suppressPreLoad` | `suppress-pre-load` | Se true, desabilita pré-load das opções ao carregar componente | `boolean` | `true` | | ||
| `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` | | ||
| `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` | | ||
| Property | Attribute | Description | Type | Default | | ||
| ---------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ----------- | | ||
| `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` | | ||
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` | | ||
| `contextProperties` | `context-properties` | Propriedades de contexto da aplicação. | `any` | `undefined` | | ||
| `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` | | ||
| `ensureClearButtonVisible` | `ensure-clear-button-visible` | Garante que o botão de limpar pesquisa está sempre visível | `boolean` | `false` | | ||
| `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` | | ||
| `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` | | ||
| `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Define se deve ignorar o limite de caracteres mínimo para realizar uma pesquisa | `boolean` | `false` | | ||
| `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` | | ||
| `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` | | ||
| `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` | | ||
| `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` | | ||
| `noMargin` | `no-margin` | Quando verdadeiro, o campo não terá espaçamento externo. | `boolean` | `false` | | ||
| `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument, ctxProperties?: any) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` | | ||
| `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` | | ||
| `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` | | ||
| `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` | | ||
| `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` | | ||
| `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` | | ||
| `suppressPreLoad` | `suppress-pre-load` | Se true, desabilita pré-load das opções ao carregar componente | `boolean` | `true` | | ||
| `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` | | ||
| `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` | | ||
@@ -35,0 +36,0 @@ |
@@ -15,3 +15,3 @@ # ez-text-area | ||
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` | | ||
| `enableResize` | `enable-resize` | Ativa a opção de fazer resize do input. | `boolean` | `false` | | ||
| `enableResize` | `enable-resize` | Ativa a opção de fazer resize do input. | `boolean` | `true` | | ||
| `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` | | ||
@@ -18,0 +18,0 @@ | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` | |
@@ -21,6 +21,7 @@ # ez-tree | ||
| Event | Description | Type | | ||
| ------------ | ----------------------------------------------- | ------------------------ | | ||
| `ezChange` | Emitido quando um item é selecionado na árvore. | `CustomEvent<ITreeItem>` | | ||
| `ezOpenItem` | Emitido quando um item é aberto na árvore. | `CustomEvent<ITreeItem>` | | ||
| Event | Description | Type | | ||
| --------------- | ------------------------------------------------- | ------------------------ | | ||
| `ezChange` | Emitido quando um item é selecionado na árvore. | `CustomEvent<ITreeItem>` | | ||
| `ezDbClickItem` | Emitido ao dar clique duplo em um item da árvore. | `CustomEvent<ITreeItem>` | | ||
| `ezOpenItem` | Emitido quando um item é aberto na árvore. | `CustomEvent<ITreeItem>` | | ||
@@ -27,0 +28,0 @@ |
{ | ||
"name": "@sankhyalabs/ezui-docs", | ||
"version": "0.0.0-hotfix-rc-KB-74336.0", | ||
"version": "0.0.0-hotfix-rc-KB-75052.0", | ||
"description": "Documentação da biblioteca de componentes Sankhya.", | ||
@@ -5,0 +5,0 @@ "main": "", |
166007