@sankhyalabs/ezui-docs 5.22.0-dev.110 → 5.22.0-dev.111

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-form/readme.md +1 -0
  2. package/components/ez-form-view/readme.md +1 -0
  3. package/components/ez-search-plus/readme.md +29 -28
  4. package/components/ez-search-plus/subcomponent/ez-search-result-list/readme.md +2 -0
  5. package/components/ez-skeleton/readme.md +2 -0
  6. package/components/ez-tooltip/readme.md +11 -10
  7. package/package.json +1 -1
package/components/ez-form/readme.md CHANGED
@@ -111,6 +111,7 @@ graph TD;
111
111
  ez-search-plus --> ez-popover-plus
112
112
  ez-search-plus --> ez-search-result-list
113
113
  ez-search-result-list --> ez-card-item
114
+ ez-search-result-list --> ez-skeleton
114
115
  ez-search --> ez-text-input
115
116
  ez-search --> ez-icon
116
117
  ez-search --> ez-popover-plus
package/components/ez-form-view/readme.md CHANGED
@@ -119,6 +119,7 @@ graph TD;
119
119
  ez-search-plus --> ez-popover-plus
120
120
  ez-search-plus --> ez-search-result-list
121
121
  ez-search-result-list --> ez-card-item
122
+ ez-search-result-list --> ez-skeleton
122
123
  ez-search --> ez-text-input
123
124
  ez-search --> ez-icon
124
125
  ez-search --> ez-popover-plus
package/components/ez-search-plus/readme.md CHANGED
@@ -7,32 +7,32 @@
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
- | `codLabel` | `cod-label` | Texto a ser apresentado no input de código. | `string` | `undefined` |
15
- | `contextProperties` | `context-properties` | Propriedades de contexto da aplicação. | `any` | `undefined` |
16
- | `disableCodeInput` | `disable-code-input` | Se true o campo de código ficara desabilitado. | `boolean` | `false` |
17
- | `disableDescriptionInput` | `disable-description-input` | Se true o campo de de apresentação ficara desabilitado. | `boolean` | `false` |
18
- | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
19
- | `ensureClearButtonVisible` | `ensure-clear-button-visible` | Garante que o botão de limpar pesquisa está sempre visível | `boolean` | `false` |
20
- | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
21
- | `hideDescriptionInput` | `hide-description-input` | Se true o campo de de apresentação não será exibido. | `boolean` | `false` |
22
- | `hideErrorOnFocusOut` | `hide-error-on-focus-out` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `true` |
23
- | `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `false` |
24
- | `isTextSearch` | `is-text-search` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `false` |
25
- | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
26
- | `listOptionsPosition` | -- | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `IEzCheckBoxListPosition` | `undefined` |
27
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
28
- | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument, ctxProperties?: any) => IOption \| IOption[] \| Promise<IOption[]> \| Promise<IOption>` | `undefined` |
29
- | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
30
- | `showSelectedValue` | `show-selected-value` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `true` |
31
- | `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, interrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` |
32
- | `suppressEmptyOption` | `suppress-empty-option` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `false` |
33
- | `suppressPreLoad` | `suppress-pre-load` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `true` |
34
- | `suppressSearch` | `suppress-search` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `false` |
35
- | `value` | `value` | Define o valor do campo. | `any` | `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
+ | `codLabel` | `cod-label` | Texto a ser apresentado no input de código. | `string` | `undefined` |
15
+ | `contextProperties` | `context-properties` | Propriedades de contexto da aplicação. | `any` | `undefined` |
16
+ | `disableCodeInput` | `disable-code-input` | Se true o campo de código ficara desabilitado. | `boolean` | `false` |
17
+ | `disableDescriptionInput` | `disable-description-input` | Se true o campo de de apresentação ficara desabilitado. | `boolean` | `false` |
18
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
19
+ | `ensureClearButtonVisible` | `ensure-clear-button-visible` | Garante que o botão de limpar pesquisa está sempre visível | `boolean` | `false` |
20
+ | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
21
+ | `hideDescriptionInput` | `hide-description-input` | Se true o campo de de apresentação não será exibido. | `boolean` | `false` |
22
+ | `hideErrorOnFocusOut` | `hide-error-on-focus-out` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `true` |
23
+ | `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `false` |
24
+ | `isTextSearch` | `is-text-search` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `false` |
25
+ | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
26
+ | `listOptionsPosition` | -- | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `IEzCheckBoxListPosition` | `undefined` |
27
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
28
+ | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument, ctxProperties?: any) => ISearchOption \| IOption \| (ISearchOption \| IOption)[] \| Promise<ISearchOption \| IOption \| (ISearchOption \| IOption)[]>` | `undefined` |
29
+ | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
30
+ | `showSelectedValue` | `show-selected-value` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `true` |
31
+ | `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, interrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` |
32
+ | `suppressEmptyOption` | `suppress-empty-option` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `false` |
33
+ | `suppressPreLoad` | `suppress-pre-load` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `true` |
34
+ | `suppressSearch` | `suppress-search` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `false` |
35
+ | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
36
36
 
37
37
 
38
38
  ## Events
@@ -54,14 +54,14 @@ Type: `Promise<void>`
54
54
 
55
55
 
56
56
 
57
- ### `getValueAsync() => Promise<unknown>`
57
+ ### `getValueAsync() => Promise<IOption>`
58
58
 
59
59
  Obtém o valor do componente só após a compo de apresentação
60
60
  ter sido resolvido pelo option loader quando necessário
61
61
 
62
62
  #### Returns
63
63
 
64
- Type: `Promise<unknown>`
64
+ Type: `Promise<IOption>`
65
65
 
66
66
 
67
67
 
@@ -120,6 +120,7 @@ graph TD;
120
120
  ez-text-input --> ez-icon
121
121
  ez-popover-plus --> ez-popover-core
122
122
  ez-search-result-list --> ez-card-item
123
+ ez-search-result-list --> ez-skeleton
123
124
  ez-form-view --> ez-search-plus
124
125
  style ez-search-plus fill:#f9f,stroke:#333,stroke-width:4px
125
126
  ```
package/components/ez-search-plus/subcomponent/ez-search-result-list/readme.md CHANGED
@@ -74,11 +74,13 @@ Type: `Promise<void>`
74
74
  ### Depends on
75
75
 
76
76
  - [ez-card-item](../../../ez-card-item)
77
+ - [ez-skeleton](../../../ez-skeleton)
77
78
 
78
79
  ### Graph
79
80
  ```mermaid
80
81
  graph TD;
81
82
  ez-search-result-list --> ez-card-item
83
+ ez-search-result-list --> ez-skeleton
82
84
  ez-search-plus --> ez-search-result-list
83
85
  style ez-search-result-list fill:#f9f,stroke:#333,stroke-width:4px
84
86
  ```
package/components/ez-skeleton/readme.md CHANGED
@@ -22,11 +22,13 @@
22
22
  ### Used by
23
23
 
24
24
  - [ez-dropdown](../ez-dropdown)
25
+ - [ez-search-result-list](../ez-search-plus/subcomponent/ez-search-result-list)
25
26
 
26
27
  ### Graph
27
28
  ```mermaid
28
29
  graph TD;
29
30
  ez-dropdown --> ez-skeleton
31
+ ez-search-result-list --> ez-skeleton
30
32
  style ez-skeleton fill:#f9f,stroke:#333,stroke-width:4px
31
33
  ```
32
34
 
package/components/ez-tooltip/readme.md CHANGED
@@ -7,16 +7,17 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------ | ----------------- | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
12
- | `active` | `active` | Define se o tooltip está ativo. | `boolean` | `true` |
13
- | `anchoringElement` | -- | Elemento HTML que será utilizado como ancoragem do tooltip. | `HTMLElement` | `undefined` |
14
- | `debouncingTime` | `debouncing-time` | Tempo de espera para exibir o tooltip após o evento de mouseenter. | `number` | `500` |
15
- | `gapOptions` | -- | Define o espaçamento entre o tooltip e o elemento de ancoragem. | `{ horizontalGap: number; verticalGap: number; }` | `{ horizontalGap: 0, verticalGap: 0 }` |
16
- | `message` | `message` | Mensagem que será apresentada no tooltip. | `string` | `undefined` |
17
- | `minWidth` | `min-width` | Define a largura mínima do elemento. | `number` | `150` |
18
- | `placement` | `placement` | Define a posição do tooltip em relação ao elemento de ancoragem. | `"bottom" \| "bottom-end" \| "bottom-start" \| "left" \| "left-end" \| "left-start" \| "right" \| "right-end" \| "right-start" \| "top" \| "top-end" \| "top-start"` | `'bottom'` |
19
- | `type` | `type` | Define o tipo de tooltip a ser exibido. | `"default" \| "error" \| "success" \| "warning"` | `'default'` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | ----------------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
12
+ | `active` | `active` | Define se o tooltip está ativo. | `boolean` | `true` |
13
+ | `anchoringElement` | -- | Elemento HTML que será utilizado como ancoragem do tooltip. | `HTMLElement` | `undefined` |
14
+ | `debouncingTime` | `debouncing-time` | Tempo de espera para exibir o tooltip após o evento de mouseenter. | `number` | `500` |
15
+ | `gapOptions` | -- | Define o espaçamento entre o tooltip e o elemento de ancoragem. | `{ horizontalGap: number; verticalGap: number; }` | `{ horizontalGap: 0, verticalGap: 0 }` |
16
+ | `maxWidth` | `max-width` | Define a largura máxima do elemento. | `number` | `200` |
17
+ | `message` | `message` | Mensagem que será apresentada no tooltip. | `string` | `undefined` |
18
+ | `placement` | `placement` | Define a posição do tooltip em relação ao elemento de ancoragem. | `"bottom" \| "bottom-end" \| "bottom-start" \| "left" \| "left-end" \| "left-start" \| "right" \| "right-end" \| "right-start" \| "top" \| "top-end" \| "top-start"` | `'bottom'` |
19
+ | `type` | `type` | Define o tipo de tooltip a ser exibido. | `"default" \| "error" \| "success" \| "warning"` | `'default'` |
20
+ | `useAnchorSize` | `use-anchor-size` | Define se o elemento manterá o mesmo tamanho do componente de ancora. | `boolean` | `false` |
20
21
 
21
22
 
22
23
  ## Dependencies
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "5.22.0-dev.110",
3
+ "version": "5.22.0-dev.111",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [