Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@sankhyalabs/ezui-docs
Advanced tools
@sankhyalabs/ezui-docs - npm Package Compare versions
Comparing version 0.0.0-feat-dev-KB-80103.0 to 0.0.0-feat-dev-KB-80103.1
@@ -22,3 +22,2 @@ # ez-combo-box | ||
| | `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` | | ||
@@ -25,0 +24,0 @@ | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` | |
@@ -18,3 +18,2 @@ # ez-date-input | ||
| | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` | | ||
| | `noMargin` | `no-margin` | Quando verdadeiro, o campo não terá espaçamento. | `boolean` | `false` | | ||
| | `value` | -- | Define o valor do campo. | `Date` | `undefined` | | ||
@@ -21,0 +20,0 @@ |
@@ -18,3 +18,2 @@ # ez-date-time-input | ||
| | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` | | ||
| | `noMargin` | `no-margin` | Quando verdadeiro, o campo não terá espaçamento. | `boolean` | `false` | | ||
| | `showSeconds` | `show-seconds` | Se true considera segundos. | `boolean` | `false` | | ||
@@ -21,0 +20,0 @@ | `value` | -- | Define o valor do campo. | `Date` | `undefined` | |
@@ -30,2 +30,15 @@ # ez-double-list | ||
| ## Methods | ||
| ### `resetSelectedLists() => Promise<void>` | ||
| #### Returns | ||
| Type: `Promise<void>` | ||
| ## Dependencies | ||
@@ -32,0 +45,0 @@ |
@@ -19,3 +19,2 @@ # ez-filter-input | ||
| | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` | | ||
| | `noMargin` | `no-margin` | Quando verdadeiro, o campo não terá espaçamento. | `boolean` | `false` | | ||
| | `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` | | ||
@@ -22,0 +21,0 @@ | `value` | `value` | Define o valor do campo. | `string` | `undefined` | |
@@ -10,20 +10,24 @@ # ez-grid | ||
| | Property | Attribute | Description | Type | Default | | ||
| | ------------------------ | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- | | ||
| | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` | | ||
| | `boxShadow` | `box-shadow` | 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` | `true` | | ||
| | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` | | ||
| | `columnfilterDataSource` | -- | Define um `IMultiSelectionListDataSource` responsável por alimentar o filtro de colunas. | `IMultiSelectionListDataSource` | `undefined` | | ||
| | `config` | -- | Configuração de exibição da grade. | `IGridConfig` | `undefined` | | ||
| | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` | | ||
| | `enableContinuousInsert` | `enable-continuous-insert` | Ativa/desativa a inserção continua na grade Só funciona quando a prop enableGridInsert está ativa | `boolean` | `true` | | ||
| | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` | | ||
| | `enableLockManger` | `enable-lock-manger` | Ativa inserção de registros no modo grade. | `boolean` | `true` | | ||
| | `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas. | `boolean` | `undefined` | | ||
| | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'show'` | | ||
| | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` | | ||
| | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` | | ||
| | `serverUrl` | `server-url` | Endereço do servidor para obtenção dos dados. | `string` | `undefined` | | ||
| | `statusResolver` | -- | Define um `IStatusResolver` responsável pelo estado da coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` | | ||
| | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` | | ||
| | Property | Attribute | Description | Type | Default | | ||
| | ------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- | | ||
| | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` | | ||
| | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` | | ||
| | `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` | | ||
| | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` | | ||
| | `enableContinuousInsert` | `enable-continuous-insert` | Ativa/desativa a inserção continua na grade Só funciona quando a prop enableGridInsert está ativa | `boolean` | `true` | | ||
| | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` | | ||
| | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` | | ||
| | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa inserção de registros no modo grade pela Taskbar. | `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 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'` | | ||
| | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` | | ||
| | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` | | ||
| | `serverUrl` | `server-url` | Endereço do servidor para obtenção dos dados. | `string` | `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` | | ||
@@ -30,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 @@ |
@@ -19,3 +19,2 @@ # ez-number-input | ||
| | `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` | | ||
| | `precision` | `precision` | Define quantas casas decimais serão exibidas. Caso haja mais casas haverá arredondamento. | `number` | `undefined` | | ||
@@ -22,0 +21,0 @@ | `prettyPrecision` | `pretty-precision` | Define qual é o mínimo de casas depois da vírgula. Exemplo: 1,1 será exibido como 1,1000 quando `prettyPrecision = 4`. | `number` | `undefined` | |
@@ -10,25 +10,25 @@ # 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"` | | ||
| | `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 +35,0 @@ |
@@ -10,6 +10,7 @@ # ez-split-panel | ||
| | Property | Attribute | Description | Type | Default | | ||
| | ---------------- | ------------------ | ------------------------------------------------------------------------ | ------------------- | ---------- | | ||
| | `anchorToExpand` | `anchor-to-expand` | Responsável por definir o painel que limita o tamanho do item expandido. | `boolean` | `false` | | ||
| | `direction` | `direction` | | `"column" \| "row"` | `'column'` | | ||
| | Property | Attribute | Description | Type | Default | | ||
| | ---------------- | ------------------ | -------------------------------------------------------------------------------------- | ------------------- | ---------- | | ||
| | `anchorToExpand` | `anchor-to-expand` | Responsável por definir o painel que limita o tamanho do item expandido. | `boolean` | `false` | | ||
| | `direction` | `direction` | | `"column" \| "row"` | `'column'` | | ||
| | `structural` | `structural` | Define se o painel está sendo utilizado como estrutura para apresentação de outro item | `boolean` | `false` | | ||
@@ -16,0 +17,0 @@ |
@@ -10,7 +10,8 @@ # ez-split-item | ||
| | Property | Attribute | Description | Type | Default | | ||
| | -------------- | --------------- | ----------------------------------- | --------- | ----------- | | ||
| | `enableExpand` | `enable-expand` | Define se o item pode ser expandido | `boolean` | `true` | | ||
| | `label` | `label` | Define um título para o painel. | `string` | `undefined` | | ||
| | `size` | `size` | Define o tamanho inicial do painel. | `string` | `undefined` | | ||
| | Property | Attribute | Description | Type | Default | | ||
| | -------------- | --------------- | -------------------------------------------------------------------------------------- | --------- | ----------- | | ||
| | `enableExpand` | `enable-expand` | Define se o item pode ser expandido | `boolean` | `true` | | ||
| | `label` | `label` | Define um título para o painel. | `string` | `undefined` | | ||
| | `size` | `size` | Define o tamanho inicial do painel. | `string` | `undefined` | | ||
| | `structural` | `structural` | Define se o painel está sendo utilizado como estrutura para apresentação de outro item | `boolean` | `false` | | ||
@@ -17,0 +18,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,3 +21,2 @@ # ez-text-input | ||
| | `noBorder` | `no-border` | Se true o campo não terá bordas. | `boolean` | `false` | | ||
| | `noMargin` | `no-margin` | Quando verdadeiro, o campo não terá espaçamento externo. | `boolean` | `false` | | ||
| | `password` | `password` | Se true o campo não terá bordas. | `boolean` | `false` | | ||
@@ -24,0 +23,0 @@ | `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` | |
@@ -18,3 +18,2 @@ # ez-time-input | ||
| | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` | | ||
| | `noMargin` | `no-margin` | Quando verdadeiro, o campo não terá espaçamento. | `boolean` | `false` | | ||
| | `showSeconds` | `show-seconds` | Se true considera segundos. | `boolean` | `false` | | ||
@@ -21,0 +20,0 @@ | `value` | `value` | Define o valor do campo. | `number` | `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-feat-dev-KB-80103.0", | ||
| "version": "0.0.0-feat-dev-KB-80103.1", | ||
| "description": "Documentação da biblioteca de componentes Sankhya.", | ||
@@ -5,0 +5,0 @@ "main": "", |
No alert changes
Improved metrics
- Total package byte prevSize
- increased by1.39%
165286
No dependency changes