@sankhyalabs/ezui-docs 0.0.0-bugfix-dev-KB-77126.0 → 0.0.0-bugfix-dev-KB-77074.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.
Files changed (12) hide show
  1. package/components/ez-combo-box/readme.md +2 -3
  2. package/components/ez-date-input/readme.md +1 -2
  3. package/components/ez-date-time-input/readme.md +1 -2
  4. package/components/ez-filter-input/readme.md +28 -17
  5. package/components/ez-grid/readme.md +0 -21
  6. package/components/ez-list/readme.md +32 -10
  7. package/components/ez-number-input/readme.md +0 -1
  8. package/components/ez-search/readme.md +1 -2
  9. package/components/ez-text-area/readme.md +0 -2
  10. package/components/ez-text-input/readme.md +12 -14
  11. package/components/ez-time-input/readme.md +0 -1
  12. package/package.json +1 -1
package/components/ez-combo-box/readme.md CHANGED
@@ -9,7 +9,6 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ---------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ----------- |
12
- | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
13
12
  | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
14
13
  | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
15
14
  | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
@@ -23,7 +22,7 @@
23
22
  | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
24
23
  | `showOptionValue` | `show-option-value` | Se true cada opção na lista exibe o `value` junto com `label`. | `boolean` | `false` |
25
24
  | `showSelectedValue` | `show-selected-value` | Se true a opção selecionada exibe o `value` junto com `label`. | `boolean` | `false` |
26
- | `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `true` |
25
+ | `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` |
27
26
  | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
28
27
  | `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
29
28
  | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
@@ -78,7 +77,7 @@ Type: `Promise<void>`
78
77
 
79
78
 
80
79
 
81
- ### `setFocus(options?: TFocusOptions) => Promise<void>`
80
+ ### `setFocus() => Promise<void>`
82
81
 
83
82
  Aplica o foco no campo.
84
83
 
package/components/ez-date-input/readme.md CHANGED
@@ -9,7 +9,6 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
- | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
13
12
  | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
14
13
  | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
15
14
  | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
@@ -59,7 +58,7 @@ Type: `Promise<void>`
59
58
 
60
59
 
61
60
 
62
- ### `setFocus(options?: TFocusOptions) => Promise<void>`
61
+ ### `setFocus() => Promise<void>`
63
62
 
64
63
  Aplica o foco no campo.
65
64
 
package/components/ez-date-time-input/readme.md CHANGED
@@ -9,7 +9,6 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
- | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
13
12
  | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
14
13
  | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
15
14
  | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
@@ -60,7 +59,7 @@ Type: `Promise<void>`
60
59
 
61
60
 
62
61
 
63
- ### `setFocus(options?: TFocusOptions) => Promise<void>`
62
+ ### `setFocus() => Promise<void>`
64
63
 
65
64
  Aplica o foco no campo.
66
65
 
package/components/ez-filter-input/readme.md CHANGED
@@ -7,26 +7,27 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
- | `asyncSearch` | `async-search` | Define se o campo irá funcionar de forma assíncrona. | `boolean` | `false` |
13
- | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
14
- | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
15
- | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
16
- | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
17
- | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
18
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
19
- | `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
20
- | `value` | `value` | Define o valor do campo. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | -------------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
+ | `asyncSearch` | `async-search` | Define se o campo irá funcionar de forma assíncrona. | `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
+ | `enabledIconClick` | `enabled-icon-click` | Se true permite ao usuário interagir com o ícone de pesquisa | `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
+ | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
18
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
19
+ | `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
20
+ | `value` | `value` | Define o valor do campo. | `string` | `undefined` |
21
21
 
22
22
 
23
23
  ## Events
24
24
 
25
- | Event | Description | Type |
26
- | ------------- | --------------------------------------------------------------------- | --------------------- |
27
- | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<string>` |
28
- | `ezFocusIn` | Emitido quando acontece o foco no campo. | `CustomEvent<void>` |
29
- | `ezSearching` | Emitido quando está sendo realizada uma pesquisa no modo asyncSearch. | `CustomEvent<string>` |
25
+ | Event | Description | Type |
26
+ | ------------- | --------------------------------------------------------------------- | ---------------------- |
27
+ | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<string>` |
28
+ | `ezFocusIn` | Emitido quando acontece o foco no campo. | `CustomEvent<void>` |
29
+ | `ezIconClick` | Emitido quando tem interação com o Ícone de pesquisa | `CustomEvent<boolean>` |
30
+ | `ezSearching` | Emitido quando está sendo realizada uma pesquisa no modo asyncSearch. | `CustomEvent<string>` |
30
31
 
31
32
 
32
33
  ## Methods
@@ -41,6 +42,16 @@ Type: `Promise<void>`
41
42
 
42
43
 
43
44
 
45
+ ### `handleIconClick() => Promise<void>`
46
+
47
+ Método usado para emitir o evento de clique no ícone
48
+
49
+ #### Returns
50
+
51
+ Type: `Promise<void>`
52
+
53
+
54
+
44
55
  ### `isInvalid() => Promise<boolean>`
45
56
 
46
57
  Retorna se o conteúdo é inválido.
@@ -61,7 +72,7 @@ Type: `Promise<void>`
61
72
 
62
73
 
63
74
 
64
- ### `setFocus(options?: TFocusOptions) => Promise<void>`
75
+ ### `setFocus() => Promise<void>`
65
76
 
66
77
  Aplica o foco no campo.
67
78
 
package/components/ez-grid/readme.md CHANGED
@@ -16,7 +16,6 @@
16
16
  | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
17
17
  | `enableContinuousInsert` | `enable-continuous-insert` | Ativa/desativa a inserção continua na grade Só funciona quando a prop enableGridInsert está ativa | `boolean` | `true` |
18
18
  | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
19
- | `enableLockManger` | `enable-lock-manger` | Ativa inserção de registros no modo grade. | `boolean` | `true` |
20
19
  | `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas. | `boolean` | `undefined` |
21
20
  | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'show'` |
22
21
  | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
@@ -79,16 +78,6 @@ Type: `Promise<void>`
79
78
 
80
79
 
81
80
 
82
- ### `checkStopEditOutsideClick(event: MouseEvent) => Promise<void>`
83
-
84
-
85
-
86
- #### Returns
87
-
88
- Type: `Promise<void>`
89
-
90
-
91
-
92
81
  ### `filterColumns(search: string) => Promise<Array<EzGridColumn>>`
93
82
 
94
83
  Usa um argumento para filtrar as colunas po label
@@ -219,16 +208,6 @@ Type: `Promise<void>`
219
208
 
220
209
 
221
210
 
222
- ### `stopEdit() => Promise<void>`
223
-
224
- Para a edição da grade.
225
-
226
- #### Returns
227
-
228
- Type: `Promise<void>`
229
-
230
-
231
-
232
211
 
233
212
  ## Dependencies
234
213
 
package/components/ez-list/readme.md CHANGED
@@ -7,16 +7,17 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----------- |
12
- | `dataSource` | -- | Define a lista inicial do componente. | `(ListItem \| ListGroup)[]` | `[]` |
13
- | `ezDraggable` | `ez-draggable` | Se true habilita `drag and drop` para os itens. | `boolean` | `false` |
14
- | `ezSelectable` | `ez-selectable` | Se true os itens serão selecionáveis. | `boolean` | `false` |
15
- | `hoverFeedback` | `hover-feedback` | Quando verdadeiro, ativa o feedback visual ao efetuar houver nos itens da lista. | `boolean` | `false` |
16
- | `itemLeftSlotBuilder` | -- | Função builder que possibilita gerar conteúdo dinâmico à esquerda do item da lista. * Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
17
- | `itemSlotBuilder` | -- | Função builder que possibilita alterar como o item da lista vai ser apresentado. Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
18
- | `listMode` | `list-mode` | Define o modo de apresentação da lista. | `"check" \| "regular"` | `'regular'` |
19
- | `useGroups` | `use-groups` | Se true os grupos serão exibidos. | `boolean` | `false` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----------- |
12
+ | `dataSource` | -- | Define a lista inicial do componente. | `(ListItem \| ListGroup)[]` | `[]` |
13
+ | `disableShortcuts` | `disable-shortcuts` | Desabilita os atalhos de teclado. | `boolean` | `false` |
14
+ | `ezDraggable` | `ez-draggable` | Se true habilita `drag and drop` para os itens. | `boolean` | `false` |
15
+ | `ezSelectable` | `ez-selectable` | Se true os itens serão selecionáveis. | `boolean` | `false` |
16
+ | `hoverFeedback` | `hover-feedback` | Quando verdadeiro, ativa o feedback visual ao efetuar houver nos itens da lista. | `boolean` | `false` |
17
+ | `itemLeftSlotBuilder` | -- | Função builder que possibilita gerar conteúdo dinâmico à esquerda do item da lista. * Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
18
+ | `itemSlotBuilder` | -- | Função builder que possibilita alterar como o item da lista vai ser apresentado. Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
19
+ | `listMode` | `list-mode` | Define o modo de apresentação da lista. | `"check" \| "regular"` | `'regular'` |
20
+ | `useGroups` | `use-groups` | Se true os grupos serão exibidos. | `boolean` | `false` |
20
21
 
21
22
 
