@sankhyalabs/ezui-docs 5.22.0-dev.3 → 5.22.0-dev.31

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 (12) hide show
  1. package/components/ez-button/readme.md +1 -1
  2. package/components/ez-card-item/readme.md +1 -0
  3. package/components/ez-combo-box/readme.md +19 -18
  4. package/components/ez-grid/readme.md +16 -13
  5. package/components/ez-modal/readme.md +1 -0
  6. package/components/ez-modal-container/readme.md +1 -0
  7. package/components/ez-number-input/readme.md +1 -0
  8. package/components/ez-popup/readme.md +8 -7
  9. package/components/ez-search/readme.md +21 -18
  10. package/components/ez-split-button/readme.md +1 -1
  11. package/components/ez-tabselector/readme.md +13 -0
  12. package/package.json +1 -1
package/components/ez-button/readme.md CHANGED
@@ -14,7 +14,7 @@
14
14
  | `image` | `image` | Define o caminho usado nos modos `icon` e `label-icon` para imagens não contempladas na biblioteca de ícones. | `string` | `undefined` |
15
15
  | `label` | `label` | Texto a ser apresentado como título do botão. | `string` | `undefined` |
16
16
  | `mode` | `mode` | Define o modo de uso do botão. | `"icon" \| "label-icon" \| "link" \| "regular"` | `"regular"` |
17
- | `size` | `size` | Define o tamanho do ez-button. | `"large" \| "medium" \| "small"` | `undefined` |
17
+ | `size` | `size` | Define o tamanho do ez-button. | `"large" \| "medium" \| "small" \| "x-small"` | `undefined` |
18
18
 
19
19
 
20
20
  ## Methods
package/components/ez-card-item/readme.md CHANGED
@@ -9,6 +9,7 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ----------- | ------------ | ------------------------------------------------------------------------------------------------------------- | ---------- | ----------- |
12
+ | `compacted` | `compacted` | Determina se o componente será apresentado no modo compacto. | `boolean` | `false` |
12
13
  | `enableKey` | `enable-key` | Determina se a chave do item deve ser exibida. | `boolean` | `true` |
13
14
  | `item` | -- | Determina o conteúdo do card. Deve conter um objeto no formato: `{title: string, key: string, details: any}`. | `CardItem` | `undefined` |
14
15
 
package/components/ez-combo-box/readme.md CHANGED
@@ -7,24 +7,25 @@
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
- | `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
- | `limitCharsToSearch` | `limit-chars-to-search` | Define o limite de caracteres mínimo para realizar uma pesquisa | `number` | `3` |
19
- | `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
20
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
21
- | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
22
- | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `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` |
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
+ | `limitCharsToSearch` | `limit-chars-to-search` | Define o limite de caracteres mínimo para realizar uma pesquisa | `number` | `3` |
19
+ | `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
20
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
21
+ | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
22
+ | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `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
+ | `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` |
26
+ | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
27
+ | `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
28
+ | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
28
29
 
29
30
 
30
31
  ## Events
package/components/ez-grid/readme.md CHANGED
@@ -7,19 +7,22 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------ | -------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
12
- | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
13
- | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
- | `columnfilterDataSource` | -- | Define um `IMultiSelectionListDataSource` responsável por alimentar o filtro de colunas. | `IMultiSelectionListDataSource` | `undefined` |
15
- | `config` | -- | Configuração de exibição da grade. | `IGridConfig` | `undefined` |
16
- | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
17
- | `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas. | `boolean` | `undefined` |
18
- | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
19
- | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
20
- | `serverUrl` | `server-url` | Endereço do servidor para obtenção dos dados. | `string` | `undefined` |
21
- | `statusResolver` | -- | Define um `IStatusResolver` responsável pelo estado da coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
22
- | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------ | -------------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
12
+ | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
13
+ | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
+ | `columnfilterDataSource` | -- | Define um `IMultiSelectionListDataSource` responsável por alimentar o filtro de colunas. | `IMultiSelectionListDataSource` | `undefined` |
15
+ | `config` | -- | Configuração de exibição da grade. | `IGridConfig` | `undefined` |
16
+ | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
17
+ | `enableContinuousInsert` | `enable-continuous-insert` | Ativa/desativa a inserção continua na grade Só funciona quando a prop enableGridInsert está ativa | `boolean` | `true` |
18
+ | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
19
+ | `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas. | `boolean` | `undefined` |
20
+ | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'show'` |
21
+ | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
22
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
23
+ | `serverUrl` | `server-url` | Endereço do servidor para obtenção dos dados. | `string` | `undefined` |
24
+ | `statusResolver` | -- | Define um `IStatusResolver` responsável pelo estado da coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
25
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
23
26
 
24
27
 
25
28
  ## Events
package/components/ez-modal/readme.md CHANGED
@@ -12,6 +12,7 @@
12
12
  | `align` | `align` | Define o alinhamento do ez-modal. | `"left" \| "right"` | `undefined` |
13
13
  | `closeEsc` | `close-esc` | Define se o ez-modal será fechado ao clicar `ESC`. | `boolean` | `false` |
14
14
  | `closeOutsideClick` | `close-outside-click` | Define se o modal será fechado ao clicar fora do conteúdo. | `boolean` | `false` |
15
+ | `closeOutsideLeave` | `close-outside-leave` | Define se o modal será fechado se o mouse sair para fora do conteúdo. | `boolean` | `false` |
15
16
  | `heightMode` | `height-mode` | Ativa o modo Full, permitindo que o Modal expanda-se verticalmente e ocupe todo o espaço disponível. | `"full" \| "regular"` | `"regular"` |
