@sankhyalabs/ezui-docs 0.0.0-feat-dev-KB-80103.2 → 0.0.0-feat-dev-KB-74304.0

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.
@@ -19,6 +19,7 @@
19
19
  | `limitCharsToSearch` | `limit-chars-to-search` | Define o limite de caracteres mínimo para realizar uma pesquisa | `number` | `3` |
20
20
  | `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
21
21
  | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
22
+ | `noMargin` | `no-margin` | Quando verdadeiro, o campo não terá espaçamento externo. | `boolean` | `false` |
22
23
  | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
23
24
  | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
24
25
  | `showOptionValue` | `show-option-value` | Se true cada opção na lista exibe o `value` junto com `label`. | `boolean` | `false` |
@@ -15,6 +15,7 @@
15
15
  | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
16
16
  | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
17
17
  | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
18
+ | `noMargin` | `no-margin` | Quando verdadeiro, o campo não terá espaçamento. | `boolean` | `false` |
18
19
  | `value` | -- | Define o valor do campo. | `Date` | `undefined` |
19
20
 
20
21
 
@@ -15,6 +15,7 @@
15
15
  | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
16
16
  | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
17
17
  | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
18
+ | `noMargin` | `no-margin` | Quando verdadeiro, o campo não terá espaçamento. | `boolean` | `false` |
18
19
  | `showSeconds` | `show-seconds` | Se true considera segundos. | `boolean` | `false` |
19
20
  | `value` | -- | Define o valor do campo. | `Date` | `undefined` |
20
21
 
@@ -27,19 +27,6 @@
27
27
  | `ezRightListChanged` | | `CustomEvent<ListItem[]>` |
28
28
 
29
29
 
30
- ## Methods
31
-
32
- ### `resetSelectedLists() => Promise<void>`
33
-
34
-
35
-
36
- #### Returns
37
-
38
- Type: `Promise<void>`
39
-
40
-
41
-
42
-
43
30
  ## Dependencies
44
31
 
45
32
  ### Depends on
@@ -16,6 +16,7 @@
16
16
  | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
17
17
  | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
18
18
  | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
19
+ | `noMargin` | `no-margin` | Quando verdadeiro, o campo não terá espaçamento. | `boolean` | `false` |
19
20
  | `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
20
21
  | `value` | `value` | Define o valor do campo. | `string` | `undefined` |
21
22
 
@@ -10,24 +10,21 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
12
12
  | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
13
+ | `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` |
13
14
  | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
15
  | `columnfilterDataSource` | -- | Define um `IMultiSelectionListDataSource` responsável por alimentar o filtro de colunas. | `IMultiSelectionListDataSource` | `undefined` |
15
- | `compact` | `compact` | Define se a grade deve ser exibida em modo compacto | `boolean` | `false` |
16
16
  | `config` | -- | Configuração de exibição da grade. | `IGridConfig` | `undefined` |
17
17
  | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
18
18
  | `enableContinuousInsert` | `enable-continuous-insert` | Ativa/desativa a inserção continua na grade Só funciona quando a prop enableGridInsert está ativa | `boolean` | `true` |
19
19
  | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
20
20
  | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
21
21
  | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa inserção de registros no modo grade pela Taskbar. | `boolean` | `true` |
22
- | `enableRowTableStriped` | `enable-row-table-striped` | Ativa modo de linhas com cores alternadas. | `boolean` | `true` |
23
22
  | `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas. | `boolean` | `undefined` |
24
- | `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` |
25
23
  | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'show'` |
26
24
  | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
27
25
  | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
28
26
  | `serverUrl` | `server-url` | Endereço do servidor para obtenção dos dados. | `string` | `undefined` |
29
27
  | `statusResolver` | -- | Define um `IStatusResolver` responsável pelo estado da coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
30
- | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de chechbox deve ser suprimida | `boolean` | `false` |
31
28
  | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
32
29
 
33
30
 
@@ -239,18 +236,16 @@ Type: `Promise<void>`
239
236
 
240
237
  ### Depends on
241
238
 
242
- - [ez-popover](../ez-popover)
243
- - [ez-icon](../ez-icon)
244
239
  - [ez-button](../ez-button)
245
240
  - [filter-column](subcomponents)
241
+ - [ez-icon](../ez-icon)
246
242
 
247
243
  ### Graph
248
244
  ```mermaid
249
245
  graph TD;
250
- ez-grid --> ez-popover
251
- ez-grid --> ez-icon
252
246
  ez-grid --> ez-button
253
247
  ez-grid --> filter-column
248
+ ez-grid --> ez-icon
254
249
  ez-button --> ez-icon
255
250
  filter-column --> ez-popover
256
251
  filter-column --> ez-button
@@ -22,13 +22,12 @@
22
22
 
23
23
  ## Events
24
24
 
25
- | Event | Description | Type |
26
- | ----------------------- | -------------------------------------------------------------- | ---------------------------------------- |
27
- | `ezChange` | Emitido quando acontece a alteração de estado da lista. | `CustomEvent<(ListItem \| ListGroup)[]>` |
28
- | `ezCheckChange` | Emitido quando acontece a alteração de um item do checkbox. | `CustomEvent<ListItem>` |
29
- | `ezDoubleClick` | Emitido quando ocorre um duplo clique em um item da lista. | `CustomEvent<ListItem>` |
30
- | `ezSelectItem` | Emitido sempre que um item da lista for selecionado. | `CustomEvent<ListItem>` |
31
- | `ezSelectMultipleItems` | Emitido sempre que um ou vários item da lista for selecionado. | `CustomEvent<ListItem[]>` |
25
+ | Event | Description | Type |
26
+ | --------------- | ----------------------------------------------------------- | ---------------------------------------- |
27
+ | `ezChange` | Emitido quando acontece a alteração de estado da lista. | `CustomEvent<(ListItem \| ListGroup)[]>` |
28
+ | `ezCheckChange` | Emitido quando acontece a alteração de um item do checkbox. | `CustomEvent<ListItem>` |
29
+ | `ezDoubleClick` | Emitido quando ocorre um duplo clique em um item da lista. | `CustomEvent<ListItem>` |
30
+ | `ezSelectItem` | Emitido sempre que um item da lista for selecionado. | `CustomEvent<ListItem \| ListItem[]>` |
32
31
 
33
32
 
34
33
  ## Methods
@@ -16,6 +16,7 @@
16
16
  | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
17
17
  | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
18
18
  | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
19
+ | `noMargin` | `no-margin` | Quando verdadeiro, o campo não terá espaçamento externo. | `boolean` | `false` |
19
20
  | `precision` | `precision` | Define quantas casas decimais serão exibidas. Caso haja mais casas haverá arredondamento. | `number` | `undefined` |
20
21
  | `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` |
21
22
  | `value` | `value` | Define o valor do campo. | `number` | `undefined` |
@@ -70,13 +70,11 @@ Type: `Promise<void>`
70
70
 
71
71
  ### Used by
72
72
 
73
- - [ez-grid](../ez-grid)
74
73
  - [filter-column](../ez-grid/subcomponents)
75
74
 
76
75
  ### Graph
77
76
  ```mermaid
78
77
  graph TD;
79
- ez-grid --> ez-popover
80
78
  filter-column --> ez-popover
81
79
  style ez-popover fill:#f9f,stroke:#333,stroke-width:4px