22
23
  ## Events
@@ -25,6 +26,7 @@
25
26
  | --------------- | ----------------------------------------------------------- | ---------------------------------------- |
26
27
  | `ezChange` | Emitido quando acontece a alteração de estado da lista. | `CustomEvent<(ListItem \| ListGroup)[]>` |
27
28
  | `ezCheckChange` | Emitido quando acontece a alteração de um item do checkbox. | `CustomEvent<ListItem>` |
29
+ | `ezClickItem` | Emitido sempre que um item da lista for clicado. | `CustomEvent<ListItem>` |
28
30
  | `ezDoubleClick` | Emitido quando ocorre um duplo clique em um item da lista. | `CustomEvent<ListItem>` |
29
31
  | `ezSelectItem` | Emitido sempre que um item da lista for selecionado. | `CustomEvent<ListItem>` |
30
32
 
@@ -81,6 +83,26 @@ Type: `Promise<void>`
81
83
 
82
84
 
83
85
 
86
+ ### `selectNextItem() => Promise<void>`
87
+
88
+ Seleciona o próximo item.
89
+
90
+ #### Returns
91
+
92
+ Type: `Promise<void>`
93
+
94
+
95
+
96
+ ### `selectPreviousItem() => Promise<void>`
97
+
98
+ Seleciona o item anterior.
99
+
100
+ #### Returns
101
+
102
+ Type: `Promise<void>`
103
+
104
+
105
+
84
106
  ### `setSelection(selectedItem: ListItem, scrollToOption?: boolean) => Promise<void>`
85
107
 
86
108
  Aplica seleção nas linhas da lista.
package/components/ez-number-input/readme.md CHANGED
@@ -10,7 +10,6 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------- | --------------------- | ----------- |
12
12
  | `allowNegative` | `allow-negative` | Se false, o input não aceitará números negativos. | `boolean` | `true` |
13
- | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
14
13
  | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
15
14
  | `enabled` | `enabled` | Se false, o usuário não pode interagir com o campo. | `boolean` | `true` |
16
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-search/readme.md CHANGED
@@ -9,7 +9,6 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ---------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ----------- |
12
- | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
13
12
  | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
14
13
  | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
15
14
  | `ensureClearButtonVisible` | `ensure-clear-button-visible` | Garante que o botão de limpar pesquisa está sempre visível | `boolean` | `false` |
@@ -80,7 +79,7 @@ Type: `Promise<void>`
80
79
 
81
80
 
82
81
 
83
- ### `setFocus(options?: TFocusOptions) => Promise<void>`
82
+ ### `setFocus() => Promise<void>`
84
83
 
85
84
  Aplica o foco no campo.
86
85
 
package/components/ez-text-area/readme.md CHANGED
@@ -9,8 +9,6 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
- | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
13
- | `autoRows` | `auto-rows` | Ativa a opção de fazer as linhas do componente serem baseados na altura máxima. | `boolean` | `false` |
14
12
  | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
15
13
  | `enableResize` | `enable-resize` | Ativa a opção de fazer resize do input. | `boolean` | `false` |
16
14
  | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
package/components/ez-text-input/readme.md CHANGED
@@ -7,20 +7,18 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ---------------- | ------------------ | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
- | `autoFocus` | `auto-focus` | Se true o campo 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
- | `cleanValueMask` | `clean-value-mask` | Para remover a máscara quando fizer um apply no formulário. | `boolean` | `false` |
15
- | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
16
- | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
17
- | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
18
- | `mask` | `mask` | Aplica uma máscara no conteúdo conforme o padrão estabelecido | `string` | `undefined` |
19
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
20
- | `noBorder` | `no-border` | Se true o campo não terá bordas. | `boolean` | `false` |
21
- | `password` | `password` | Se true o campo não terá bordas. | `boolean` | `false` |
22
- | `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
23
- | `value` | `value` | Define o valor do campo. | `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
+ | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
16
+ | `mask` | `mask` | Aplica uma máscara no conteúdo conforme o padrão estabelecido | `string` | `undefined` |
17
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
18
+ | `noBorder` | `no-border` | Se true o campo não terá bordas. | `boolean` | `false` |
19
+ | `password` | `password` | Se true o campo não terá bordas. | `boolean` | `false` |
20
+ | `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
21
+ | `value` | `value` | Define o valor do campo. | `string` | `undefined` |
24
22
 
25
23
 
26
24
  ## Events
package/components/ez-time-input/readme.md CHANGED
@@ -9,7 +9,6 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
- | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
13
12
  | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
14
13
  | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
15
14
  | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "0.0.0-bugfix-dev-KB-77126.0",
3
+ "version": "0.0.0-bugfix-dev-KB-77074.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [