@sankhyalabs/ezui-docs 5.22.0-dev.14 → 5.22.0-dev.141

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 (45) hide show
  1. package/components/ez-avatar/readme.md +34 -0
  2. package/components/ez-badge/readme.md +8 -7
  3. package/components/ez-breadcrumb/readme.md +1 -0
  4. package/components/ez-button/readme.md +3 -1
  5. package/components/ez-card-item/readme.md +5 -2
  6. package/components/ez-chart/readme.md +2 -2
  7. package/components/ez-check/readme.md +9 -8
  8. package/components/ez-collapsible-box/readme.md +2 -0
  9. package/components/ez-combo-box/ez-combo-box-list/readme.md +71 -0
  10. package/components/ez-combo-box/readme.md +29 -19
  11. package/components/ez-date-input/readme.md +16 -9
  12. package/components/ez-date-time-input/readme.md +17 -10
  13. package/components/ez-double-list/readme.md +70 -0
  14. package/components/ez-dropdown/readme.md +3 -0
  15. package/components/ez-filter-input/readme.md +6 -1
  16. package/components/ez-form/readme.md +31 -9
  17. package/components/ez-form-view/readme.md +25 -7
  18. package/components/ez-grid/readme.md +58 -17
  19. package/components/ez-grid/subcomponents/readme.md +8 -3
  20. package/components/ez-guide-navigator/readme.md +2 -0
  21. package/components/ez-icon/readme.md +7 -0
  22. package/components/ez-list/readme.md +21 -17
  23. package/components/ez-modal/readme.md +10 -10
  24. package/components/ez-multi-selection-list/readme.md +6 -1
  25. package/components/ez-number-input/readme.md +15 -10
  26. package/components/ez-popover/readme.md +4 -2
  27. package/components/ez-popover-plus/readme.md +122 -0
  28. package/components/ez-popover-plus/subcomponent/readme.md +107 -0
  29. package/components/ez-popup/readme.md +8 -7
  30. package/components/ez-scroller/readme.md +2 -0
  31. package/components/ez-search/readme.md +37 -22
  32. package/components/ez-search/subcomponent/search-list/readme.md +72 -0
  33. package/components/ez-search-plus/readme.md +130 -0
  34. package/components/ez-search-plus/subcomponent/ez-search-result-list/readme.md +90 -0
  35. package/components/ez-skeleton/readme.md +28 -9
  36. package/components/ez-split-button/readme.md +34 -11
  37. package/components/ez-split-panel/readme.md +12 -4
  38. package/components/ez-split-panel/structure/item/readme.md +6 -5
  39. package/components/ez-text-area/readme.md +13 -10
  40. package/components/ez-text-edit/readme.md +2 -0
  41. package/components/ez-text-input/readme.md +25 -12
  42. package/components/ez-time-input/readme.md +13 -9
  43. package/components/ez-tooltip/readme.md +38 -0
  44. package/components/ez-tree/readme.md +5 -4
  45. package/package.json +1 -1
package/components/ez-popover-plus/readme.md ADDED
@@ -0,0 +1,122 @@
1
+ # ez-popover-plus
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------- | ----------------- | --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | -------------------------------------------------------- |
12
+ | `anchorElement` | `anchor-element` | Define o elemento de ancoragem. | `(string \| HTMLElement)[] \| HTMLElement \| string` | `undefined` |
13
+ | `autoClose` | `auto-close` | Define que será fechado automaticamente quando o usuário clicar fora do conteúdo. | `boolean` | `true` |
14
+ | `boxWidth` | `box-width` | Ajusta o comportamento da largura do popover. | `"fit-content" \| "full-width"` | `"fit-content"` |
15
+ | `minWidth` | `min-width` | Define a largura mínima do elemento (apenas será considerada caso a propriedade useAnchorSize seja verdadeira). | `number` | `150` |
16
+ | `opened` | `opened` | Define se o ez-popover está aberto. | `boolean` | `false` |
17
+ | `options` | -- | Define as opções do elemento. | `IEzPopoverAnchorOptions` | `{ horizontalGap: 0, verticalGap: 0, fromRight: false }` |
18
+ | `overlayType` | `overlay-type` | Define o tipo de overlay do popover. | `"light" \| "medium" \| "none"` | `"light"` |
19
+ | `useAnchorSize` | `use-anchor-size` | Define se o elemento manterá o mesmo tamanho do componente de ancora. | `boolean` | `false` |
20
+
21
+
22
+ ## Events
23
+
24
+ | Event | Description | Type |
25
+ | -------------------- | ------------------------------------------------------------ | ---------------------- |
26
+ | `ezVisibilityChange` | Emitido quando acontece a alteração de estado do componente. | `CustomEvent<boolean>` |
27
+
28
+
29
+ ## Methods
30
+
31
+ ### `hide() => Promise<void>`
32
+
33
+ Oculta o ez-popover.
34
+
35
+ #### Returns
36
+
37
+ Type: `Promise<void>`
38
+
39
+
40
+
41
+ ### `setAnchorElement(anchor: HTMLElement | string) => Promise<void>`
42
+
43
+ Altera o elemento de ancoragem.
44
+
45
+ #### Returns
46
+
47
+ Type: `Promise<void>`
48
+
49
+
50
+
51
+ ### `setOptions(options: IEzPopoverAnchorOptions) => Promise<void>`
52
+
53
+ Altera as opções.
54
+
55
+ #### Returns
56
+
57
+ Type: `Promise<void>`
58
+
59
+
60
+
61
+ ### `show(top?: string | number, left?: string | number) => Promise<void>`
62
+
63
+ Exibe o ez-popover.
64
+
65
+ #### Returns
66
+
67
+ Type: `Promise<void>`
68
+
69
+
70
+
71
+ ### `showUnder(element: HTMLElement | string, options?: IEzPopoverAnchorOptions) => Promise<void>`
72
+
73
+ Ancora a exibição do popOver a um elemento HTML.
74
+
75
+ #### Returns
76
+
77
+ Type: `Promise<void>`
78
+
79
+
80
+
81
+ ### `updatePosition(top?: string, left?: string) => Promise<void>`
82
+
83
+ Atualiza a posição do popover.
84
+
85
+ #### Returns
86
+
87
+ Type: `Promise<void>`
88
+
89
+
90
+
91
+
92
+ ## Dependencies
93
+
94
+ ### Used by
95
+
96
+ - [ez-combo-box](../ez-combo-box)
97
+ - [ez-date-input](../ez-date-input)
98
+ - [ez-date-time-input](../ez-date-time-input)
99
+ - [ez-search](../ez-search)
100
+ - [ez-search-plus](../ez-search-plus)
101
+ - [filter-column](../ez-grid/subcomponents)
102
+
103
+ ### Depends on
104
+
105
+ - [ez-popover-core](subcomponent)
106
+
107
+ ### Graph
108
+ ```mermaid
109
+ graph TD;
110
+ ez-popover-plus --> ez-popover-core
111
+ ez-combo-box --> ez-popover-plus
112
+ ez-date-input --> ez-popover-plus
113
+ ez-date-time-input --> ez-popover-plus
114
+ ez-search --> ez-popover-plus
115
+ ez-search-plus --> ez-popover-plus
116
+ filter-column --> ez-popover-plus
117
+ style ez-popover-plus fill:#f9f,stroke:#333,stroke-width:4px
118
+ ```
119
+
120
+ ----------------------------------------------
121
+
122
+
package/components/ez-popover-plus/subcomponent/readme.md ADDED
@@ -0,0 +1,107 @@
1
+ # ez-popover-core
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------- | ----------------- | --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | -------------------------------------------------------- |
12
+ | `anchorElement` | `anchor-element` | Define o elemento de ancoragem. | `(string \| HTMLElement)[] \| HTMLElement \| string` | `undefined` |
13
+ | `autoClose` | `auto-close` | Define se será fechado automaticamente quando o usuário clicar fora do conteúdo. | `boolean` | `true` |
14
+ | `boxWidth` | `box-width` | Ajusta o comportamento da largura do popover. | `"fit-content" \| "full-width"` | `"fit-content"` |
15
+ | `minWidth` | `min-width` | Define a largura mínima do elemento (apenas será considerada caso a propriedade useAnchorSize seja verdadeira). | `number` | `150` |
16
+ | `opened` | `opened` | Define se o ez-popover está aberto. | `boolean` | `false` |
17
+ | `options` | -- | Define as opções do elemento. | `IEzPopoverAnchorOptions` | `{ horizontalGap: 0, verticalGap: 0, fromRight: false }` |
18
+ | `overlayType` | `overlay-type` | Define o tipo de overlay do popover. | `"light" \| "medium" \| "none"` | `"light"` |
19
+ | `useAnchorSize` | `use-anchor-size` | Define se o elemento manterá o mesmo tamanho do componente de ancora. | `boolean` | `false` |
20
+
21
+
22
+ ## Events
23
+
24
+ | Event | Description | Type |
25
+ | -------------------- | ------------------------------------------------------------ | ---------------------- |
26
+ | `ezVisibilityChange` | Emitido quando acontece a alteração de estado do componente. | `CustomEvent<boolean>` |
27
+
28
+
29
+ ## Methods
30
+
31
+ ### `hide() => Promise<void>`
32
+
33
+ Oculta o ez-popover.
34
+
35
+ #### Returns
36
+
37
+ Type: `Promise<void>`
38
+
39
+
40
+
41
+ ### `setAnchorElement(anchor: HTMLElement | string) => Promise<void>`
42
+
43
+ Altera o elemento de ancoragem.
44
+
45
+ #### Returns
46
+
47
+ Type: `Promise<void>`
48
+
49
+
50
+
51
+ ### `setOptions(options: IEzPopoverAnchorOptions) => Promise<void>`
52
+
53
+ Altera as opções.
54
+
55
+ #### Returns
56
+
57
+ Type: `Promise<void>`
58
+
59
+
60
+
61
+ ### `show(top?: string | number, left?: string | number) => Promise<void>`
62
+
63
+ Exibe o ez-popover.
64
+
65
+ #### Returns
66
+
67
+ Type: `Promise<void>`
68
+
69
+
70
+
71
+ ### `showUnder(element: HTMLElement | string, options?: IEzPopoverAnchorOptions) => Promise<void>`
72
+
73
+ Ancora a exibição do popOver a um elemento HTML.
74
+
75
+ #### Returns
76
+
77
+ Type: `Promise<void>`
78
+
79
+
80
+
81
+ ### `updatePosition(top?: string, left?: string) => Promise<void>`
82
+
83
+ Atualiza a posição do popover.
84
+
85
+ #### Returns
86
+
87
+ Type: `Promise<void>`
88
+
89
+
90
+
91
+
92
+ ## Dependencies
93
+
94
+ ### Used by
95
+
96
+ - [ez-popover-plus](..)
97
+
98
+ ### Graph
99
+ ```mermaid
100
+ graph TD;
101
+ ez-popover-plus --> ez-popover-core
102
+ style ez-popover-core fill:#f9f,stroke:#333,stroke-width:4px
103
+ ```
104
+
105
+ ----------------------------------------------
106
+
107
+
package/components/ez-popup/readme.md CHANGED
@@ -7,13 +7,14 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------ | ------------- | -------------------------------------------------- | ---------------------------------------------------------- | ----------- |
12
- | `ezTitle` | `ez-title` | Texto a ser apresentado como título do componente. | `string` | `undefined` |
13
- | `heightMode` | `height-mode` | Define altura do componente. | `"auto" \| "full"` | `"full"` |
14
- | `opened` | `opened` | Define se o ez-popover está aberto. | `boolean` | `false` |
15
- | `size` | `size` | Define a largura do ez-popup. | `"large" \| "medium" \| "small" \| "x-large" \| "x-small"` | `"medium"` |
16
- | `useHeader` | `use-header` | Define se o componente utilizará cabeçalho. | `boolean` | `true` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------- | ---------------- | ------------------------------------------------------------- | -------------------------------------------------------------------- | ----------- |
12
+ | `enabledScroll` | `enabled-scroll` | Possibilita scroll vertical no conteúdo interno do componente | `boolean` | `false` |
13
+ | `ezTitle` | `ez-title` | Texto a ser apresentado como título do componente. | `string` | `undefined` |
14
+ | `heightMode` | `height-mode` | Define altura do componente. | `"auto" \| "full"` | `"full"` |
15
+ | `opened` | `opened` | Define se o ez-popover está aberto. | `boolean` | `false` |
16
+ | `size` | `size` | Define a largura do ez-popup. | `"auto" \| "large" \| "medium" \| "small" \| "x-large" \| "x-small"` | `"medium"` |
17
+ | `useHeader` | `use-header` | Define se o componente utilizará cabeçalho. | `boolean` | `true` |
17
18
 
18
19
 
19
20
  ## Events
package/components/ez-scroller/readme.md CHANGED
@@ -18,12 +18,14 @@
18
18
 
19
19
  ### Used by
20
20
 
21
+ - [ez-double-list](../ez-double-list)
21
22
  - [ez-guide-navigator](../ez-guide-navigator)
22
23
  - [ez-sidebar-navigator](../ez-sidebar-navigator)
23
24
 
24
25
  ### Graph
25
26
  ```mermaid
26
27
  graph TD;
28
+ ez-double-list --> ez-scroller
27
29
  ez-guide-navigator --> ez-scroller
28
30
  ez-sidebar-navigator --> ez-scroller
29
31
  style ez-scroller fill:#f9f,stroke:#333,stroke-width:4px
package/components/ez-search/readme.md CHANGED
@@ -7,25 +7,30 @@
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
- | `fromGrid` | `from-grid` | Informa se o componente está instanciado de dentro de uma grade | `boolean` | `false` |
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
- | `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Define se deve ignorar o limite de caracteres mínimo para realizar uma pesquisa | `boolean` | `false` |
18
- | `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
19
- | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
20
- | `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
21
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
22
- | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
23
- | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
24
- | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
25
- | `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
26
- | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
27
- | `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
28
- | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ----------- |
12
+ | `alternativePlaceholder` | `alternative-placeholder` | Texto alternativo a ser apresentado como título do campo. | `string` | `undefined` |
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
+ | `contextProperties` | `context-properties` | Propriedades de contexto da aplicação. | `any` | `undefined` |
16
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
17
+ | `ensureClearButtonVisible` | `ensure-clear-button-visible` | Garante que o botão de limpar pesquisa está sempre visível | `boolean` | `false` |
18
+ | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
19
+ | `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` |
20
+ | `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Define se deve ignorar o limite de caracteres mínimo para realizar uma pesquisa | `boolean` | `false` |
21
+ | `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto. | `boolean` | `false` |
22
+ | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
23
+ | `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox. | `IEzCheckBoxListPosition` | `undefined` |
24
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
25
+ | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument, ctxProperties?: any) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
26
+ | `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
27
+ | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
28
+ | `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
29
+ | `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, ineterrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` |
30
+ | `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
31
+ | `suppressPreLoad` | `suppress-pre-load` | Se true, desabilita pré-load das opções ao carregar componente | `boolean` | `true` |
32
+ | `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
33
+ | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
29
34
 
30
35
 
31
36
  ## Events
@@ -77,7 +82,7 @@ Type: `Promise<void>`
77
82
 
78
83
 
79
84
 
80
- ### `setFocus() => Promise<void>`
85
+ ### `setFocus(options?: TFocusOptions) => Promise<void>`
81
86
 
82
87
  Aplica o foco no campo.
83
88
 
@@ -92,22 +97,32 @@ Type: `Promise<void>`
92
97
 
93
98
  ### Used by
94
99
 
100
+ - [ez-form](../ez-form)
95
101
  - [ez-form-view](../ez-form-view)
102
+ - [ez-grid](../ez-grid)
96
103
  - [ez-multi-selection-list](../ez-multi-selection-list)
97
104
 
98
105
  ### Depends on
99
106
 
100
- - [ez-card-item](../ez-card-item)
101
107
  - [ez-text-input](../ez-text-input)
102
108
  - [ez-icon](../ez-icon)
109
+ - [ez-popover-plus](../ez-popover-plus)
110
+ - [search-list](./subcomponent/search-list)
103
111
 
104
112
  ### Graph
105
113
  ```mermaid
106
114
  graph TD;
107
- ez-search --> ez-card-item
108
115
  ez-search --> ez-text-input
109
116
  ez-search --> ez-icon
117
+ ez-search --> ez-popover-plus
118
+ ez-search --> search-list
119
+ ez-text-input --> ez-tooltip
120
+ ez-text-input --> ez-icon
121
+ ez-popover-plus --> ez-popover-core
122
+ search-list --> ez-card-item
123
+ ez-form --> ez-search
110
124
  ez-form-view --> ez-search
125
+ ez-grid --> ez-search
111
126
  ez-multi-selection-list --> ez-search
112
127
  style ez-search fill:#f9f,stroke:#333,stroke-width:4px
113
128
  ```
package/components/ez-search/subcomponent/search-list/readme.md ADDED
@@ -0,0 +1,72 @@
1
+ # search-list
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------- | ----------------------- | ----------- | ------------------- | ----------- |
12
+ | `canShowListOptions` | `can-show-list-options` | | `boolean` | `undefined` |
13
+ | `preSelection` | `pre-selection` | | `number` | `undefined` |
14
+ | `showLoading` | `show-loading` | | `boolean` | `undefined` |
15
+ | `showOptionValue` | `show-option-value` | | `boolean` | `true` |
16
+ | `textEmptyList` | `text-empty-list` | | `string` | `undefined` |
17
+ | `value` | `value` | | `IOption \| string` | `undefined` |
18
+ | `visibleOptions` | -- | | `IOption[]` | `[]` |
19
+
20
+
21
+ ## Events
22
+
23
+ | Event | Description | Type |
24
+ | -------------------- | ----------- | ---------------------- |
25
+ | `changePreSelection` | | `CustomEvent<number>` |
26
+ | `changeValue` | | `CustomEvent<IOption>` |
27
+
28
+
29
+ ## Methods
30
+
31
+ ### `nextOption() => Promise<void>`
32
+
33
+
34
+
35
+ #### Returns
36
+
37
+ Type: `Promise<void>`
38
+
39
+
40
+
41
+ ### `previousOption() => Promise<void>`
42
+
43
+
44
+
45
+ #### Returns
46
+
47
+ Type: `Promise<void>`
48
+
49
+
50
+
51
+
52
+ ## Dependencies
53
+
54
+ ### Used by
55
+
56
+ - [ez-search](../..)
57
+
58
+ ### Depends on
59
+
60
+ - [ez-card-item](../../../ez-card-item)
61
+
62
+ ### Graph
63
+ ```mermaid
64
+ graph TD;
65
+ search-list --> ez-card-item
66
+ ez-search --> search-list
67
+ style search-list fill:#f9f,stroke:#333,stroke-width:4px
68
+ ```
69
+
70
+ ----------------------------------------------
71
+
72
+
package/components/ez-search-plus/readme.md ADDED
@@ -0,0 +1,130 @@
1
+ # ez-search-plus
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
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` | Propriedade depreciada na nova versão do componente de pesquisa. | `boolean` | `true` |
23
+ | `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Propriedade depreciada na nova versão do componente de pesquisa. | `boolean` | `false` |
24
+ | `isTextSearch` | `is-text-search` | Propriedade depreciada na nova versão do componente de pesquisa. | `boolean` | `false` |
25
+ | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
26
+ | `listOptionsPosition` | -- | Propriedade depreciada na nova versão do componente de pesquisa. | `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` | Propriedade depreciada na nova versão do componente de pesquisa. | `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` | Propriedade depreciada na nova versão do componente de pesquisa. | `boolean` | `false` |
33
+ | `suppressPreLoad` | `suppress-pre-load` | Propriedade depreciada na nova versão do componente de pesquisa. | `boolean` | `true` |
34
+ | `suppressSearch` | `suppress-search` | Propriedade depreciada na nova versão do componente de pesquisa. | `boolean` | `false` |
35
+ | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
36
+
37
+
38
+ ## Events
39
+
40
+ | Event | Description | Type |
41
+ | ---------- | ------------------------------------------------------ | ---------------------- |
42
+ | `ezChange` | Emitido quando acontece a alteração de valor do campo. | `CustomEvent<IOption>` |
43
+
44
+
45
+ ## Methods
46
+
47
+ ### `clearValue() => Promise<void>`
48
+
49
+ Limpa o valor do campo de pesquisa
50
+
51
+ #### Returns
52
+
53
+ Type: `Promise<void>`
54
+
55
+
56
+
57
+ ### `getValueAsync() => Promise<IOption>`
58
+
59
+ Obtém o valor do componente só após a compo de apresentação
60
+ ter sido resolvido pelo option loader quando necessário
61
+
62
+ #### Returns
63
+
64
+ Type: `Promise<IOption>`
65
+
66
+
67
+
68
+ ### `isInvalid() => Promise<boolean>`
69
+
70
+ Retorna se o conteúdo é inválido.
71
+
72
+ #### Returns
73
+
74
+ Type: `Promise<boolean>`
75
+
76
+
77
+
78
+ ### `setBlur() => Promise<void>`
79
+
80
+ Remove o foco do campo.
81
+
82
+ #### Returns
83
+
84
+ Type: `Promise<void>`
85
+
86
+
87
+
88
+ ### `setFocus(options?: TFocusOptions) => Promise<void>`
89
+
90
+ Aplica o foco no campo.
91
+
92
+ #### Returns
93
+
94
+ Type: `Promise<void>`
95
+
96
+
97
+
98
+
99
+ ## Dependencies
100
+
101
+ ### Used by
102
+
103
+ - [ez-form-view](../ez-form-view)
104
+
105
+ ### Depends on
106
+
107
+ - [ez-icon](../ez-icon)
108
+ - [ez-text-input](../ez-text-input)
109
+ - [ez-popover-plus](../ez-popover-plus)
110
+ - [ez-search-result-list](./subcomponent/ez-search-result-list)
111
+
112
+ ### Graph
113
+ ```mermaid
114
+ graph TD;
115
+ ez-search-plus --> ez-icon
116
+ ez-search-plus --> ez-text-input
117
+ ez-search-plus --> ez-popover-plus
118
+ ez-search-plus --> ez-search-result-list
119
+ ez-text-input --> ez-tooltip
120
+ ez-text-input --> ez-icon
121
+ ez-popover-plus --> ez-popover-core
122
+ ez-search-result-list --> ez-card-item
123
+ ez-search-result-list --> ez-skeleton
124
+ ez-form-view --> ez-search-plus
125
+ style ez-search-plus fill:#f9f,stroke:#333,stroke-width:4px
126
+ ```
127
+
128
+ ----------------------------------------------
129
+
130
+