@sankhyalabs/ezui-docs 5.20.0-dev.4 → 5.20.0-dev.41

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 (17) hide show
  1. package/components/ez-button/readme.md +2 -0
  2. package/components/ez-card-item/readme.md +17 -3
  3. package/components/ez-combo-box/readme.md +0 -3
  4. package/components/ez-dropdown/readme.md +2 -0
  5. package/components/ez-form/readme.md +3 -1
  6. package/components/ez-form-view/readme.md +3 -1
  7. package/components/ez-grid/readme.md +3 -3
  8. package/components/ez-grid/subcomponents/readme.md +3 -3
  9. package/components/ez-icon/readme.md +4 -0
  10. package/components/ez-multi-selection-list/readme.md +3 -3
  11. package/components/ez-popup/readme.md +4 -3
  12. package/components/ez-search/readme.md +24 -20
  13. package/components/ez-split-button/readme.md +83 -0
  14. package/components/ez-split-panel/readme.md +17 -4
  15. package/components/ez-split-panel/structure/item/readme.md +23 -0
  16. package/components/ez-text-input/readme.md +2 -0
  17. package/package.json +1 -1
package/components/ez-button/readme.md CHANGED
@@ -50,6 +50,7 @@ Type: `Promise<void>`
50
50
  - [ez-grid](../ez-grid)
51
51
  - [ez-guide-navigator](../ez-guide-navigator)
52
52
  - [ez-modal-container](../ez-modal-container)
53
+ - [ez-split-item](../ez-split-panel/structure/item)
53
54
  - [ez-text-edit](../ez-text-edit)
54
55
  - [filter-column](../ez-grid/subcomponents)
55
56
 
@@ -67,6 +68,7 @@ graph TD;
67
68
  ez-grid --> ez-button
68
69
  ez-guide-navigator --> ez-button
69
70
  ez-modal-container --> ez-button
71
+ ez-split-item --> ez-button
70
72
  ez-text-edit --> ez-button
71
73
  filter-column --> ez-button
72
74
  style ez-button fill:#f9f,stroke:#333,stroke-width:4px
package/components/ez-card-item/readme.md CHANGED
@@ -7,9 +7,10 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------- | --------- | ------------------------------------------------------------------------------------------------------------- | ---------- | ----------- |
12
- | `item` | -- | Determina o conteúdo do card. Deve conter um objeto no formato: `{title: string, key: string, details: any}`. | `CardItem` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------- | ------------ | ------------------------------------------------------------------------------------------------------------- | ---------- | ----------- |
12
+ | `enableKey` | `enable-key` | Determina se a chave do item deve ser exibida. | `boolean` | `true` |
13
+ | `item` | -- | Determina o conteúdo do card. Deve conter um objeto no formato: `{title: string, key: string, details: any}`. | `CardItem` | `undefined` |
13
14
 
14
15
 
15
16
  ## Events
@@ -19,6 +20,19 @@
19
20
  | `ezClick` | Emitido sempre que o ez-card é clicado. | `CustomEvent<CardItem>` |
20
21
 
21
22
 
23
+ ## Dependencies
24
+
25
+ ### Used by
26
+
27
+ - [ez-search](../ez-search)
28
+
29
+ ### Graph
30
+ ```mermaid
31
+ graph TD;
32
+ ez-search --> ez-card-item
33
+ style ez-card-item fill:#f9f,stroke:#333,stroke-width:4px
34
+ ```
35
+
22
36
  ----------------------------------------------
23
37
 
24
38
 
package/components/ez-combo-box/readme.md CHANGED
@@ -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
 
package/components/ez-dropdown/readme.md CHANGED
@@ -28,6 +28,7 @@
28
28
  ### Used by
29
29
 
30
30
  - [ez-breadcrumb](../ez-breadcrumb)
31
+ - [ez-split-button](../ez-split-button)
31
32
 
32
33
  ### Depends on
33
34
 
@@ -38,6 +39,7 @@
38
39
  graph TD;
39
40
  ez-dropdown --> ez-icon
40
41
  ez-breadcrumb --> ez-dropdown
42
+ ez-split-button --> ez-dropdown
41
43
  style ez-dropdown fill:#f9f,stroke:#333,stroke-width:4px
42
44
  ```
43
45
 
package/components/ez-form/readme.md CHANGED
@@ -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-combo-box
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
 
package/components/ez-form-view/readme.md CHANGED
@@ -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-combo-box
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
  ```
package/components/ez-grid/readme.md CHANGED
@@ -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-combo-box
166
- ez-combo-box --> ez-text-input
167
- ez-combo-box --> ez-icon
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
 
package/components/ez-grid/subcomponents/readme.md CHANGED
@@ -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-combo-box
81
- ez-combo-box --> ez-text-input
82
- ez-combo-box --> ez-icon
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
  ```
package/components/ez-icon/readme.md CHANGED
@@ -33,6 +33,8 @@
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)
37
+ - [ez-split-button](../ez-split-button)
36
38
  - [ez-tabselector](../ez-tabselector)
37
39
  - [ez-time-input](../ez-time-input)
38
40
  - [ez-tree](../ez-tree)
@@ -55,6 +57,8 @@ graph TD;
55
57
  ez-grid --> ez-icon
56
58
  ez-modal-container --> ez-icon
57
59
  ez-multi-selection-list --> ez-icon
60
+ ez-search --> ez-icon
61
+ ez-split-button --> ez-icon
58
62
  ez-tabselector --> ez-icon
59
63
  ez-time-input --> ez-icon
60
64
  ez-tree --> ez-icon
package/components/ez-multi-selection-list/readme.md CHANGED
@@ -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-combo-box
67
- ez-combo-box --> ez-text-input
68
- ez-combo-box --> ez-icon
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
  ```
package/components/ez-popup/readme.md CHANGED
@@ -18,9 +18,10 @@
18
18
 
19
19
  ## Events
20
20
 
21
- | Event | Description | Type |
22
- | -------------- | ------------------------------------------------------ | ------------------ |
23
- | `ezClosePopup` | Emitido ao clicar no botão de fechar (onEzClosePopup). | `CustomEvent<any>` |
21
+ | Event | Description | Type |
22
+ | --------------- | ---------------------------------------------------------------- | --------------------- |
23
+ | `ezClosePopup` | Evento emitido ao clicar no botão de fechar (onEzClosePopup). | `CustomEvent<any>` |
24
+ | `ezPopupAction` | Evento emitido ao clicar no botão de fechar (ezPopupAction = OK) | `CustomEvent<string>` |
24
25
 
25
26
 
26
27
  ----------------------------------------------
package/components/ez-search/readme.md CHANGED
@@ -7,22 +7,24 @@
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
- | `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` |
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-combo-box](../ez-combo-box)
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-combo-box
103
- ez-combo-box --> ez-text-input
104
- ez-combo-box --> ez-icon
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
package/components/ez-split-button/readme.md ADDED
@@ -0,0 +1,83 @@
1
+ # ez-split-button
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------ | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | --------------- |
12
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o botão. | `boolean` | `true` |
13
+ | `iconName` | `icon-name` | Define o ícone a ser usado da biblioteca de ícones: [ez-icons](https://gilded-nasturtium-6b64dd.netlify.app/docs/components/layout-doc/icons/) | `string` | `undefined` |
14
+ | `image` | `image` | Define o caminho usado nos modos `icon-only` e `icon-left` para imagens não contempladas na biblioteca de ícones. | `string` | `undefined` |
15
+ | `items` | -- | Define o conteúdo do dropdown. | `IDropdownItem[]` | `undefined` |
16
+ | `label` | `label` | Texto a ser apresentado como label do botão. | `string` | `undefined` |
17
+ | `leftTitle` | `left-title` | Texto a ser apresentado como title do botão principal | `string` | `undefined` |
18
+ | `mode` | `mode` | Define o modo de uso do botão. | `"default" \| "icon-left" \| "icon-only"` | `'default'` |
19
+ | `rightTitle` | `right-title` | Texto a ser apresentado como title do botão dropdown | `string` | `'Mais opções'` |
20
+ | `size` | `size` | Define o tamanho do ez-split-button. | `"large" \| "medium"` | `'medium'` |
21
+
22
+
23
+ ## Events
24
+
25
+ | Event | Description | Type |
26
+ | ------------------------ | ------------------------------------------------------------- | --------------------------------- |
27
+ | `buttonClick` | Emitido quando o botão principal é clicado | `CustomEvent<void>` |
28
+ | `dropdownItemClick` | Emitido quando um item do dropdown é clicado | `CustomEvent<IDropdownItem>` |
29
+ | `dropdownSubActionClick` | Emitido quando uma subAction de um item do dropdown é clicada | `CustomEvent<IDropdownSubAction>` |
30
+
31
+
32
+ ## Methods
33
+
34
+ ### `setBlur() => Promise<void>`
35
+
36
+ Remove o foco de ambos os botões.
37
+
38
+ #### Returns
39
+
40
+ Type: `Promise<void>`
41
+
42
+
43
+
44
+ ### `setLeftButtonFocus() => Promise<void>`
45
+
46
+ Aplica o foco no botão principal.
47
+
48
+ #### Returns
49
+
50
+ Type: `Promise<void>`
51
+
52
+
53
+
54
+ ### `setRightButtonFocus() => Promise<void>`
55
+
56
+ Aplica o foco no botão do dropdown.
57
+
58
+ #### Returns
59
+
60
+ Type: `Promise<void>`
61
+
62
+
63
+
64
+
65
+ ## Dependencies
66
+
67
+ ### Depends on
68
+
69
+ - [ez-icon](../ez-icon)
70
+ - [ez-dropdown](../ez-dropdown)
71
+
72
+ ### Graph
73
+ ```mermaid
74
+ graph TD;
75
+ ez-split-button --> ez-icon
76
+ ez-split-button --> ez-dropdown
77
+ ez-dropdown --> ez-icon
78
+ style ez-split-button fill:#f9f,stroke:#333,stroke-width:4px
79
+ ```
80
+
81
+ ----------------------------------------------
82
+
83
+
package/components/ez-split-panel/readme.md CHANGED
@@ -7,10 +7,23 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------- | ----------- | ------------------------------- | ------------------- | ----------- |
12
- | `direction` | `direction` | | `"column" \| "row"` | `'column'` |
13
- | `label` | `label` | Define um título para o painel. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------- | ------------------ | ------------------------------------------------------------------------ | ------------------- | ---------- |
12
+ | `anchorToExpand` | `anchor-to-expand` | Responsável por definir o painel que limita o tamanho do item expandido. | `boolean` | `false` |
13
+ | `direction` | `direction` | | `"column" \| "row"` | `'column'` |
14
+
15
+
16
+ ## Methods
17
+
18
+ ### `rebuildLayout() => Promise<void>`
19
+
20
+
21
+
22
+ #### Returns
23
+
24
+ Type: `Promise<void>`
25
+
26
+
14
27
 
15
28
 
16
29
  ----------------------------------------------
package/components/ez-split-panel/structure/item/readme.md CHANGED
@@ -5,6 +5,29 @@
5
5
  <!-- Auto Generated Below -->
6
6
 
7
7
 
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | --------------- | ----------------------------------- | --------- | ----------- |
12
+ | `enableExpand` | `enable-expand` | Define se o item pode ser expandido | `boolean` | `true` |
13
+ | `label` | `label` | Define um título para o painel. | `string` | `undefined` |
14
+ | `size` | `size` | Define o tamanho inicial do painel. | `string` | `undefined` |
15
+
16
+
17
+ ## Dependencies
18
+
19
+ ### Depends on
20
+
21
+ - [ez-button](../../../ez-button)
22
+
23
+ ### Graph
24
+ ```mermaid
25
+ graph TD;
26
+ ez-split-item --> ez-button
27
+ ez-button --> ez-icon
28
+ style ez-split-item fill:#f9f,stroke:#333,stroke-width:4px
29
+ ```
30
+
8
31
  ----------------------------------------------
9
32
 
10
33
 
package/components/ez-text-input/readme.md CHANGED
@@ -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
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "5.20.0-dev.4",
3
+ "version": "5.20.0-dev.41",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [