@sankhyalabs/ezui-docs 6.6.0-dev.1 → 6.6.0-dev.2

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 (3) hide show
  1. package/components/ez-grid/readme.md +6 -0
  2. package/components/ez-grid-view/readme.md +183 -0
  3. package/package.json +1 -1
package/components/ez-grid/readme.md CHANGED
@@ -44,6 +44,7 @@
44
44
  | `ezColumnFilterChanged` | Emitido quando acontece a alteração de filtro de colunas. | `CustomEvent<Filter[]>` |
45
45
  | `ezColumnStateChange` | Emitido quando acontece a alteração de estado das colunas do grid: Ordenação, largura, etc. | `CustomEvent<EzGridColumStateEvent>` |
46
46
  | `ezDoubleClick` | Emitido com o duplo clique de uma linha | `CustomEvent<any>` |
47
+ | `ezPageChangedChanged` | Emitido a página atual é alterada. | `CustomEvent<void>` |
47
48
  | `ezSelectionChange` | Emitido quando acontece a alteração de seleção de linhas. | `CustomEvent<ISelection>` |
48
49
 
49
50
 
@@ -262,6 +263,10 @@ Type: `Promise<void>`
262
263
 
263
264
  ## Dependencies
264
265
 
266
+ ### Used by
267
+
268
+ - [ez-grid-view](../ez-grid-view)
269
+
265
270
  ### Depends on
266
271
 
267
272
  - [ez-popover](../ez-popover)
@@ -299,6 +304,7 @@ graph TD;
299
304
  ez-search --> ez-popover-plus
300
305
  ez-search --> search-list
301
306
  search-list --> ez-card-item
307
+ ez-grid-view --> ez-grid
302
308
  style ez-grid fill:#f9f,stroke:#333,stroke-width:4px
303
309
  ```
304
310
 
package/components/ez-grid-view/readme.md ADDED
@@ -0,0 +1,183 @@
1
+ # ez-grid-view
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | ------------------------------- |
12
+ | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
13
+ | `columnsConfig` | -- | Configuração de exibição da grade. | `ColumnConfig[]` | `undefined` |
14
+ | `compact` | `compact` | Define se a grade deve ser exibida em modo compacto | `boolean` | `false` |
15
+ | `enableRowTableStriped` | `enable-row-table-striped` | Ativa modo de linhas com cores alternadas. | `boolean` | `true` |
16
+ | `metadata` | -- | Metadados que definem a estrutura da grade. | `UnitMetadata` | `undefined` |
17
+ | `multipleSelection` | `multiple-selection` | Habilita a seleção de várias linhas. | `boolean` | `false` |
18
+ | `outlineMode` | `outline-mode` | Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up) | `boolean` | `false` |
19
+ | `pageSize` | `page-size` | Quantidade de registros por página. | `number` | `150` |
20
+ | `paginationCounterMode` | `pagination-counter-mode` | Define a forma como a paginação irá se comportar. | `"auto" \| "hidden" \| "show"` | `'auto'` |
21
+ | `recordDateFormat` | `record-date-format` | Formato dos campos data dos registros. | `RECORD_DATE_FORMAT.DD_MM_YYYY \| RECORD_DATE_FORMAT.ISO` | `RECORD_DATE_FORMAT.DD_MM_YYYY` |
22
+ | `records` | -- | Registros a serem exibidos na grade. | `Record[]` | `undefined` |
23
+ | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de chechbox deve ser suprimida | `boolean` | `false` |
24
+ | `suppressFilterColumn` | `suppress-filter-column` | Informa se a grade deve suprimir o filtro de coluna. | `boolean` | `false` |
25
+ | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir o scroll horizontal. | `boolean` | `false` |
26
+ | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F | `boolean` | `true` |
27
+
28
+
29
+ ## Methods
30
+
31
+ ### `addColumnMenuItem(label: string, name: string, action: Function, icon: HTMLElement | string) => Promise<void>`
32
+
33
+ Adiciona item de menu nas colunas.
34
+
35
+ #### Returns
36
+
37
+ Type: `Promise<void>`
38
+
39
+ ---
40
+
41
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
42
+
43
+ Registra um formatador de valores para uma coluna da grid.
44
+
45
+ #### Returns
46
+
47
+ Type: `Promise<void>`
48
+
49
+ ---
50
+
51
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
52
+
53
+ Registra um render customizado para colunas da grid.
54
+
55
+ #### Returns
56
+
57
+ Type: `Promise<void>`
58
+
59
+ ---
60
+
61
+ ### `filterColumns(search: string) => Promise<Array<EzGridColumn>>`
62
+
63
+ Usa um argumento para filtrar as colunas por label
64
+
65
+ #### Returns
66
+
67
+ Type: `Promise<EzGridColumn[]>`
68
+
69
+ ---
70
+
71
+ ### `getDataUnit() => Promise<DataUnit>`
72
+
73
+ Obtém o DataUnit da grade.
74
+
75
+ #### Returns
76
+
77
+ Type: `Promise<DataUnit>`
78
+
79
+ ---
80
+
81
+ ### `getSelection() => Promise<Array<any>>`
82
+
83
+ Obtém as linhas selecionadas.
84
+
85
+ #### Returns
86
+
87
+ Type: `Promise<any[]>`
88
+
89
+ ---
90
+
91
+ ### `locateColumn(columnName: string) => Promise<void>`
92
+
93
+ Localiza determinada coluna tornando-a visível.
94
+
95
+ #### Returns
96
+
97
+ Type: `Promise<void>`
98
+
99
+ ---
100
+
101
+ ### `quickFilter(term: string) => Promise<void>`
102
+
103
+ Aplica um filtro rápido.
104
+
105
+ #### Returns
106
+
107
+ Type: `Promise<void>`
108
+
109
+ ---
110
+
111
+ ### `refresh() => Promise<void>`
112
+
113
+ Recarrega os registros da grade.
114
+
115
+ #### Returns
116
+
117
+ Type: `Promise<void>`
118
+
119
+ ---
120
+
121
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
122
+
123
+ Remove o formatador de valores de uma coluna da grid.
124
+
125
+ #### Returns
126
+
127
+ Type: `Promise<void>`
128
+
129
+ ---
130
+
131
+ ### `setFocus() => Promise<void>`
132
+
133
+ Atribui o foco para a grade.
134
+
135
+ #### Returns
136
+
137
+ Type: `Promise<void>`
138
+
139
+
140
+
141
+
142
+ ## Dependencies
143
+
144
+ ### Depends on
145
+
146
+ - [ez-grid](../ez-grid)
147
+
148
+ ### Graph
149
+ ```mermaid
150
+ graph TD;
151
+ ez-grid-view --> ez-grid
152
+ ez-grid --> ez-popover
153
+ ez-grid --> ez-icon
154
+ ez-grid --> ez-button
155
+ ez-grid --> filter-column
156
+ ez-grid --> ez-search
157
+ ez-button --> ez-icon
158
+ filter-column --> ez-popover-plus
159
+ filter-column --> ez-button
160
+ filter-column --> ez-multi-selection-list
161
+ ez-popover-plus --> ez-popover-core
162
+ ez-multi-selection-list --> ez-check
163
+ ez-multi-selection-list --> ez-list
164
+ ez-multi-selection-list --> ez-icon
165
+ ez-multi-selection-list --> multi-selection-box-message
166
+ ez-multi-selection-list --> ez-filter-input
167
+ ez-multi-selection-list --> ez-search
168
+ ez-list --> ez-check
169
+ ez-filter-input --> ez-text-input
170
+ ez-filter-input --> ez-icon
171
+ ez-text-input --> ez-tooltip
172
+ ez-text-input --> ez-icon
173
+ ez-search --> ez-text-input
174
+ ez-search --> ez-icon
175
+ ez-search --> ez-popover-plus
176
+ ez-search --> search-list
177
+ search-list --> ez-card-item
178
+ style ez-grid-view fill:#f9f,stroke:#333,stroke-width:4px
179
+ ```
180
+
181
+ ----------------------------------------------
182
+
183
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "6.6.0-dev.1",
3
+ "version": "6.6.0-dev.2",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [