@sankhyalabs/ezui-docs 0.0.0-feat-dev-KB-65902.2 → 0.0.0-feat-dev-KB-65909.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 (8) 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-filter-input/readme.md +27 -15
  4. package/components/ez-grid/readme.md +16 -13
  5. package/components/ez-list/readme.md +1 -0
  6. package/components/ez-search/readme.md +2 -1
  7. package/components/ez-split-button/readme.md +1 -1
  8. 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-filter-input/readme.md CHANGED
@@ -7,25 +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
- | `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
- | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
16
- | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
17
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
18
- | `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
19
- | `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` |
20
21
 
21
22
 
22
23
  ## Events
23
24
 
24
- | Event | Description | Type |
25
- | ------------- | --------------------------------------------------------------------- | --------------------- |
26
- | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<string>` |
27
- | `ezFocusIn` | Emitido quando acontece o foco no campo. | `CustomEvent<void>` |
28
- | `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>` |
29
31
 
30
32
 
31
33
  ## Methods
@@ -40,6 +42,16 @@ Type: `Promise<void>`
40
42
 
41
43
 
42
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
+
43
55
  ### `isInvalid() => Promise<boolean>`
44
56
 
45
57
  Retorna se o conteúdo é inválido.
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-list/readme.md CHANGED
@@ -26,6 +26,7 @@
26
26
  | --------------- | ----------------------------------------------------------- | ---------------------------------------- |
27
27
  | `ezChange` | Emitido quando acontece a alteração de estado da lista. | `CustomEvent<(ListItem \| ListGroup)[]>` |
28
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>` |
29
30
  | `ezDoubleClick` | Emitido quando ocorre um duplo clique em um item da lista. | `CustomEvent<ListItem>` |
30
31
  | `ezSelectItem` | Emitido sempre que um item da lista for selecionado. | `CustomEvent<ListItem>` |
31
32
 
package/components/ez-search/readme.md CHANGED
@@ -11,8 +11,8 @@
11
11
  | -------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ----------- |
12
12
  | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
13
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` |
14
15
  | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
15
- | `fromGrid` | `from-grid` | Informa se o componente está instanciado de dentro de uma grade | `boolean` | `false` |
16
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
17
  | `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Define se deve ignorar o limite de caracteres mínimo para realizar uma pesquisa | `boolean` | `false` |
18
18
  | `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
@@ -24,6 +24,7 @@
24
24
  | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
25
25
  | `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
26
26
  | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
27
+ | `suppressPreLoad` | `suppress-pre-load` | Se true, desabilita pré-load das opções ao carregar componente | `boolean` | `false` |
27
28
  | `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
28
29
  | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
29
30
 
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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "0.0.0-feat-dev-KB-65902.2",
3
+ "version": "0.0.0-feat-dev-KB-65909.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [