@cocoar/vue-data-grid 1.5.4 → 1.6.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.
- package/dist/builders/coar-grid-builder.d.ts +58 -0
- package/dist/builders/coar-grid-builder.d.ts.map +1 -1
- package/dist/index.js +7443 -7368
- package/package.json +3 -3
|
@@ -133,6 +133,23 @@ export declare class CoarGridBuilder<TData = unknown> {
|
|
|
133
133
|
treeData(config: TreeDataConfig<TData>): this;
|
|
134
134
|
/** Set which parent rows are expanded (reactive ref of row IDs) */
|
|
135
135
|
openRows(openRows: Ref<string[]>): this;
|
|
136
|
+
/**
|
|
137
|
+
* Force all tree parents to be expanded while the ref is `true`.
|
|
138
|
+
*
|
|
139
|
+
* When switching to `true`, the current open-state is saved. All parents
|
|
140
|
+
* are shown expanded and chevron toggle is disabled.
|
|
141
|
+
* When switching back to `false`, the saved open-state is restored.
|
|
142
|
+
*
|
|
143
|
+
* @example
|
|
144
|
+
* ```ts
|
|
145
|
+
* const forceExpanded = computed(() => showSubTodos.value && !!search.value)
|
|
146
|
+
* builder
|
|
147
|
+
* .treeData({ children: row => row.children, rowId: row => row.id })
|
|
148
|
+
* .openRows(openRows)
|
|
149
|
+
* .forceExpanded(forceExpanded)
|
|
150
|
+
* ```
|
|
151
|
+
*/
|
|
152
|
+
forceExpanded(source: Ref<boolean>): this;
|
|
136
153
|
/** Enable full-row editing mode */
|
|
137
154
|
fullRowEdit(value?: boolean): this;
|
|
138
155
|
/** Stop cell editing when cells lose focus */
|
|
@@ -257,6 +274,47 @@ export declare class CoarGridBuilder<TData = unknown> {
|
|
|
257
274
|
* ```
|
|
258
275
|
*/
|
|
259
276
|
quickFilterFn(fn: (searchValue: string, data: TData) => boolean): this;
|
|
277
|
+
/**
|
|
278
|
+
* Set a custom filter function that operates on the entire data array.
|
|
279
|
+
* When set, AG Grid's per-row quick filter is bypassed — the data is filtered
|
|
280
|
+
* by this function before being passed to AG Grid.
|
|
281
|
+
*
|
|
282
|
+
* This is useful for tree data where you need sibling-aware filtering
|
|
283
|
+
* (e.g. keeping all children of a parent when any child matches).
|
|
284
|
+
*
|
|
285
|
+
* @param fn - Receives the full data array and the current search text.
|
|
286
|
+
* Return the filtered array, or `null` to fall back to the
|
|
287
|
+
* default quick filter for that evaluation.
|
|
288
|
+
*
|
|
289
|
+
* @example
|
|
290
|
+
* ```ts
|
|
291
|
+
* builder
|
|
292
|
+
* .treeData({ children: row => row.children, rowId: row => row.id })
|
|
293
|
+
* .customFilter((items, search) => {
|
|
294
|
+
* if (!showGroupFilter.value) return null; // fall back to quickFilter
|
|
295
|
+
* if (!search.trim()) return items;
|
|
296
|
+
* const q = search.toLowerCase();
|
|
297
|
+
* return items.filter(parent =>
|
|
298
|
+
* parent.name.toLowerCase().includes(q) ||
|
|
299
|
+
* parent.children.some(c => c.name.toLowerCase().includes(q))
|
|
300
|
+
* );
|
|
301
|
+
* })
|
|
302
|
+
* ```
|
|
303
|
+
*/
|
|
304
|
+
customFilter(fn: (data: TData[], searchText: string) => TData[] | null): this;
|
|
305
|
+
/**
|
|
306
|
+
* Re-run the data pipeline when the given watch sources change.
|
|
307
|
+
* Use this when `customFilter` or `quickFilterFn` depends on external reactive state.
|
|
308
|
+
*
|
|
309
|
+
* @example
|
|
310
|
+
* ```ts
|
|
311
|
+
* const showSubTodos = ref(false);
|
|
312
|
+
* builder
|
|
313
|
+
* .customFilter((todos, search) => { ... })
|
|
314
|
+
* .updateOn(showSubTodos)
|
|
315
|
+
* ```
|
|
316
|
+
*/
|
|
317
|
+
updateOn(...sources: WatchSource[]): this;
|
|
260
318
|
/**
|
|
261
319
|
* Enable search text highlighting using the CSS Custom Highlight API.
|
|
262
320
|
* Matching text in grid cells is highlighted without modifying the DOM.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"coar-grid-builder.d.ts","sourceRoot":"","sources":["../../src/builders/coar-grid-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,EAAE,KAAK,WAAW,EAAqB,MAAM,KAAK,CAAC;AACpE,OAAO,KAAK,EACV,MAAM,EACN,OAAO,EACP,WAAW,EACX,cAAc,EACd,eAAe,EACf,qBAAqB,EACrB,gBAAgB,EAChB,sBAAsB,EACtB,YAAY,EACZ,cAAc,EACd,QAAQ,EACR,6BAA6B,EAC7B,oBAAoB,EACpB,oBAAoB,EACpB,WAAW,EACX,kBAAkB,EAClB,eAAe,EAEhB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,qBAAqB,EAAyB,MAAM,4BAA4B,CAAC;AAE1F,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAGnE,KAAK,iBAAiB,CAAC,KAAK,IAAI;IAC9B,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;CACxB,CAAC;AAEF,uEAAuE;AACvE,MAAM,MAAM,gBAAgB,CAAC,KAAK,IAC9B,iBAAiB,CAAC,KAAK,CAAC,GACxB,CAAC,CAAC,OAAO,EAAE,qBAAqB,CAAC,KAAK,CAAC,KAAK,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC;AAE1E,iDAAiD;AACjD,MAAM,WAAW,cAAc,CAAC,KAAK;IACnC,sEAAsE;IACtE,QAAQ,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,KAAK,EAAE,CAAC;IAClC,wEAAwE;IACxE,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,MAAM,CAAC;CAC/B;AAED,kFAAkF;AAClF,MAAM,WAAW,YAAY;IAC3B,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,WAAW,EAAE,OAAO,CAAC;IACrB,8CAA8C;IAC9C,UAAU,EAAE,OAAO,CAAC;IACpB,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,6DAA6D;AAC7D,MAAM,WAAW,eAAe,CAAC,KAAK,GAAG,OAAO;IAC9C,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAChC,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAChC,QAAQ,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,MAAM,CAAC;CAClC;AAED,qCAAqC;AACrC,MAAM,WAAW,uBAAuB,CAAC,KAAK;IAC5C,uGAAuG;IACvG,OAAO,CAAC,EAAE,CAAC,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,KAAK,OAAO,CAAC;CAC9D;AAED,gCAAgC;AAChC,MAAM,WAAW,mBAAmB;IAClC,8FAA8F;IAC9F,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,wHAAwH;IACxH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oEAAoE;IACpE,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,eAAe,CAAC,KAAK,GAAG,OAAO;;
|
|
1
|
+
{"version":3,"file":"coar-grid-builder.d.ts","sourceRoot":"","sources":["../../src/builders/coar-grid-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,EAAE,KAAK,WAAW,EAAqB,MAAM,KAAK,CAAC;AACpE,OAAO,KAAK,EACV,MAAM,EACN,OAAO,EACP,WAAW,EACX,cAAc,EACd,eAAe,EACf,qBAAqB,EACrB,gBAAgB,EAChB,sBAAsB,EACtB,YAAY,EACZ,cAAc,EACd,QAAQ,EACR,6BAA6B,EAC7B,oBAAoB,EACpB,oBAAoB,EACpB,WAAW,EACX,kBAAkB,EAClB,eAAe,EAEhB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,qBAAqB,EAAyB,MAAM,4BAA4B,CAAC;AAE1F,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAGnE,KAAK,iBAAiB,CAAC,KAAK,IAAI;IAC9B,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;CACxB,CAAC;AAEF,uEAAuE;AACvE,MAAM,MAAM,gBAAgB,CAAC,KAAK,IAC9B,iBAAiB,CAAC,KAAK,CAAC,GACxB,CAAC,CAAC,OAAO,EAAE,qBAAqB,CAAC,KAAK,CAAC,KAAK,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC;AAE1E,iDAAiD;AACjD,MAAM,WAAW,cAAc,CAAC,KAAK;IACnC,sEAAsE;IACtE,QAAQ,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,KAAK,EAAE,CAAC;IAClC,wEAAwE;IACxE,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,MAAM,CAAC;CAC/B;AAED,kFAAkF;AAClF,MAAM,WAAW,YAAY;IAC3B,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,WAAW,EAAE,OAAO,CAAC;IACrB,8CAA8C;IAC9C,UAAU,EAAE,OAAO,CAAC;IACpB,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,6DAA6D;AAC7D,MAAM,WAAW,eAAe,CAAC,KAAK,GAAG,OAAO;IAC9C,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAChC,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAChC,QAAQ,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,MAAM,CAAC;CAClC;AAED,qCAAqC;AACrC,MAAM,WAAW,uBAAuB,CAAC,KAAK;IAC5C,uGAAuG;IACvG,OAAO,CAAC,EAAE,CAAC,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,KAAK,OAAO,CAAC;CAC9D;AAED,gCAAgC;AAChC,MAAM,WAAW,mBAAmB;IAClC,8FAA8F;IAC9F,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,wHAAwH;IACxH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oEAAoE;IACpE,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,eAAe,CAAC,KAAK,GAAG,OAAO;;IA2C1C,yDAAyD;IACzD,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAmB;IAE7D,OAAO;IAIP,gCAAgC;IAChC,MAAM,CAAC,MAAM,CAAC,KAAK,KAAK,eAAe,CAAC,KAAK,CAAC;IAI9C,uDAAuD;IACvD,IAAI,GAAG,IAAI,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,CAEpC;IAsCD,yDAAyD;IACzD,OAAO,CAAC,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI;IASrD,2DAA2D;IAC3D,aAAa,CACX,UAAU,EACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GACtB,CAAC,CAAC,OAAO,EAAE,qBAAqB,CAAC,KAAK,CAAC,KAAK,qBAAqB,CAAC,KAAK,CAAC,CAAC,GAC5E,IAAI;IAYP,kCAAkC;IAClC,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,GAAG,IAAI;IAMnC,kCAAkC;IAClC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG,IAAI;IAMvD;;;;OAIG;IACH,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,KAAK,CAAC,GAAG,IAAI;IAS1C;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,UAAU,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,IAAI;IAsB9E,0BAA0B;IAC1B,aAAa,CACX,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,GAAG,MAAM,CAAC,GAC3E,IAAI;IAKP,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,KAAK,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,GAAG,IAAI;IASpF,4CAA4C;IAC5C,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI;IAU3D,wEAAwE;IACxE,YAAY,CAAC,EAAE,EAAE,CAAC,MAAM,EAAE,kBAAkB,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG,IAAI;IAKnE,qEAAqE;IACrE,uBAAuB,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IASnD,qEAAqE;IACrE,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,GAAG,CAAC,WAAW,EAAE,GAAG,SAAS,CAAC,GAAG,IAAI;IASxE;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,IAAI;IAmB7C,mEAAmE;IACnE,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI;IAKvC;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI;IASzC,mCAAmC;IACnC,WAAW,CAAC,KAAK,UAAO,GAAG,IAAI;IAK/B,8CAA8C;IAC9C,6BAA6B,CAAC,KAAK,UAAO,GAAG,IAAI;IASjD,0CAA0C;IAC1C,eAAe,CAAC,KAAK,UAAO,GAAG,IAAI;IAKnC;;;;;;;;;OASG;IACH,QAAQ,CAAC,QAAQ,EAAE,cAAc,GAAG,iBAAiB,GAAG,IAAI;IAS5D;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,CAAC,KAAK,UAAO,GAAG,IAAI;IAKlC;;;;;OAKG;IACH,YAAY,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG,IAAI;IAQpE;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,CAAC,OAAO,CAAC,EAAE,uBAAuB,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG,IAAI;IAmC1E;;;OAGG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAIpD;;;OAGG;IACH,mBAAmB,IAAI,KAAK,EAAE;IAY9B,8BAA8B;IAC9B,WAAW,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG,IAAI;IAKlE,uBAAuB;IACvB,YAAY,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG,IAAI;IAKpE,8BAA8B;IAC9B,kBAAkB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,qBAAqB,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG,IAAI;IAKhF,wBAAwB;IACxB,aAAa,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG,IAAI;IAKtE,+BAA+B;IAC/B,mBAAmB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,sBAAsB,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG,IAAI;IAKlF,qCAAqC;IACrC,iBAAiB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,oBAAoB,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG,IAAI;IAQ9E,2FAA2F;IAC3F,iBAAiB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,oBAAoB,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG,IAAI;IAW9E;;;OAGG;IACH,eAAe,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG,IAAI;IAKjF;;;OAGG;IACH,qBAAqB,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG,IAAI;IASvF,0BAA0B;IAC1B,cAAc,CACZ,cAAc,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,KAAK,OAAO,EAClD,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,6BAA6B,CAAC,KAAK,CAAC,KAAK,OAAO,GAC1E,IAAI;IAQP,qEAAqE;IACrE,wBAAwB,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IASpD;;;;;;;;;OASG;IACH,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI;IAK1C;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,EAAE,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,KAAK,OAAO,GAAG,IAAI;IAKtE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,YAAY,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,MAAM,KAAK,KAAK,EAAE,GAAG,IAAI,GAAG,IAAI;IAK7E;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,GAAG,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI;IAKzC;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,KAAK,UAAO,GAAG,IAAI;IASnC,2BAA2B;IAC3B,WAAW,CAAC,KAAK,UAAO,GAAG,IAAI;IAK/B,sCAAsC;IACtC,MAAM,CAAC,CAAC,SAAS,MAAM,WAAW,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;IAKtF,oCAAoC;IACpC,OAAO,CAAC,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,GAAG,IAAI;IA2O1C,mEAAmE;IACnE,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI;IA+H3D,2DAA2D;IAC3D,QAAQ,IAAI,IAAI;IAchB,mEAAmE;IACnE,wBAAwB,IAAI,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,GAAG,SAAS;IAI3F,0EAA0E;IAC1E,8BAA8B,IAC1B,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,GACnD,SAAS;IAIb,2FAA2F;IAC3F,0BAA0B,IAAI,OAAO;IAIrC,qDAAqD;IACrD,cAAc,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE;IAIjC,+CAA+C;IAC/C,eAAe,IAAI,WAAW,CAAC,KAAK,CAAC;IAIrC,kDAAkD;IAClD,WAAW,IAAI,KAAK,EAAE,GAAG,IAAI;IAQ7B,2FAA2F;IAC3F,YAAY,IAAI,OAAO;CAGxB"}
|