16
17
  | `modalSize` | `modal-size` | Define o tamanho do ez-modal. Devem ser definidas seguindo grid-layout. Exemplo: `col-sd-3`. | `string` | `undefined` |
17
18
  | `opened` | `opened` | Define se o ez-modal está aberto. | `boolean` | `true` |
package/components/ez-modal-container/readme.md CHANGED
@@ -15,6 +15,7 @@
15
15
  | `modalTitle` | `modal-title` | Texto a ser apresentado como título do modal. | `string` | `undefined` |
16
16
  | `okButtonLabel` | `ok-button-label` | Determina o texto do botão de confirmação. | `string` | `undefined` |
17
17
  | `okButtonStatus` | `ok-button-status` | Define o estado do botão de confirmação. | `"DISABLED" \| "ENABLED" \| "HIDDEN"` | `undefined` |
18
+ | `showCloseButton` | `show-close-button` | Define a visibilidade do botão de fechar. | `boolean` | `true` |
18
19
  | `showTitleBar` | `show-title-bar` | Define se o cabeçalho será mostrado. | `boolean` | `true` |
19
20
 
20
21
 
package/components/ez-number-input/readme.md CHANGED
@@ -9,6 +9,7 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------- | --------------------- | ----------- |
12
+ | `allowNegative` | `allow-negative` | Se false, o input não aceitará números negativos. | `boolean` | `true` |
12
13
  | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
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` |
package/components/ez-popup/readme.md CHANGED
@@ -7,13 +7,14 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------ | ------------- | -------------------------------------------------- | ---------------------------------------------------------- | ----------- |
12
- | `ezTitle` | `ez-title` | Texto a ser apresentado como título do componente. | `string` | `undefined` |
13
- | `heightMode` | `height-mode` | Define altura do componente. | `"auto" \| "full"` | `"full"` |
14
- | `opened` | `opened` | Define se o ez-popover está aberto. | `boolean` | `false` |
15
- | `size` | `size` | Define a largura do ez-popup. | `"large" \| "medium" \| "small" \| "x-large" \| "x-small"` | `"medium"` |
16
- | `useHeader` | `use-header` | Define se o componente utilizará cabeçalho. | `boolean` | `true` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------- | ---------------- | ------------------------------------------------------------- | ---------------------------------------------------------- | ----------- |
12
+ | `enabledScroll` | `enabled-scroll` | Possibilita scroll vertical no conteúdo interno do componente | `boolean` | `false` |
13
+ | `ezTitle` | `ez-title` | Texto a ser apresentado como título do componente. | `string` | `undefined` |
14
+ | `heightMode` | `height-mode` | Define altura do componente. | `"auto" \| "full"` | `"full"` |
15
+ | `opened` | `opened` | Define se o ez-popover está aberto. | `boolean` | `false` |
16
+ | `size` | `size` | Define a largura do ez-popup. | `"large" \| "medium" \| "small" \| "x-large" \| "x-small"` | `"medium"` |
17
+ | `useHeader` | `use-header` | Define se o componente utilizará cabeçalho. | `boolean` | `true` |
17
18
 
18
19
 
19
20
  ## Events
package/components/ez-search/readme.md CHANGED
@@ -7,24 +7,27 @@
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
- | `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
- | `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Define se deve ignorar o limite de caracteres mínimo para realizar uma pesquisa | `boolean` | `false` |
17
- | `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
18
- | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
19
- | `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
20
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
21
- | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
22
- | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
23
- | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
24
- | `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
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` |
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
+ | `ensureClearButtonVisible` | `ensure-clear-button-visible` | Garante que o botão de limpar pesquisa está sempre visível | `boolean` | `false` |
15
+ | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
16
+ | `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` |
17
+ | `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Define se deve ignorar o limite de caracteres mínimo para realizar uma pesquisa | `boolean` | `false` |
18
+ | `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
19
+ | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
20
+ | `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
21
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
22
+ | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
23
+ | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
24
+ | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
25
+ | `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
26
+ | `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` |
27
+ | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
28
+ | `suppressPreLoad` | `suppress-pre-load` | Se true, desabilita pré-load das opções ao carregar componente | `boolean` | `false` |
29
+ | `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
30
+ | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
28
31
 
29
32
 
30
33
  ## Events
package/components/ez-split-button/readme.md CHANGED
@@ -17,7 +17,7 @@
17
17
  | `leftTitle` | `left-title` | Texto a ser apresentado como title do botão principal | `string` | `undefined` |
18
18
  | `mode` | `mode` | Define o modo de uso do botão. | `"default" \| "icon-left" \| "icon-only"` | `'default'` |
19
19
  | `rightTitle` | `right-title` | Texto a ser apresentado como title do botão dropdown | `string` | `'Mais opções'` |
20
- | `size` | `size` | Define o tamanho do ez-split-button. | `"large" \| "medium"` | `'medium'` |
20
+ | `size` | `size` | Define o tamanho do ez-split-button. | `"large" \| "medium" \| "small"` | `'medium'` |
21
21
 
22
22
 
23
23
  ## Events
package/components/ez-tabselector/readme.md CHANGED
@@ -21,6 +21,19 @@
21
21
  | `ezChange` | Emitido quando acontece a alteração de valor do componente. | `CustomEvent<Tab>` |
22
22
 
23
23
 
24
+ ## Methods
25
+
26
+ ### `goToTab(tabIndex: number, silent?: boolean) => Promise<void>`
27
+
28
+
29
+
30
+ #### Returns
31
+
32
+ Type: `Promise<void>`
33
+
34
+
35
+
36
+
24
37
  ## Dependencies
25
38
 
26
39
  ### Used by
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "5.22.0-dev.3",
3
+ "version": "5.22.0-dev.31",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [