@sankhyalabs/ezui-docs 0.0.0-feat-dev-KB-65892.0 → 0.0.0-feat-dev-KB-63203.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 (7) hide show
  1. package/components/ez-filter-input/readme.md +15 -27
  2. package/components/ez-grid/readme.md +15 -13
  3. package/components/ez-modal/readme.md +0 -1
  4. package/components/ez-modal-container/readme.md +0 -1
  5. package/components/ez-search/readme.md +0 -1
  6. package/components/ez-tabselector/readme.md +0 -13
  7. package/package.json +1 -1
package/components/ez-filter-input/readme.md CHANGED
@@ -7,27 +7,25 @@
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
- | `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` |
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` |
21
20
 
22
21
 
23
22
  ## Events
24
23
 
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>` |
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>` |
31
29
 
32
30
 
33
31
  ## Methods
@@ -42,16 +40,6 @@ Type: `Promise<void>`
42
40
 
43
41
 
44
42
 
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
-
55
43
  ### `isInvalid() => Promise<boolean>`
56
44
 
57
45
  Retorna se o conteúdo é inválido.
package/components/ez-grid/readme.md CHANGED
@@ -7,19 +7,21 @@
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
+ | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
21
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
22
+ | `serverUrl` | `server-url` | Endereço do servidor para obtenção dos dados. | `string` | `undefined` |
23
+ | `statusResolver` | -- | Define um `IStatusResolver` responsável pelo estado da coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
24
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
23
25
 
24
26
 
25
27
  ## Events
package/components/ez-modal/readme.md CHANGED
@@ -12,7 +12,6 @@
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` |
16
15
  | `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"` |
17
16
  | `modalSize` | `modal-size` | Define o tamanho do ez-modal. Devem ser definidas seguindo grid-layout. Exemplo: `col-sd-3`. | `string` | `undefined` |
18
17
  | `opened` | `opened` | Define se o ez-modal está aberto. | `boolean` | `true` |
package/components/ez-modal-container/readme.md CHANGED
@@ -15,7 +15,6 @@
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` |
19
18
  | `showTitleBar` | `show-title-bar` | Define se o cabeçalho será mostrado. | `boolean` | `true` |
20
19
 
21
20
 
package/components/ez-search/readme.md CHANGED
@@ -12,7 +12,6 @@
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
14
  | `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
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` |
17
16
  | `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Define se deve ignorar o limite de caracteres mínimo para realizar uma pesquisa | `boolean` | `false` |
18
17
  | `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
package/components/ez-tabselector/readme.md CHANGED
@@ -21,19 +21,6 @@
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
-
37
24
  ## Dependencies
38
25
 
39
26
  ### Used by
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "0.0.0-feat-dev-KB-65892.0",
3
+ "version": "0.0.0-feat-dev-KB-63203.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [