eru-grid 0.0.57 → 0.0.59
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/fesm2022/eru-grid.mjs +41 -2
- package/fesm2022/eru-grid.mjs.map +1 -1
- package/package.json +1 -1
- package/types/eru-grid.d.ts +38 -1
package/package.json
CHANGED
package/types/eru-grid.d.ts
CHANGED
|
@@ -73,6 +73,7 @@ interface GridFeatures {
|
|
|
73
73
|
groupBar?: boolean;
|
|
74
74
|
excel_download?: boolean;
|
|
75
75
|
excel_download_icon?: boolean;
|
|
76
|
+
refresh_icon?: boolean;
|
|
76
77
|
response_key?: string;
|
|
77
78
|
header_fill_color?: string[];
|
|
78
79
|
header_fill_type?: string;
|
|
@@ -98,6 +99,7 @@ interface GridFeatures {
|
|
|
98
99
|
headerRowHeight?: number;
|
|
99
100
|
dataRowHeight?: number;
|
|
100
101
|
cursorOnHover?: string;
|
|
102
|
+
boardCardBg?: string;
|
|
101
103
|
boardCardHoverBg?: string;
|
|
102
104
|
boardCardSelectedBg?: string;
|
|
103
105
|
boardCardSelectedOutline?: string;
|
|
@@ -180,6 +182,18 @@ interface ExcelDownloadRequest extends ExcelDownloadPayload {
|
|
|
180
182
|
id: number;
|
|
181
183
|
timestamp: number;
|
|
182
184
|
}
|
|
185
|
+
/**
|
|
186
|
+
* A request to reload the grid's data, queued for the consumer.
|
|
187
|
+
*
|
|
188
|
+
* eru-grid never fetches its own rows, so the refresh icon cannot reload
|
|
189
|
+
* anything by itself — it follows ExcelDownloadRequest's enqueue/drain shape:
|
|
190
|
+
* the consumer watches `EruGridStore.refreshRequest()`, re-runs whatever
|
|
191
|
+
* populates the grid, and calls removeRefreshRequest(id).
|
|
192
|
+
*/
|
|
193
|
+
interface RefreshRequest {
|
|
194
|
+
id: number;
|
|
195
|
+
timestamp: number;
|
|
196
|
+
}
|
|
183
197
|
/**
|
|
184
198
|
* A message from a cell's server-side validation check, queued for the consumer
|
|
185
199
|
* to display. eru-grid does not render a snackbar — it delegates chrome to the
|
|
@@ -1569,6 +1583,8 @@ declare class EruGridStore {
|
|
|
1569
1583
|
readonly dynamicDataRequest: _angular_core.Signal<DynamicDataRequest[] | null>;
|
|
1570
1584
|
readonly dynamicData: _angular_core.Signal<Map<string, any> | null>;
|
|
1571
1585
|
readonly excelDownloadRequest: _angular_core.Signal<ExcelDownloadRequest[]>;
|
|
1586
|
+
private readonly _refreshRequest;
|
|
1587
|
+
readonly refreshRequest: _angular_core.Signal<RefreshRequest[]>;
|
|
1572
1588
|
/**
|
|
1573
1589
|
* Every row currently in memory that can be selected, deduped by selection key.
|
|
1574
1590
|
*
|
|
@@ -1842,6 +1858,12 @@ declare class EruGridStore {
|
|
|
1842
1858
|
* Enqueue an excel-download request (called by the grid component when the
|
|
1843
1859
|
* excel-download icon is clicked).
|
|
1844
1860
|
*/
|
|
1861
|
+
addRefreshRequest(request: RefreshRequest): void;
|
|
1862
|
+
/**
|
|
1863
|
+
* Remove a refresh request from the queue (called by the consumer once it has
|
|
1864
|
+
* reloaded the grid's data for that request).
|
|
1865
|
+
*/
|
|
1866
|
+
removeRefreshRequest(id: number): void;
|
|
1845
1867
|
addExcelDownloadRequest(request: ExcelDownloadRequest): void;
|
|
1846
1868
|
/**
|
|
1847
1869
|
* Remove an excel-download request from the queue (called by the consumer
|
|
@@ -2183,6 +2205,18 @@ declare class EruGridComponent implements OnInit, AfterViewInit, OnDestroy {
|
|
|
2183
2205
|
* request via gridStore.removeExcelDownloadRequest(id) once done.
|
|
2184
2206
|
*/
|
|
2185
2207
|
onExcelDownloadClick(event: Event): void;
|
|
2208
|
+
/**
|
|
2209
|
+
* Fires when the user clicks the refresh icon (shown when
|
|
2210
|
+
* `config.refresh_icon` is enabled). Enqueues a RefreshRequest the same way
|
|
2211
|
+
* the excel icon enqueues its export — the grid holds no data source of its
|
|
2212
|
+
* own, so reloading is the consumer's job.
|
|
2213
|
+
*/
|
|
2214
|
+
onRefreshClick(event: Event): void;
|
|
2215
|
+
/**
|
|
2216
|
+
* Enqueue a refresh request without a click, so a host can drive the same
|
|
2217
|
+
* reload from its own button when the built-in icon is off.
|
|
2218
|
+
*/
|
|
2219
|
+
requestRefresh(): void;
|
|
2186
2220
|
/**
|
|
2187
2221
|
* Enqueue an excel-download request without a click. This is the same path
|
|
2188
2222
|
* the icon takes, exposed so a host can trigger the export from its own
|
|
@@ -2260,6 +2294,9 @@ declare class EruGridComponent implements OnInit, AfterViewInit, OnDestroy {
|
|
|
2260
2294
|
showBoardColumnHeader: _angular_core.Signal<boolean>;
|
|
2261
2295
|
showGroupBar: _angular_core.Signal<boolean>;
|
|
2262
2296
|
showExcelDownload: _angular_core.Signal<boolean>;
|
|
2297
|
+
showRefreshIcon: _angular_core.Signal<boolean>;
|
|
2298
|
+
/** Whether the bar above the grid has anything to hold. */
|
|
2299
|
+
showGridActionBar: _angular_core.Signal<boolean>;
|
|
2263
2300
|
wrapHeaders: _angular_core.Signal<boolean>;
|
|
2264
2301
|
headerRowHeight: _angular_core.Signal<number>;
|
|
2265
2302
|
dataRowHeight: _angular_core.Signal<number>;
|
|
@@ -4140,4 +4177,4 @@ declare class ThemeToggleComponent {
|
|
|
4140
4177
|
}
|
|
4141
4178
|
|
|
4142
4179
|
export { ACTION_COLUMN_MIN_WIDTH, AttachmentComponent, CELL_RULE_OPERATORS, CheckboxComponent, ChipListComponent, ColumnConstraintsService, CompositeComponent, CurrencyComponent, CustomVirtualScrollStrategy, DATA_TYPES, DATETIME_FORMATS, DATE_FORMATS, DateComponent, DatetimeComponent, DurationComponent, EXPLICITLY_OVERRIDDEN_FIELD_KEYS, EmailComponent, EruGridComponent, EruGridService, EruGridStore, GRID_COLOR_TOKENS, INHERITED_FIELD_KEYS, LocationComponent, MATERIAL_MODULES, MATERIAL_PROVIDERS, MONTH_SHORT_NAMES, NumberComponent, NumericInputDirective, PRESENTATION_DATATYPES, PRESET_CONFIG_DEFAULTS, PRESET_MANAGED_FIELDS, PeopleComponent, PhoneComponent, PriorityComponent, ProgressComponent, RatingComponent, SEEDED_FIELD_KEYS, SELF_COLOURED_DATATYPES, SelectComponent, StatusComponent, TagComponent, TextareaComponent, TextboxComponent, ThemeService, ThemeToggleComponent, WebsiteComponent, abbreviateNumber, abbreviationScaleFor, cellRuleBarPercent, cellRuleMatches, cellRuleToCss, cellStatAlias, cellTextStyleToCss, collectColumnStatRequests, columnCellRules, composeColorValue, effectiveValueDatatype, evaluateRowCondition, formatCellValue, formatDateTimeWithPattern, formatDateWithPattern, formatNumberValue, hasOwnCellRules, matchCellRule, matchColorRange, normalizeCellRender, normalizeDatatype, normalizeDateFormat, normalizeDateTimeFormat, parseCellDate, parseCellDateTime, parseColorValue, parseDateWithPattern, readRowValue, resolveColumnRules, resolveRowValue, resolveStatValue, rowSelectionKey, statusPillColors, tagPillColors, toDateOnlyString, toDateTimeString, toStatusOptionsField };
|
|
4143
|
-
export type { ActionClick, AggregationFunction, AttachmentConfig, BoardCardContext, CellFormatRule, CellRender, CellRuleOperator, CellStatRef, CellStatVerb, CellTemplateContext, CellTextStyle, CellValueChange, ChipListItem, ColorRangeBand, ColumnReorder, ColumnResize, ColumnStatRequest, ColumnWidthConstraints, CompositePart, CurrencyValidationResult, DataTypes, Drilldown, DurationValue, DynamicDataRequest, EmailValidationResult, ExcelDownloadPayload, ExcelDownloadRequest, ExcelPivotConfig, Field, GridAction, GridConfiguration, GridFeatures, GridMode, GridPreset, GridStyles, GridTokens, GroupItem$1 as GroupItem, LocationConfig, LocationValidationResult, NumberValidationResult, ParsedColorValue, PeopleOption, PersonCardContext, PivotColumnGroupState, PivotColumnHeader, PivotColumnKind, PivotConfiguration, PivotHeaderStructure, PivotMetadata, PivotResult, PivotRow, PivotRowKind, RatingConfig, Row, RowDataRequest, RowDataResponse, RowGrandTotal, RowGroup, ServerValidationNotice, StatusPillColors, TagPillColors, TextareaValidationResult, TextboxValidationResult, Theme, WebsiteValidationResult };
|
|
4180
|
+
export type { ActionClick, AggregationFunction, AttachmentConfig, BoardCardContext, CellFormatRule, CellRender, CellRuleOperator, CellStatRef, CellStatVerb, CellTemplateContext, CellTextStyle, CellValueChange, ChipListItem, ColorRangeBand, ColumnReorder, ColumnResize, ColumnStatRequest, ColumnWidthConstraints, CompositePart, CurrencyValidationResult, DataTypes, Drilldown, DurationValue, DynamicDataRequest, EmailValidationResult, ExcelDownloadPayload, ExcelDownloadRequest, ExcelPivotConfig, Field, GridAction, GridConfiguration, GridFeatures, GridMode, GridPreset, GridStyles, GridTokens, GroupItem$1 as GroupItem, LocationConfig, LocationValidationResult, NumberValidationResult, ParsedColorValue, PeopleOption, PersonCardContext, PivotColumnGroupState, PivotColumnHeader, PivotColumnKind, PivotConfiguration, PivotHeaderStructure, PivotMetadata, PivotResult, PivotRow, PivotRowKind, RatingConfig, RefreshRequest, Row, RowDataRequest, RowDataResponse, RowGrandTotal, RowGroup, ServerValidationNotice, StatusPillColors, TagPillColors, TextareaValidationResult, TextboxValidationResult, Theme, WebsiteValidationResult };
|