@zhangt58/svelte-vtable 0.3.8 → 0.4.1

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.
@@ -2,6 +2,109 @@
2
2
  * Utility functions for working with DataTableFilters
3
3
  */
4
4
 
5
+ export const DEFAULT_RELATIVE_RANGE_PRESETS = [
6
+ { label: '1h', value: 1, unit: 'hour' },
7
+ { label: '6h', value: 6, unit: 'hour' },
8
+ { label: '12h', value: 12, unit: 'hour' },
9
+ { label: '1d', value: 1, unit: 'day' },
10
+ { label: '7d', value: 7, unit: 'day' },
11
+ { label: '30d', value: 30, unit: 'day' },
12
+ { label: '1y', value: 1, unit: 'year' },
13
+ ];
14
+
15
+ /**
16
+ * Resolve a filter config's type from either ColumnDef.filterType or filter config type.
17
+ * @param {object|string|undefined|null} column
18
+ * @returns {string|undefined}
19
+ */
20
+ export function getFilterType(column) {
21
+ if (typeof column === 'string') return column;
22
+ return column?.type ?? column?.filterType;
23
+ }
24
+
25
+ /**
26
+ * Check whether a column filter is date/datetime range based.
27
+ * @param {object|string|undefined|null} column
28
+ * @returns {boolean}
29
+ */
30
+ export function isDateRangeColumn(column) {
31
+ const type = getFilterType(column);
32
+ return type === 'daterange' || type === 'datetimerange';
33
+ }
34
+
35
+ /**
36
+ * Return active filters excluding one column key.
37
+ * This is used by faceted option builders so a column's own active filter
38
+ * cannot remove the choices needed to change or clear that filter.
39
+ * @param {Object|null|undefined} activeFilters
40
+ * @param {string} excludedKey
41
+ * @returns {Object}
42
+ */
43
+ export function filtersWithoutKey(activeFilters, excludedKey) {
44
+ if (!activeFilters || typeof activeFilters !== 'object') return {};
45
+ const filters = {};
46
+ for (const [key, value] of Object.entries(activeFilters)) {
47
+ if (key !== excludedKey && hasActiveFilterValue(value)) filters[key] = value;
48
+ }
49
+ return filters;
50
+ }
51
+
52
+ /**
53
+ * Resolve column filter configs from either explicit configs or a row source + columns.
54
+ * Explicit `columnFilters` always wins; otherwise `filterItems` is treated as the
55
+ * base source for derived option lists. In faceted mode, each column is built from
56
+ * rows filtered by the other active filters, but not by that column's own filter.
57
+ * @param {object} opts
58
+ * @param {Array|null|undefined} opts.columnFilters - Explicit filter configs.
59
+ * @param {Array} [opts.columns] - Column definitions used for derived filter configs.
60
+ * @param {Array|null|undefined} [opts.filterItems] - Base row source used to derive filter options.
61
+ * @param {Object|null|undefined} [opts.activeFilters] - Current active filter state.
62
+ * @param {boolean} [opts.enabled] - Whether derived filters should be built.
63
+ * @param {boolean} [opts.faceted] - Whether to derive each column from rows filtered by peer columns.
64
+ * @returns {Array}
65
+ */
66
+ export function resolveColumnFilters({
67
+ columnFilters,
68
+ columns = [],
69
+ filterItems = [],
70
+ activeFilters = null,
71
+ enabled = true,
72
+ faceted = true,
73
+ }) {
74
+ if (Array.isArray(columnFilters)) return columnFilters;
75
+ if (!enabled || !Array.isArray(columns) || columns.length === 0) return [];
76
+ const sourceItems = Array.isArray(filterItems) ? filterItems : [];
77
+
78
+ if (!faceted || !hasActiveFilters(activeFilters)) {
79
+ return buildColumnFilters(sourceItems, columns);
80
+ }
81
+
82
+ return columns
83
+ .filter((col) => col.filterType !== 'none')
84
+ .map((col) => {
85
+ const peerFilters = filtersWithoutKey(activeFilters, col.key);
86
+ const filteredItems = hasActiveFilters(peerFilters)
87
+ ? applyFilters(sourceItems, peerFilters)
88
+ : sourceItems;
89
+ return buildColumnFilters(filteredItems, [col])[0];
90
+ })
91
+ .filter(Boolean);
92
+ }
93
+
94
+ /**
95
+ * Check whether a single filter value is active.
96
+ * @param {unknown} value
97
+ * @returns {boolean}
98
+ */
99
+ export function hasActiveFilterValue(value) {
100
+ if (Array.isArray(value)) return value.length > 0;
101
+ if (value && typeof value === 'object') {
102
+ const range = /** @type {{from?: unknown, to?: unknown}} */ (value);
103
+ return !!(range.from || range.to);
104
+ }
105
+ return false;
106
+ }
107
+
5
108
  /**
6
109
  * Extract unique values and their counts from an array of objects for a given key
7
110
  * @param {Array} data - Array of data objects
@@ -41,23 +144,25 @@ export function getUniqueValuesWithCounts(data, key) {
41
144
  * @returns {Array} Column filters configuration for DataTableFilters
42
145
  */
43
146
  export function buildColumnFilters(data, columns) {
44
- const isDateRangeType = (ft) => ft === 'daterange' || ft === 'datetimerange';
45
147
  return columns
46
148
  .filter((col) => col.filterType !== 'none')
47
149
  .map((col) => {
48
- if (isDateRangeType(col.filterType)) {
150
+ if (isDateRangeColumn(col.filterType)) {
49
151
  // Scan data to find the min/max timestamps for this column so the UI can
50
152
  // offer a dual-range slider and Earliest/Latest shortcut buttons.
51
153
  let minMs = Infinity;
52
154
  let maxMs = -Infinity;
155
+ const dateValueSet = new Set();
53
156
  for (const item of data) {
54
157
  const v = item[col.key];
55
158
  if (v === null || v === undefined || v === '') continue;
56
159
  const str = String(v);
57
160
  const d = /^\d{4}-\d{2}-\d{2}$/.test(str) ? new Date(str + 'T00:00:00') : new Date(str);
58
161
  if (!isNaN(d.getTime())) {
59
- if (d.getTime() < minMs) minMs = d.getTime();
60
- if (d.getTime() > maxMs) maxMs = d.getTime();
162
+ const ms = d.getTime();
163
+ dateValueSet.add(ms);
164
+ if (ms < minMs) minMs = ms;
165
+ if (ms > maxMs) maxMs = ms;
61
166
  }
62
167
  }
63
168
 
@@ -83,6 +188,7 @@ export function buildColumnFilters(data, columns) {
83
188
  counts: {},
84
189
  minValue: hasRange ? fmt(minMs) : null,
85
190
  maxValue: hasRange ? fmt(maxMs) : null,
191
+ dateValues: hasRange ? [...dateValueSet].sort((a, b) => a - b) : [],
86
192
  };
87
193
  }
88
194
  const { uniqueValues, counts } = getUniqueValuesWithCounts(data, col.key);
@@ -162,9 +268,7 @@ export function applyFilters(data, activeFilters) {
162
268
 
163
269
  if (Array.isArray(itemValue)) {
164
270
  // array value - check if any element matches the filter values
165
- const hasMatch = itemValue.some((v) =>
166
- filterValue.includes(String(v ?? ''))
167
- );
271
+ const hasMatch = itemValue.some((v) => filterValue.includes(String(v ?? '')));
168
272
  if (!hasMatch) return false;
169
273
  } else {
170
274
  // scalar value - treat null/undefined as '(empty)'
@@ -188,11 +292,17 @@ export function applyFilters(data, activeFilters) {
188
292
  * @returns {boolean} True if any filters are active
189
293
  */
190
294
  export function hasActiveFilters(activeFilters) {
191
- return Object.values(activeFilters).some((val) => {
192
- if (Array.isArray(val)) return val.length > 0;
193
- if (val && typeof val === 'object') return !!(val.from || val.to);
194
- return false;
195
- });
295
+ return Object.values(activeFilters || {}).some(hasActiveFilterValue);
296
+ }
297
+
298
+ /**
299
+ * Count one filter value. Value-list filters count each selected value; ranges count as 1.
300
+ * @param {unknown} value
301
+ * @returns {number}
302
+ */
303
+ export function countActiveFilterValue(value) {
304
+ if (Array.isArray(value)) return value.length;
305
+ return hasActiveFilterValue(value) ? 1 : 0;
196
306
  }
197
307
 
198
308
  /**
@@ -202,10 +312,8 @@ export function hasActiveFilters(activeFilters) {
202
312
  * @returns {number} Total count of active filter values/ranges
203
313
  */
204
314
  export function countActiveFilters(activeFilters) {
205
- return Object.values(activeFilters).reduce((sum, val) => {
206
- if (Array.isArray(val)) return sum + (val?.length || 0);
207
- if (val && typeof val === 'object' && (val.from || val.to)) return sum + 1;
208
- return sum;
315
+ return Object.values(activeFilters || {}).reduce((sum, val) => {
316
+ return sum + countActiveFilterValue(val);
209
317
  }, 0);
210
318
  }
211
319
 
@@ -217,8 +325,7 @@ export function countActiveFilters(activeFilters) {
217
325
  export function clearAllFilters(columnFilters) {
218
326
  const cleared = {};
219
327
  columnFilters.forEach((col) => {
220
- const isDateRange = col.type === 'daterange' || col.type === 'datetimerange';
221
- cleared[col.key] = isDateRange ? {} : [];
328
+ cleared[col.key] = isDateRangeColumn(col) ? {} : [];
222
329
  });
223
330
  return cleared;
224
331
  }
@@ -256,9 +363,7 @@ export function searchParamsToFilters(searchParams, columnFilters) {
256
363
 
257
364
  const validKeys = new Set(columnFilters.map((c) => c.key));
258
365
  const dateRangeKeys = new Set(
259
- columnFilters
260
- .filter((c) => c.type === 'daterange' || c.type === 'datetimerange')
261
- .map((c) => c.key),
366
+ columnFilters.filter((c) => isDateRangeColumn(c)).map((c) => c.key),
262
367
  );
263
368
  const filters = {};
264
369
 
package/dist/index.d.ts CHANGED
@@ -4,6 +4,7 @@ export { default as DataTable } from "./components/DataTable.svelte";
4
4
  export { default as FilterColumn } from "./components/filters/FilterColumn.svelte";
5
5
  export { default as FilterValueList } from "./components/filters/FilterValueList.svelte";
6
6
  export { default as FilterDateRange } from "./components/filters/FilterDateRange.svelte";
7
+ export { default as ColumnHeaderFilter } from "./components/filters/ColumnHeaderFilter.svelte";
7
8
  export { useFilterState } from "./components/filters/useFilterState.svelte.js";
8
9
  /**
9
10
  * Unified column definition for DataTable.
@@ -31,12 +32,12 @@ export type ColumnDef<T extends Record<string, unknown> = Record<string, unknown
31
32
  sortable?: boolean;
32
33
  /**
33
34
  * Filter UI to render for this column:
34
- * - `'value'` — checkbox list of unique values (default)
35
+ * - `'value'`/`'list'` — checkbox list of unique values (default)
35
36
  * - `'daterange'` — date-only range picker
36
37
  * - `'datetimerange'` — datetime range picker
37
38
  * - `'none'` — no filter UI for this column
38
39
  */
39
- filterType?: "value" | "daterange" | "datetimerange" | "none";
40
+ filterType?: "value" | "list" | "daterange" | "datetimerange" | "none";
40
41
  /**
41
42
  * Custom Svelte 5 snippet rendered inside the `<th>`. Receives
42
43
  * `{ key, label, sortKey, sortDir }`.
@@ -57,4 +58,4 @@ export type ColumnDef<T extends Record<string, unknown> = Record<string, unknown
57
58
  index: number;
58
59
  }]>;
59
60
  };
60
- export { getUniqueValuesWithCounts, buildColumnFilters, applyFilters, matchesDateRange, hasActiveFilters, countActiveFilters, clearAllFilters, filtersToSearchParams, searchParamsToFilters } from "./filterUtils.js";
61
+ export { DEFAULT_RELATIVE_RANGE_PRESETS, getFilterType, filtersWithoutKey, resolveColumnFilters, getUniqueValuesWithCounts, buildColumnFilters, applyFilters, matchesDateRange, isDateRangeColumn, hasActiveFilterValue, countActiveFilterValue, hasActiveFilters, countActiveFilters, clearAllFilters, filtersToSearchParams, searchParamsToFilters } from "./filterUtils.js";
package/dist/index.js CHANGED
@@ -6,14 +6,22 @@ export { default as DataTable } from './components/DataTable.svelte';
6
6
  export { default as FilterColumn } from './components/filters/FilterColumn.svelte';
7
7
  export { default as FilterValueList } from './components/filters/FilterValueList.svelte';
8
8
  export { default as FilterDateRange } from './components/filters/FilterDateRange.svelte';
9
+ export { default as ColumnHeaderFilter } from './components/filters/ColumnHeaderFilter.svelte';
9
10
  export { useFilterState } from './components/filters/useFilterState.svelte.js';
10
11
 
11
12
  // Export filter utility functions
12
13
  export {
14
+ DEFAULT_RELATIVE_RANGE_PRESETS,
15
+ getFilterType,
16
+ filtersWithoutKey,
17
+ resolveColumnFilters,
13
18
  getUniqueValuesWithCounts,
14
19
  buildColumnFilters,
15
20
  applyFilters,
16
21
  matchesDateRange,
22
+ isDateRangeColumn,
23
+ hasActiveFilterValue,
24
+ countActiveFilterValue,
17
25
  hasActiveFilters,
18
26
  countActiveFilters,
19
27
  clearAllFilters,
@@ -34,9 +42,9 @@ export {
34
42
  * CSS width value such as `'120px'`. Defaults to `1` (equal stretch).
35
43
  * @property {boolean} [sortable] - Whether clicking the column header sorts the
36
44
  * table. Defaults to `true`.
37
- * @property {'value'|'daterange'|'datetimerange'|'none'} [filterType]
45
+ * @property {'value'|'list'|'daterange'|'datetimerange'|'none'} [filterType]
38
46
  * Filter UI to render for this column:
39
- * - `'value'` — checkbox list of unique values (default)
47
+ * - `'value'`/`'list'` — checkbox list of unique values (default)
40
48
  * - `'daterange'` — date-only range picker
41
49
  * - `'datetimerange'` — datetime range picker
42
50
  * - `'none'` — no filter UI for this column
package/dist/styles.css CHANGED
@@ -139,6 +139,34 @@
139
139
  gap: 0.25rem;
140
140
  }
141
141
 
142
+ :global(.datatable-table thead th) {
143
+ position: relative;
144
+ }
145
+
146
+ :global(.datatable-table thead th .vtable-header-content) {
147
+ display: flex;
148
+ align-items: center;
149
+ justify-content: space-between;
150
+ gap: 0.25rem;
151
+ min-width: 0;
152
+ width: 100%;
153
+ }
154
+
155
+ :global(.datatable-table thead th .vtable-header-sort-button) {
156
+ appearance: none;
157
+ border: 0;
158
+ background: transparent;
159
+ color: inherit;
160
+ font: inherit;
161
+ letter-spacing: inherit;
162
+ text-transform: inherit;
163
+ padding: 0;
164
+ display: inline-flex;
165
+ align-items: center;
166
+ gap: 0.25rem;
167
+ text-align: left;
168
+ }
169
+
142
170
  /* Allow certain long cells to wrap fully if explicitly requested */
143
171
  :global(.datatable-table td.wrap) {
144
172
  white-space: normal;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zhangt58/svelte-vtable",
3
- "version": "0.3.8",
3
+ "version": "0.4.1",
4
4
  "description": "A Svelte 5 library for virtualized data tables with sorting, selection, and pagination controls.",
5
5
  "type": "module",
6
6
  "sideEffects": [