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

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 (10) hide show
  1. package/components/ez-card-item/readme.md +2 -0
  2. package/components/ez-form/readme.md +7 -1
  3. package/components/ez-form-view/readme.md +9 -2
  4. package/components/ez-icon/readme.md +2 -0
  5. package/components/ez-popover-plus/readme.md +2 -0
  6. package/components/ez-search-plus/readme.md +129 -0
  7. package/components/ez-search-plus/subcomponent/ez-search-result-list/readme.md +88 -0
  8. package/components/ez-text-input/readme.md +3 -0
  9. package/components/ez-tooltip/readme.md +10 -17
  10. package/package.json +1 -1
package/components/ez-card-item/readme.md CHANGED
@@ -25,11 +25,13 @@
25
25
 
26
26
  ### Used by
27
27
 
28
+ - [ez-search-result-list](../ez-search-plus/subcomponent/ez-search-result-list)
28
29
  - [search-list](../ez-search/subcomponent/search-list)
29
30
 
30
31
  ### Graph
31
32
  ```mermaid
32
33
  graph TD;
34
+ ez-search-result-list --> ez-card-item
33
35
  search-list --> ez-card-item
34
36
  style ez-card-item fill:#f9f,stroke:#333,stroke-width:4px
35
37
  ```
package/components/ez-form/readme.md CHANGED
@@ -81,9 +81,10 @@ graph TD;
81
81
  ez-form-view --> ez-date-time-input
82
82
  ez-form-view --> ez-upload
83
83
  ez-form-view --> ez-number-input
84
- ez-form-view --> ez-search
85
84
  ez-form-view --> ez-text-area
86
85
  ez-form-view --> ez-text-input
86
+ ez-form-view --> ez-search-plus
87
+ ez-form-view --> ez-search
87
88
  ez-collapsible-box --> ez-icon
88
89
  ez-collapsible-box --> ez-text-edit
89
90
  ez-text-edit --> ez-text-input
@@ -105,6 +106,11 @@ graph TD;
105
106
  ez-date-time-input --> ez-popover-plus
106
107
  ez-date-time-input --> ez-calendar
107
108
  ez-number-input --> ez-text-input
109
+ ez-search-plus --> ez-icon
110
+ ez-search-plus --> ez-text-input
111
+ ez-search-plus --> ez-popover-plus
112
+ ez-search-plus --> ez-search-result-list
113
+ ez-search-result-list --> ez-card-item
108
114
  ez-search --> ez-text-input
109
115
  ez-search --> ez-icon
110
116
  ez-search --> ez-popover-plus
package/components/ez-form-view/readme.md CHANGED
@@ -72,9 +72,10 @@ Type: `Promise<void>`
72
72
  - [ez-date-time-input](../ez-date-time-input)
73
73
  - [ez-upload](../ez-upload)
74
74
  - [ez-number-input](../ez-number-input)
75
- - [ez-search](../ez-search)
76
75
  - [ez-text-area](../ez-text-area)
77
76
  - [ez-text-input](../ez-text-input)
77
+ - [ez-search-plus](../ez-search-plus)
78
+ - [ez-search](../ez-search)
78
79
 
79
80
  ### Graph
80
81
  ```mermaid
@@ -88,9 +89,10 @@ graph TD;
88
89
  ez-form-view --> ez-date-time-input
89
90
  ez-form-view --> ez-upload
90
91
  ez-form-view --> ez-number-input
91
- ez-form-view --> ez-search
92
92
  ez-form-view --> ez-text-area
93
93
  ez-form-view --> ez-text-input
94
+ ez-form-view --> ez-search-plus
95
+ ez-form-view --> ez-search
94
96
  ez-collapsible-box --> ez-icon
95
97
  ez-collapsible-box --> ez-text-edit
96
98
  ez-text-edit --> ez-text-input
@@ -112,6 +114,11 @@ graph TD;
112
114
  ez-date-time-input --> ez-popover-plus
113
115
  ez-date-time-input --> ez-calendar
114
116
  ez-number-input --> ez-text-input
117
+ ez-search-plus --> ez-icon
118
+ ez-search-plus --> ez-text-input
119
+ ez-search-plus --> ez-popover-plus
120
+ ez-search-plus --> ez-search-result-list
121
+ ez-search-result-list --> ez-card-item
115
122
  ez-search --> ez-text-input
116
123
  ez-search --> ez-icon
117
124
  ez-search --> ez-popover-plus
package/components/ez-icon/readme.md CHANGED
@@ -34,6 +34,7 @@
34
34
  - [ez-modal-container](../ez-modal-container)
35
35
  - [ez-multi-selection-list](../ez-multi-selection-list)
36
36
  - [ez-search](../ez-search)
37
+ - [ez-search-plus](../ez-search-plus)
37
38
  - [ez-sidebar-button](../ez-sidebar-button)
38
39
  - [ez-split-button](../ez-split-button)
39
40
  - [ez-tabselector](../ez-tabselector)
@@ -60,6 +61,7 @@ graph TD;
60
61
  ez-modal-container --> ez-icon
61
62
  ez-multi-selection-list --> ez-icon
62
63
  ez-search --> ez-icon
64
+ ez-search-plus --> ez-icon
63
65
  ez-sidebar-button --> ez-icon
64
66
  ez-split-button --> ez-icon
65
67
  ez-tabselector --> ez-icon
package/components/ez-popover-plus/readme.md CHANGED
@@ -97,6 +97,7 @@ Type: `Promise<void>`
97
97
  - [ez-date-input](../ez-date-input)
98
98
  - [ez-date-time-input](../ez-date-time-input)
99
99
  - [ez-search](../ez-search)
100
+ - [ez-search-plus](../ez-search-plus)
100
101
  - [filter-column](../ez-grid/subcomponents)
101
102
 
102
103
  ### Depends on
@@ -111,6 +112,7 @@ graph TD;
111
112
  ez-date-input --> ez-popover-plus
112
113
  ez-date-time-input --> ez-popover-plus
113
114
  ez-search --> ez-popover-plus
115
+ ez-search-plus --> ez-popover-plus
114
116
  filter-column --> ez-popover-plus
115
117
  style ez-popover-plus fill:#f9f,stroke:#333,stroke-width:4px
116
118
  ```
package/components/ez-search-plus/readme.md ADDED
@@ -0,0 +1,129 @@
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` | <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` |
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<unknown>`
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<unknown>`
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-form-view --> ez-search-plus
124
+ style ez-search-plus fill:#f9f,stroke:#333,stroke-width:4px
125
+ ```
126
+
127
+ ----------------------------------------------
128
+
129
+
package/components/ez-search-plus/subcomponent/ez-search-result-list/readme.md ADDED
@@ -0,0 +1,88 @@
1
+ # ez-search-result-list
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------------- | ----------- | ------------------- | ----------- |
12
+ | `showLoading` | `show-loading` | | `boolean` | `undefined` |
13
+ | `showOptionValue` | `show-option-value` | | `boolean` | `true` |
14
+ | `value` | `value` | | `IOption \| string` | `undefined` |
15
+ | `visibleOptions` | -- | | `IOption[]` | `[]` |
16
+
17
+
18
+ ## Events
19
+
20
+ | Event | Description | Type |
21
+ | ------------- | ----------- | ---------------------- |
22
+ | `changeValue` | | `CustomEvent<IOption>` |
23
+
24
+
25
+ ## Methods
26
+
27
+ ### `cancelSelection() => Promise<void>`
28
+
29
+
30
+
31
+ #### Returns
32
+
33
+ Type: `Promise<void>`
34
+
35
+
36
+
37
+ ### `nextOption() => Promise<void>`
38
+
39
+
40
+
41
+ #### Returns
42
+
43
+ Type: `Promise<void>`
44
+
45
+
46
+
47
+ ### `previousOption() => Promise<void>`
48
+
49
+
50
+
51
+ #### Returns
52
+
53
+ Type: `Promise<void>`
54
+
55
+
56
+
57
+ ### `selectCurrentItem() => Promise<void>`
58
+
59
+
60
+
61
+ #### Returns
62
+
63
+ Type: `Promise<void>`
64
+
65
+
66
+
67
+
68
+ ## Dependencies
69
+
70
+ ### Used by
71
+
72
+ - [ez-search-plus](../..)
73
+
74
+ ### Depends on
75
+
76
+ - [ez-card-item](../../../ez-card-item)
77
+
78
+ ### Graph
79
+ ```mermaid
80
+ graph TD;
81
+ ez-search-result-list --> ez-card-item
82
+ ez-search-plus --> ez-search-result-list
83
+ style ez-search-result-list fill:#f9f,stroke:#333,stroke-width:4px
84
+ ```
85
+
86
+ ----------------------------------------------
87
+
88
+
package/components/ez-text-input/readme.md CHANGED
@@ -14,6 +14,7 @@
14
14
  | `cleanValueMask` | `clean-value-mask` | Para remover a máscara quando fizer um apply no formulário. | `boolean` | `false` |
15
15
  | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
16
16
  | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
17
+ | `hasInvalid` | `has-invalid` | Define se o campo está em estado inválido (bordas vermelhas). | `boolean` | `false` |
17
18
  | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
18
19
  | `mask` | `mask` | Aplica uma máscara no conteúdo conforme o padrão estabelecido | `string` | `undefined` |
19
20
  | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
@@ -74,6 +75,7 @@ Type: `Promise<void>`
74
75
  - [ez-form-view](../ez-form-view)
75
76
  - [ez-number-input](../ez-number-input)
76
77
  - [ez-search](../ez-search)
78
+ - [ez-search-plus](../ez-search-plus)
77
79
  - [ez-text-edit](../ez-text-edit)
78
80
  - [ez-time-input](../ez-time-input)
79
81
 
@@ -94,6 +96,7 @@ graph TD;
94
96
  ez-form-view --> ez-text-input
95
97
  ez-number-input --> ez-text-input
96
98
  ez-search --> ez-text-input
99
+ ez-search-plus --> ez-text-input
97
100
  ez-text-edit --> ez-text-input
98
101
  ez-time-input --> ez-text-input
99
102
  style ez-text-input fill:#f9f,stroke:#333,stroke-width:4px
package/components/ez-tooltip/readme.md CHANGED
@@ -7,23 +7,16 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------ | --------------- | ----------------------------------------------------------- | ------------- | ----------- |
12
- | `anchoringElement` | -- | Elemento HTML que será utilizado como ancoragem do tooltip. | `HTMLElement` | `undefined` |
13
- | `errorMessage` | `error-message` | Mensagem de erro que será apresentada no tooltip. | `string` | `undefined` |
14
-
15
-
16
- ## Methods
17
-
18
- ### `positionTooltip() => Promise<void>`
19
-
20
- Reposiciona o tooltip de acordo com a posição do elemento de ancoragem.
21
-
22
- #### Returns
23
-
24
- Type: `Promise<void>`
25
-
26
-
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'` |
27
20
 
28
21
 
29
22
  ## Dependencies
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "5.22.0-dev.109",
3
+ "version": "5.22.0-dev.110",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [