@sankhyalabs/ezui-docs 4.18.1 → 4.19.0

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 (13) hide show
  1. package/components/ez-button/readme.md +2 -0
  2. package/components/ez-check/readme.md +2 -0
  3. package/components/ez-filter-input/readme.md +2 -0
  4. package/components/ez-grid/readme.md +27 -7
  5. package/components/ez-grid/subcomponents/readme.md +87 -0
  6. package/components/ez-icon/readme.md +2 -0
  7. package/components/ez-list/readme.md +6 -1
  8. package/components/ez-multi-selection-list/readme.md +74 -0
  9. package/components/ez-multi-selection-list/subcomponents/readme.md +30 -0
  10. package/components/ez-popover/readme.md +13 -0
  11. package/components/ez-search/readme.md +2 -0
  12. package/components/ez-toast/readme.md +13 -0
  13. package/package.json +1 -1
package/components/ez-button/readme.md CHANGED
@@ -50,6 +50,7 @@ Type: `Promise<void>`
50
50
  - [ez-guide-navigator](../ez-guide-navigator)
51
51
  - [ez-modal-container](../ez-modal-container)
52
52
  - [ez-text-edit](../ez-text-edit)
53
+ - [filter-column](../ez-grid/subcomponents)
53
54
 
54
55
  ### Depends on
55
56
 
@@ -65,6 +66,7 @@ graph TD;
65
66
  ez-guide-navigator --> ez-button
66
67
  ez-modal-container --> ez-button
67
68
  ez-text-edit --> ez-button
69
+ filter-column --> ez-button
68
70
  style ez-button fill:#f9f,stroke:#333,stroke-width:4px
69
71
  ```
70
72
 
package/components/ez-check/readme.md CHANGED
@@ -53,12 +53,14 @@ Type: `Promise<void>`
53
53
 
54
54
  - [ez-form-view](../ez-form-view)
55
55
  - [ez-list](../ez-list)
56
+ - [ez-multi-selection-list](../ez-multi-selection-list)
56
57
 
57
58
  ### Graph
58
59
  ```mermaid
59
60
  graph TD;
60
61
  ez-form-view --> ez-check
61
62
  ez-list --> ez-check
63
+ ez-multi-selection-list --> ez-check
62
64
  style ez-check fill:#f9f,stroke:#333,stroke-width:4px
63
65
  ```
64
66
 
package/components/ez-filter-input/readme.md CHANGED
@@ -86,6 +86,7 @@ Type: `Promise<void>`
86
86
  ### Used by
87
87
 
88
88
  - [ez-guide-navigator](../ez-guide-navigator)
89
+ - [ez-multi-selection-list](../ez-multi-selection-list)
89
90
 
90
91
  ### Depends on
91
92
 
@@ -98,6 +99,7 @@ graph TD;
98
99
  ez-filter-input --> ez-text-input
99
100
  ez-filter-input --> ez-icon
100
101
  ez-guide-navigator --> ez-filter-input
102
+ ez-multi-selection-list --> ez-filter-input
101
103
  style ez-filter-input fill:#f9f,stroke:#333,stroke-width:4px
102
104
  ```
103
105
 
package/components/ez-grid/readme.md CHANGED
@@ -7,13 +7,14 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------- | -------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
12
- | `config` | -- | Configuração de exibição da grade. | `IGridConfig` | `undefined` |
13
- | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
14
- | `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas. | `boolean` | `undefined` |
15
- | `serverUrl` | `server-url` | Endereço do servidor para obtenção dos dados. | `string` | `undefined` |
16
- | `statusResolver` | -- | Define um `IStatusResolver` responsável pelo estado da coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------ | -------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
12
+ | `columnfilterDataSource` | -- | Define um `IMultiSelectionListDataSource` responsável por alimentar o filtro de colunas. | `IMultiSelectionListDataSource` | `undefined` |
13
+ | `config` | -- | Configuração de exibição da grade. | `IGridConfig` | `undefined` |
14
+ | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
15
+ | `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas. | `boolean` | `undefined` |
16
+ | `serverUrl` | `server-url` | Endereço do servidor para obtenção dos dados. | `string` | `undefined` |
17
+ | `statusResolver` | -- | Define um `IStatusResolver` responsável pelo estado da coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
17
18
 
18
19
 
19
20
  ## Events
@@ -115,14 +116,33 @@ Type: `Promise<void>`
115
116
  ### Depends on
116
117
 
117
118
  - [ez-button](../ez-button)
119
+ - [filter-column](subcomponents)
120
+ - [ez-toast](../ez-toast)
118
121
  - [ez-icon](../ez-icon)
119
122
 
120
123
  ### Graph
121
124
  ```mermaid
122
125
  graph TD;
123
126
  ez-grid --> ez-button
127
+ ez-grid --> filter-column
128
+ ez-grid --> ez-toast
124
129
  ez-grid --> ez-icon
125
130
  ez-button --> ez-icon
131
+ filter-column --> ez-popover
132
+ filter-column --> ez-button
133
+ filter-column --> ez-multi-selection-list
134
+ ez-multi-selection-list --> ez-check
135
+ ez-multi-selection-list --> ez-list
136
+ ez-multi-selection-list --> ez-icon
137
+ ez-multi-selection-list --> multi-selection-box-message
138
+ ez-multi-selection-list --> ez-filter-input
139
+ ez-multi-selection-list --> ez-search
140
+ ez-list --> ez-check
141
+ ez-filter-input --> ez-text-input
142
+ ez-filter-input --> ez-icon
143
+ ez-search --> ez-combo-box
144
+ ez-combo-box --> ez-text-input
145
+ ez-combo-box --> ez-icon
126
146
  style ez-grid fill:#f9f,stroke:#333,stroke-width:4px
127
147
  ```
128
148
 
package/components/ez-grid/subcomponents/readme.md ADDED
@@ -0,0 +1,87 @@
1
+ # filter-column
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------- | -------------- | ----------- | ------------------------------- | ----------- |
12
+ | `columnLabel` | `column-label` | | `string` | `undefined` |
13
+ | `columnName` | `column-name` | | `string` | `undefined` |
14
+ | `dataSource` | -- | | `IMultiSelectionListDataSource` | `undefined` |
15
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
16
+ | `opened` | `opened` | | `boolean` | `true` |
17
+ | `options` | -- | | `IMultiSelectionOption[]` | `undefined` |
18
+
19
+
20
+ ## Events
21
+
22
+ | Event | Description | Type |
23
+ | -------------------------- | ----------- | ------------------------------------------ |
24
+ | `applyFilterColumnOptions` | | `CustomEvent<IAppliedFilterColumnOptions>` |
25
+
26
+
27
+ ## Methods
28
+
29
+ ### `hide() => Promise<void>`
30
+
31
+
32
+
33
+ #### Returns
34
+
35
+ Type: `Promise<void>`
36
+
37
+
38
+
39
+ ### `show(configs: IFilterColumnConfigs) => Promise<void>`
40
+
41
+ Abre o filtro de coluna.
42
+
43
+ #### Returns
44
+
45
+ Type: `Promise<void>`
46
+
47
+
48
+
49
+
50
+ ## Dependencies
51
+
52
+ ### Used by
53
+
54
+ - [ez-grid](..)
55
+
56
+ ### Depends on
57
+
58
+ - [ez-popover](../../ez-popover)
59
+ - [ez-button](../../ez-button)
60
+ - [ez-multi-selection-list](../../ez-multi-selection-list)
61
+
62
+ ### Graph
63
+ ```mermaid
64
+ graph TD;
65
+ filter-column --> ez-popover
66
+ filter-column --> ez-button
67
+ filter-column --> ez-multi-selection-list
68
+ ez-button --> ez-icon
69
+ ez-multi-selection-list --> ez-check
70
+ ez-multi-selection-list --> ez-list
71
+ ez-multi-selection-list --> ez-icon
72
+ ez-multi-selection-list --> multi-selection-box-message
73
+ ez-multi-selection-list --> ez-filter-input
74
+ ez-multi-selection-list --> ez-search
75
+ ez-list --> ez-check
76
+ ez-filter-input --> ez-text-input
77
+ ez-filter-input --> ez-icon
78
+ ez-search --> ez-combo-box
79
+ ez-combo-box --> ez-text-input
80
+ ez-combo-box --> ez-icon
81
+ ez-grid --> filter-column
82
+ style filter-column fill:#f9f,stroke:#333,stroke-width:4px
83
+ ```
84
+
85
+ ----------------------------------------------
86
+
87
+
package/components/ez-icon/readme.md CHANGED
@@ -32,6 +32,7 @@
32
32
  - [ez-filter-input](../ez-filter-input)
33
33
  - [ez-grid](../ez-grid)
34
34
  - [ez-modal-container](../ez-modal-container)
35
+ - [ez-multi-selection-list](../ez-multi-selection-list)
35
36
  - [ez-tabselector](../ez-tabselector)
36
37
  - [ez-time-input](../ez-time-input)
37
38
  - [ez-tree](../ez-tree)
@@ -53,6 +54,7 @@ graph TD;
53
54
  ez-filter-input --> ez-icon
54
55
  ez-grid --> ez-icon
55
56
  ez-modal-container --> ez-icon
57
+ ez-multi-selection-list --> ez-icon
56
58
  ez-tabselector --> ez-icon
57
59
  ez-time-input --> ez-icon
58
60
  ez-tree --> ez-icon
package/components/ez-list/readme.md CHANGED
@@ -14,7 +14,7 @@
14
14
  | `ezSelectable` | `ez-selectable` | Se true os itens serão selecionáveis. | `boolean` | `false` |
15
15
  | `hoverFeedback` | `hover-feedback` | Quando verdadeiro, ativa o feedback visual ao efetuar houver nos itens da lista. | `boolean` | `false` |
16
16
  | `itemSlotBuilder` | -- | Função builder que possibilita alterar como o item da lista vai ser apresentado. Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
17
- | `listMode` | `list-mode` | Define o modo de apresentação da lista. | `"check" \| "regular"` | `"regular"` |
17
+ | `listMode` | `list-mode` | Define o modo de apresentação da lista. | `"check" \| "regular"` | `'regular'` |
18
18
  | `useGroups` | `use-groups` | Se true os grupos serão exibidos. | `boolean` | `false` |
19
19
 
20
20
 
@@ -82,6 +82,10 @@ Type: `Promise<void>`
82
82
 
83
83
  ## Dependencies
84
84
 
85
+ ### Used by
86
+
87
+ - [ez-multi-selection-list](../ez-multi-selection-list)
88
+
85
89
  ### Depends on
86
90
 
87
91
  - [ez-check](../ez-check)
@@ -90,6 +94,7 @@ Type: `Promise<void>`
90
94
  ```mermaid
91
95
  graph TD;
92
96
  ez-list --> ez-check
97
+ ez-multi-selection-list --> ez-list
93
98
  style ez-list fill:#f9f,stroke:#333,stroke-width:4px
94
99
  ```
95
100
 
package/components/ez-multi-selection-list/readme.md ADDED
@@ -0,0 +1,74 @@
1
+ # ez-multi-selection-list
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------ | ------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ----------- |
12
+ | `columnName` | `column-name` | Nome da coluna onde serão aplicadas as opções selecionadas. | `string` | `undefined` |
13
+ | `dataSource` | -- | Classe que implementa o método fetchData, responsável por realizar a pesquisa dos dados, com base no termo informado pelo usuário. | `IMultiSelectionListDataSource` | `undefined` |
14
+ | `options` | -- | Opções de filtros a serem exibidas na listagem. | `IMultiSelectionOption[]` | `undefined` |
15
+ | `useOptions` | `use-options` | Indica se deve ser exibida lista de opções do atributo options (true), ou se deve utilizar o datasource (false) | `boolean` | `false` |
16
+
17
+
18
+ ## Events
19
+
20
+ | Event | Description | Type |
21
+ | ----------------------- | ----------------------------------------------------------------------- | -------------------------------------- |
22
+ | `changeFilteredOptions` | Evento que informa que a lista de opções selecionadas sofreu alteração. | `CustomEvent<IMultiSelectionOption[]>` |
23
+
24
+
25
+ ## Methods
26
+
27
+ ### `clearFilteredOptions() => Promise<void>`
28
+
29
+
30
+
31
+ #### Returns
32
+
33
+ Type: `Promise<void>`
34
+
35
+
36
+
37
+
38
+ ## Dependencies
39
+
40
+ ### Used by
41
+
42
+ - [filter-column](../ez-grid/subcomponents)
43
+
44
+ ### Depends on
45
+
46
+ - [ez-check](../ez-check)
47
+ - [ez-list](../ez-list)
48
+ - [ez-icon](../ez-icon)
49
+ - [multi-selection-box-message](subcomponents)
50
+ - [ez-filter-input](../ez-filter-input)
51
+ - [ez-search](../ez-search)
52
+
53
+ ### Graph
54
+ ```mermaid
55
+ graph TD;
56
+ ez-multi-selection-list --> ez-check
57
+ ez-multi-selection-list --> ez-list
58
+ ez-multi-selection-list --> ez-icon
59
+ ez-multi-selection-list --> multi-selection-box-message
60
+ ez-multi-selection-list --> ez-filter-input
61
+ ez-multi-selection-list --> ez-search
62
+ ez-list --> ez-check
63
+ ez-filter-input --> ez-text-input
64
+ ez-filter-input --> ez-icon
65
+ ez-search --> ez-combo-box
66
+ ez-combo-box --> ez-text-input
67
+ ez-combo-box --> ez-icon
68
+ filter-column --> ez-multi-selection-list
69
+ style ez-multi-selection-list fill:#f9f,stroke:#333,stroke-width:4px
70
+ ```
71
+
72
+ ----------------------------------------------
73
+
74
+
package/components/ez-multi-selection-list/subcomponents/readme.md ADDED
@@ -0,0 +1,30 @@
1
+ # multi-selection-box-message
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------- | --------- | ----------- | -------- | ----------- |
12
+ | `message` | `message` | | `string` | `undefined` |
13
+
14
+
15
+ ## Dependencies
16
+
17
+ ### Used by
18
+
19
+ - [ez-multi-selection-list](..)
20
+
21
+ ### Graph
22
+ ```mermaid
23
+ graph TD;
24
+ ez-multi-selection-list --> multi-selection-box-message
25
+ style multi-selection-box-message fill:#f9f,stroke:#333,stroke-width:4px
26
+ ```
27
+
28
+ ----------------------------------------------
29
+
30
+
package/components/ez-popover/readme.md CHANGED
@@ -60,6 +60,19 @@ Type: `Promise<void>`
60
60
 
61
61
 
62
62
 
63
+ ## Dependencies
64
+
65
+ ### Used by
66
+
67
+ - [filter-column](../ez-grid/subcomponents)
68
+
69
+ ### Graph
70
+ ```mermaid
71
+ graph TD;
72
+ filter-column --> ez-popover
73
+ style ez-popover fill:#f9f,stroke:#333,stroke-width:4px
74
+ ```
75
+
63
76
  ----------------------------------------------
64
77
 
65
78
 
package/components/ez-search/readme.md CHANGED
@@ -76,6 +76,7 @@ Type: `Promise<void>`
76
76
  ### Used by
77
77
 
78
78
  - [ez-form-view](../ez-form-view)
79
+ - [ez-multi-selection-list](../ez-multi-selection-list)
79
80
 
80
81
  ### Depends on
81
82
 
@@ -88,6 +89,7 @@ graph TD;
88
89
  ez-combo-box --> ez-text-input
89
90
  ez-combo-box --> ez-icon
90
91
  ez-form-view --> ez-search
92
+ ez-multi-selection-list --> ez-search
91
93
  style ez-search fill:#f9f,stroke:#333,stroke-width:4px
92
94
  ```
93
95
 
package/components/ez-toast/readme.md CHANGED
@@ -28,6 +28,19 @@ Type: `Promise<void>`
28
28
 
29
29
 
30
30
 
31
+ ## Dependencies
32
+
33
+ ### Used by
34
+
35
+ - [ez-grid](../ez-grid)
36
+
37
+ ### Graph
38
+ ```mermaid
39
+ graph TD;
40
+ ez-grid --> ez-toast
41
+ style ez-toast fill:#f9f,stroke:#333,stroke-width:4px
42
+ ```
43
+
31
44
  ----------------------------------------------
32
45
 
33
46
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "4.18.1",
3
+ "version": "4.19.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [