@sankhyalabs/ezui-docs 5.20.0-dev.1 → 5.20.0-dev.3
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.
- package/components/ez-card-item/readme.md +13 -0
- package/components/ez-combo-box/readme.md +0 -3
- package/components/ez-form/readme.md +3 -1
- package/components/ez-form-view/readme.md +3 -1
- package/components/ez-grid/readme.md +3 -3
- package/components/ez-grid/subcomponents/readme.md +3 -3
- package/components/ez-icon/readme.md +2 -0
- package/components/ez-multi-selection-list/readme.md +3 -3
- package/components/ez-search/readme.md +24 -20
- package/components/ez-text-input/readme.md +2 -0
- package/package.json +1 -1
|
@@ -19,6 +19,19 @@
|
|
|
19
19
|
| `ezClick` | Emitido sempre que o ez-card é clicado. | `CustomEvent<CardItem>` |
|
|
20
20
|
|
|
21
21
|
|
|
22
|
+
## Dependencies
|
|
23
|
+
|
|
24
|
+
### Used by
|
|
25
|
+
|
|
26
|
+
- [ez-search](../ez-search)
|
|
27
|
+
|
|
28
|
+
### Graph
|
|
29
|
+
```mermaid
|
|
30
|
+
graph TD;
|
|
31
|
+
ez-search --> ez-card-item
|
|
32
|
+
style ez-card-item fill:#f9f,stroke:#333,stroke-width:4px
|
|
33
|
+
```
|
|
34
|
+
|
|
22
35
|
----------------------------------------------
|
|
23
36
|
|
|
24
37
|
|
|
@@ -20,7 +20,6 @@
|
|
|
20
20
|
| `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
|
|
21
21
|
| `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument) => IOption \| IOption[] \| Promise<IOption[]>` | `undefined` |
|
|
22
22
|
| `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
|
|
23
|
-
| `searchMode` | `search-mode` | Se true ativa o modo pesquisa do ez-combo-box. | `boolean` | `undefined` |
|
|
24
23
|
| `showOptionValue` | `show-option-value` | Se true cada opção na lista exibe o `value` junto com `label`. | `boolean` | `false` |
|
|
25
24
|
| `showSelectedValue` | `show-selected-value` | Se true a opção selecionada exibe o `value` junto com `label`. | `boolean` | `false` |
|
|
26
25
|
| `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
|
|
@@ -93,7 +92,6 @@ Type: `Promise<void>`
|
|
|
93
92
|
### Used by
|
|
94
93
|
|
|
95
94
|
- [ez-form-view](../ez-form-view)
|
|
96
|
-
- [ez-search](../ez-search)
|
|
97
95
|
|
|
98
96
|
### Depends on
|
|
99
97
|
|
|
@@ -106,7 +104,6 @@ graph TD;
|
|
|
106
104
|
ez-combo-box --> ez-text-input
|
|
107
105
|
ez-combo-box --> ez-icon
|
|
108
106
|
ez-form-view --> ez-combo-box
|
|
109
|
-
ez-search --> ez-combo-box
|
|
110
107
|
style ez-combo-box fill:#f9f,stroke:#333,stroke-width:4px
|
|
111
108
|
```
|
|
112
109
|
|
|
@@ -76,7 +76,9 @@ graph TD;
|
|
|
76
76
|
ez-date-time-input --> ez-text-input
|
|
77
77
|
ez-date-time-input --> ez-calendar
|
|
78
78
|
ez-number-input --> ez-text-input
|
|
79
|
-
ez-search --> ez-
|
|
79
|
+
ez-search --> ez-card-item
|
|
80
|
+
ez-search --> ez-text-input
|
|
81
|
+
ez-search --> ez-icon
|
|
80
82
|
style ez-form fill:#f9f,stroke:#333,stroke-width:4px
|
|
81
83
|
```
|
|
82
84
|
|
|
@@ -81,7 +81,9 @@ graph TD;
|
|
|
81
81
|
ez-date-time-input --> ez-text-input
|
|
82
82
|
ez-date-time-input --> ez-calendar
|
|
83
83
|
ez-number-input --> ez-text-input
|
|
84
|
-
ez-search --> ez-
|
|
84
|
+
ez-search --> ez-card-item
|
|
85
|
+
ez-search --> ez-text-input
|
|
86
|
+
ez-search --> ez-icon
|
|
85
87
|
ez-form --> ez-form-view
|
|
86
88
|
style ez-form-view fill:#f9f,stroke:#333,stroke-width:4px
|
|
87
89
|
```
|
|
@@ -162,9 +162,9 @@ graph TD;
|
|
|
162
162
|
ez-list --> ez-check
|
|
163
163
|
ez-filter-input --> ez-text-input
|
|
164
164
|
ez-filter-input --> ez-icon
|
|
165
|
-
ez-search --> ez-
|
|
166
|
-
ez-
|
|
167
|
-
ez-
|
|
165
|
+
ez-search --> ez-card-item
|
|
166
|
+
ez-search --> ez-text-input
|
|
167
|
+
ez-search --> ez-icon
|
|
168
168
|
style ez-grid fill:#f9f,stroke:#333,stroke-width:4px
|
|
169
169
|
```
|
|
170
170
|
|
|
@@ -77,9 +77,9 @@ graph TD;
|
|
|
77
77
|
ez-list --> ez-check
|
|
78
78
|
ez-filter-input --> ez-text-input
|
|
79
79
|
ez-filter-input --> ez-icon
|
|
80
|
-
ez-search --> ez-
|
|
81
|
-
ez-
|
|
82
|
-
ez-
|
|
80
|
+
ez-search --> ez-card-item
|
|
81
|
+
ez-search --> ez-text-input
|
|
82
|
+
ez-search --> ez-icon
|
|
83
83
|
ez-grid --> filter-column
|
|
84
84
|
style filter-column fill:#f9f,stroke:#333,stroke-width:4px
|
|
85
85
|
```
|
|
@@ -33,6 +33,7 @@
|
|
|
33
33
|
- [ez-grid](../ez-grid)
|
|
34
34
|
- [ez-modal-container](../ez-modal-container)
|
|
35
35
|
- [ez-multi-selection-list](../ez-multi-selection-list)
|
|
36
|
+
- [ez-search](../ez-search)
|
|
36
37
|
- [ez-tabselector](../ez-tabselector)
|
|
37
38
|
- [ez-time-input](../ez-time-input)
|
|
38
39
|
- [ez-tree](../ez-tree)
|
|
@@ -55,6 +56,7 @@ graph TD;
|
|
|
55
56
|
ez-grid --> ez-icon
|
|
56
57
|
ez-modal-container --> ez-icon
|
|
57
58
|
ez-multi-selection-list --> ez-icon
|
|
59
|
+
ez-search --> ez-icon
|
|
58
60
|
ez-tabselector --> ez-icon
|
|
59
61
|
ez-time-input --> ez-icon
|
|
60
62
|
ez-tree --> ez-icon
|
|
@@ -63,9 +63,9 @@ graph TD;
|
|
|
63
63
|
ez-list --> ez-check
|
|
64
64
|
ez-filter-input --> ez-text-input
|
|
65
65
|
ez-filter-input --> ez-icon
|
|
66
|
-
ez-search --> ez-
|
|
67
|
-
ez-
|
|
68
|
-
ez-
|
|
66
|
+
ez-search --> ez-card-item
|
|
67
|
+
ez-search --> ez-text-input
|
|
68
|
+
ez-search --> ez-icon
|
|
69
69
|
filter-column --> ez-multi-selection-list
|
|
70
70
|
style ez-multi-selection-list fill:#f9f,stroke:#333,stroke-width:4px
|
|
71
71
|
```
|
|
@@ -7,22 +7,24 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description
|
|
11
|
-
| -------------------------- | ------------------------------ |
|
|
12
|
-
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo.
|
|
13
|
-
| `enabled` | `enabled` | Se false o usuário não pode interagir com o campo.
|
|
14
|
-
| `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido.
|
|
15
|
-
| `hideErrorOnFocusOut` | `hide-error-on-focus-out` | Quando verdadeiro deixa de exibir a mensagem de erro (se existente) quando focar em um elemento diferente.
|
|
16
|
-
| `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Define se deve ignorar o limite de caracteres mínimo para realizar uma pesquisa
|
|
17
|
-
| `isTextSearch` | `is-text-search` | Informa se a pesquisa é do tipo texto.
|
|
18
|
-
| `label` | `label` | Texto a ser apresentado como título do campo.
|
|
19
|
-
| `listOptionsPosition` | -- | Define um posicionamento fixo para a lista de opções do CheckBox.
|
|
20
|
-
| `mode` | `mode` | Define o tamanho do campo.
|
|
21
|
-
| `optionLoader` | -- | Carrega as opções dinamicamente.
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
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
|
+
| `options` | -- | Array com as opções do ez-combo-box. Os elementos devem obedecer o formato: `{value: string, label: string}`. | `IOption[]` | `undefined` |
|
|
23
|
+
| `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
|
|
24
|
+
| `showSelectedValue` | `show-selected-value` | Se false a opção selecionada deve exibir somente o `label`. | `boolean` | `true` |
|
|
25
|
+
| `suppressEmptyOption` | `suppress-empty-option` | Se true remove a opção vazia da lista. | `boolean` | `false` |
|
|
26
|
+
| `suppressSearch` | `suppress-search` | Se true desabilita a digitação dentro do componente. | `boolean` | `false` |
|
|
27
|
+
| `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
|
|
26
28
|
|
|
27
29
|
|
|
28
30
|
## Events
|
|
@@ -94,14 +96,16 @@ Type: `Promise<void>`
|
|
|
94
96
|
|
|
95
97
|
### Depends on
|
|
96
98
|
|
|
97
|
-
- [ez-
|
|
99
|
+
- [ez-card-item](../ez-card-item)
|
|
100
|
+
- [ez-text-input](../ez-text-input)
|
|
101
|
+
- [ez-icon](../ez-icon)
|
|
98
102
|
|
|
99
103
|
### Graph
|
|
100
104
|
```mermaid
|
|
101
105
|
graph TD;
|
|
102
|
-
ez-search --> ez-
|
|
103
|
-
ez-
|
|
104
|
-
ez-
|
|
106
|
+
ez-search --> ez-card-item
|
|
107
|
+
ez-search --> ez-text-input
|
|
108
|
+
ez-search --> ez-icon
|
|
105
109
|
ez-form-view --> ez-search
|
|
106
110
|
ez-multi-selection-list --> ez-search
|
|
107
111
|
style ez-search fill:#f9f,stroke:#333,stroke-width:4px
|
|
@@ -71,6 +71,7 @@ Type: `Promise<void>`
|
|
|
71
71
|
- [ez-filter-input](../ez-filter-input)
|
|
72
72
|
- [ez-form-view](../ez-form-view)
|
|
73
73
|
- [ez-number-input](../ez-number-input)
|
|
74
|
+
- [ez-search](../ez-search)
|
|
74
75
|
- [ez-text-edit](../ez-text-edit)
|
|
75
76
|
- [ez-time-input](../ez-time-input)
|
|
76
77
|
|
|
@@ -83,6 +84,7 @@ graph TD;
|
|
|
83
84
|
ez-filter-input --> ez-text-input
|
|
84
85
|
ez-form-view --> ez-text-input
|
|
85
86
|
ez-number-input --> ez-text-input
|
|
87
|
+
ez-search --> ez-text-input
|
|
86
88
|
ez-text-edit --> ez-text-input
|
|
87
89
|
ez-time-input --> ez-text-input
|
|
88
90
|
style ez-text-input fill:#f9f,stroke:#333,stroke-width:4px
|