82
80
  ```
@@ -7,29 +7,29 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ---------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ----------- |
12
- | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
13
- | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
14
- | `contextProperties` | `context-properties` | Propriedades de contexto da aplicação. | `any` | `undefined` |
15
- | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
16
- | `ensureClearButtonVisible` | `ensure-clear-button-visible` | Garante que o botão de limpar pesquisa está sempre visível | `boolean` | `false` |
17
- | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
18
- | `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` |
19
- | `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Define se deve ignorar o limite de caracteres mínimo para realizar uma pesquisa | `boolean` | `false` |
20
- | `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
21
- | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
22
- | `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
23
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
24
- | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument, ctxProperties?: any) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
25
- | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
26
- | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
27
- | `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
28
- | `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` |
29
- | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
30
- | `suppressPreLoad` | `suppress-pre-load` | Se true, desabilita pré-load das opções ao carregar componente | `boolean` | `true` |
31
- | `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
32
- | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ----------- |
12
+ | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
13
+ | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
14
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
15
+ | `ensureClearButtonVisible` | `ensure-clear-button-visible` | Garante que o botão de limpar pesquisa está sempre visível | `boolean` | `false` |
16
+ | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
17
+ | `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` |
18
+ | `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Define se deve ignorar o limite de caracteres mínimo para realizar uma pesquisa | `boolean` | `false` |
19
+ | `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
20
+ | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
21
+ | `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
22
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
23
+ | `noMargin` | `no-margin` | Quando verdadeiro, o campo não terá espaçamento externo. | `boolean` | `false` |
24
+ | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
25
+ | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
26
+ | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
27
+ | `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
28
+ | `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` |
29
+ | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
30
+ | `suppressPreLoad` | `suppress-pre-load` | Se true, desabilita pré-load das opções ao carregar componente | `boolean` | `true` |
31
+ | `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
32
+ | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
33
33
 
34
34
 
35
35
  ## Events
@@ -7,11 +7,10 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ---------------- | ------------------ | -------------------------------------------------------------------------------------- | ------------------- | ---------- |
12
- | `anchorToExpand` | `anchor-to-expand` | Responsável por definir o painel que limita o tamanho do item expandido. | `boolean` | `false` |
13
- | `direction` | `direction` | | `"column" \| "row"` | `'column'` |
14
- | `structural` | `structural` | Define se o painel está sendo utilizado como estrutura para apresentação de outro item | `boolean` | `false` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------- | ------------------ | ------------------------------------------------------------------------ | ------------------- | ---------- |
12
+ | `anchorToExpand` | `anchor-to-expand` | Responsável por definir o painel que limita o tamanho do item expandido. | `boolean` | `false` |
13
+ | `direction` | `direction` | | `"column" \| "row"` | `'column'` |
15
14
 
16
15
 
17
16
  ## Events
@@ -7,12 +7,11 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------- | --------------- | -------------------------------------------------------------------------------------- | --------- | ----------- |
12
- | `enableExpand` | `enable-expand` | Define se o item pode ser expandido | `boolean` | `true` |
13
- | `label` | `label` | Define um título para o painel. | `string` | `undefined` |
14
- | `size` | `size` | Define o tamanho inicial do painel. | `string` | `undefined` |
15
- | `structural` | `structural` | Define se o painel está sendo utilizado como estrutura para apresentação de outro item | `boolean` | `false` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | --------------- | ----------------------------------- | --------- | ----------- |
12
+ | `enableExpand` | `enable-expand` | Define se o item pode ser expandido | `boolean` | `true` |
13
+ | `label` | `label` | Define um título para o painel. | `string` | `undefined` |
14
+ | `size` | `size` | Define o tamanho inicial do painel. | `string` | `undefined` |
16
15
 
17
16
 
18
17
  ## Dependencies
@@ -12,7 +12,7 @@
12
12
  | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
13
13
  | `autoRows` | `auto-rows` | Ativa a opção de fazer as linhas do componente serem baseados na altura máxima. | `boolean` | `false` |
14
14
  | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
15
- | `enableResize` | `enable-resize` | Ativa a opção de fazer resize do input. | `boolean` | `true` |
15
+ | `enableResize` | `enable-resize` | Ativa a opção de fazer resize do input. | `boolean` | `false` |
16
16
  | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
17
17
  | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
18
18
  | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
@@ -18,6 +18,7 @@
18
18
  | `mask` | `mask` | Aplica uma máscara no conteúdo conforme o padrão estabelecido | `string` | `undefined` |
19
19
  | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
20
20
  | `noBorder` | `no-border` | Se true o campo não terá bordas. | `boolean` | `false` |
21
+ | `noMargin` | `no-margin` | Quando verdadeiro, o campo não terá espaçamento externo. | `boolean` | `false` |
21
22
  | `password` | `password` | Se true o campo não terá bordas. | `boolean` | `false` |
22
23
  | `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
23
24
  | `value` | `value` | Define o valor do campo. | `string` | `undefined` |
@@ -15,6 +15,7 @@
15
15
  | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
16
16
  | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
17
17
  | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
18
+ | `noMargin` | `no-margin` | Quando verdadeiro, o campo não terá espaçamento. | `boolean` | `false` |
18
19
  | `showSeconds` | `show-seconds` | Se true considera segundos. | `boolean` | `false` |
19
20
  | `value` | `value` | Define o valor do campo. | `number` | `undefined` |
20
21
 
@@ -18,11 +18,10 @@
18
18
 
19
19
  ## Events
20
20
 
21
- | Event | Description | Type |
22
- | --------------- | ------------------------------------------------- | ------------------------ |
23
- | `ezChange` | Emitido quando um item é selecionado na árvore. | `CustomEvent<ITreeItem>` |
24
- | `ezDbClickItem` | Emitido ao dar clique duplo em um item da árvore. | `CustomEvent<ITreeItem>` |
25
- | `ezOpenItem` | Emitido quando um item é aberto na árvore. | `CustomEvent<ITreeItem>` |
21
+ | Event | Description | Type |
22
+ | ------------ | ----------------------------------------------- | ------------------------ |
23
+ | `ezChange` | Emitido quando um item é selecionado na árvore. | `CustomEvent<ITreeItem>` |
24
+ | `ezOpenItem` | Emitido quando um item é aberto na árvore. | `CustomEvent<ITreeItem>` |
26
25
 
27
26
 
28
27
  ## Methods
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "0.0.0-feat-dev-KB-80103.2",
3
+ "version": "0.0.0-feat-dev-KB-74304.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [