@sankhyalabs/ezui-docs 5.16.0 → 5.17.0-dev.1

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 (6) hide show
  1. package/components/ez-actions-button/readme.md +15 -3
  2. package/components/ez-combo-box/readme.md +1 -0
  3. package/components/ez-form/readme.md +12 -9
  4. package/components/ez-grid/readme.md +20 -0
  5. package/components/ez-search/readme.md +16 -15
  6. package/package.json +1 -1
package/components/ez-actions-button/readme.md CHANGED
@@ -22,9 +22,11 @@
22
22
 
23
23
  ## Events
24
24
 
25
- | Event | Description | Type |
26
- | ---------- | ---------------------------- | ---------------------- |
27
- | `ezAction` | Emitido ao acionar uma ação. | `CustomEvent<IAction>` |
25
+ | Event | Description | Type |
26
+ | ----------------------------- | ----------------------------------------------- | -------------------------- |
27
+ | `ezAction` | Emitido ao acionar uma ação. | `CustomEvent<IAction>` |
28
+ | `ezDisconnectedActionButtons` | Emitido quando componente é desconectado da DOM | `CustomEvent<void>` |
29
+ | `ezPopoverOpen` | Emitido ao mostrar a lista de ações | `CustomEvent<HTMLElement>` |
28
30
 
29
31
 
30
32
  ## Methods
@@ -49,6 +51,16 @@ Type: `Promise<boolean>`
49
51
 
50
52
 
51
53
 
54
+ ### `showActions() => Promise<void>`
55
+
56
+ Apresenta a lista de ações.
57
+
58
+ #### Returns
59
+
60
+ Type: `Promise<void>`
61
+
62
+
63
+
52
64
 
53
65
  ## Dependencies
54
66
 
package/components/ez-combo-box/readme.md CHANGED
@@ -15,6 +15,7 @@
15
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
16
  | `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
17
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` |
18
19
  | `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
19
20
  | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
20
21
  | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
package/components/ez-form/readme.md CHANGED
@@ -7,19 +7,22 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------ | --------- | --------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
12
- | `config` | -- | Configuração do formulário. | `IFormConfig` | `undefined` |
13
- | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
14
- | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | ---------------- | --------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
12
+ | `config` | -- | Configuração do formulário. | `IFormConfig` | `undefined` |
13
+ | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
14
+ | `fieldToFocus` | `field-to-focus` | Determina o campo que deve ficar em evidência. | `string` | `undefined` |
15
+ | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
15
16
 
16
17
 
17
18
  ## Events
18
19
 
19
- | Event | Description | Type |
20
- | ---------------- | ------------------------------------------------------------------------------- | ------------------------ |
21
- | `ezReady` | Evento disparado quando o formulário está disponível na DOM. | `CustomEvent<void>` |
22
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<FormItems>` |
20
+ | Event | Description | Type |
21
+ | -------------------------------- | ------------------------------------------------------------------------------- | ----------------------------- |
22
+ | `ezFormRequestClearFieldToFocus` | Emitido quando o campo recebe foco | `CustomEvent<void>` |
23
+ | `ezFormSetFields` | Emitido quando o campo recebe foco | `CustomEvent<IFieldConfig[]>` |
24
+ | `ezReady` | Evento disparado quando o formulário está disponível na DOM. | `CustomEvent<void>` |
25
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<FormItems>` |
23
26
 
24
27
 
25
28
  ## Methods
package/components/ez-grid/readme.md CHANGED
@@ -44,6 +44,16 @@ Type: `Promise<void>`
44
44
 
45
45
 
46
46
 
47
+ ### `filterColumns(search: string) => Promise<Array<EzGridColumn>>`
48
+
49
+ Usa um argumento para filtrar as colunas po label
50
+
51
+ #### Returns
52
+
53
+ Type: `Promise<EzGridColumn[]>`
54
+
55
+
56
+
47
57
  ### `getColumns() => Promise<Array<EzGridColumn>>`
48
58
 
49
59
  Obtém a lista de definição de colunas.
@@ -74,6 +84,16 @@ Type: `Promise<any[]>`
74
84
 
75
85
 
76
86
 
87
+ ### `locateColumn(columnName: string) => Promise<void>`
88
+
89
+ Localiza determinada coluna tornando-a visível.
90
+
91
+ #### Returns
92
+
93
+ Type: `Promise<void>`
94
+
95
+
96
+
77
97
  ### `quickFilter(term: string) => Promise<void>`
78
98
 
79
99
  Aplica um filtro rápido.
package/components/ez-search/readme.md CHANGED
@@ -7,21 +7,22 @@
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
- | `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
19
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
20
- | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
21
- | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
22
- | `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
23
- | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
24
- | `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
+ | `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
+ | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
23
+ | `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
24
+ | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
25
+ | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
25
26
 
26
27
 
27
28
  ## Events
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "5.16.0",
3
+ "version": "5.17.0-dev.1",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [