@mk-kit/ui 0.41.0 → 0.42.0

package/fesm2022/mk-kit-ui-table.mjs

@@ -1001,12 +1001,22 @@ class MkTable {
     }
     // --- Export -----------------------------------------------------------------
     /**
-     * The table's rows as CSV: current column order, column formatters applied,
-     * sorted the way they are shown, tree children flattened under their parent
-     * whether or not they are expanded. Downloads the file (default name
-     * `table.csv`) and returns the text.
+     * The rows and columns an export writes — exactly what {@link exportCsv}
+     * serialises, for other formats (XLSX, PDF, the clipboard, …): rows in
+     * display order with the current sort applied and tree children
+     * (`childrenKey`) flattened under their parent whether or not they are
+     * expanded, optionally only the selected ones; columns in the table's
+     * current order, restricted to `options.columns` when given, each carrying
+     * its header and `format` so what the user saw is what gets written.
+     *
+     * ```ts
+     * const { rows, columns } = table.getExportRows({ selectedOnly: true });
+     * const sheet = rows.map((row) =>
+     *   Object.fromEntries(columns.map((c) => [c.header ?? c.key, c.format ? c.format(row[c.key], row) : row[c.key]])),
+     * );
+     * ```
      */
-    exportCsv(options = {}) {
+    getExportRows(options = {}) {
         let rows = this.allRows();
         if (options.selectedOnly) {
             const keys = this.selectedKeys();
@@ -1016,7 +1026,17 @@ class MkTable {
         const columns = this.orderedColumns()
             .filter((c) => !only || only.has(c.key))
             .map((c) => ({ key: c.key, header: c.header, format: c.format }));
-        // `allRows` is already flat, so no childrenKey is passed through.
+        return { rows, columns };
+    }
+    /**
+     * The table's rows as CSV: current column order, column formatters applied,
+     * sorted the way they are shown, tree children flattened under their parent
+     * whether or not they are expanded. Downloads the file (default name
+     * `table.csv`) and returns the text. Built on {@link getExportRows}.
+     */
+    exportCsv(options = {}) {
+        const { rows, columns } = this.getExportRows(options);
+        // The rows are already flat, so no childrenKey is passed through.
         const csv = mkToCsv(rows, columns, { ...options, childrenKey: undefined });
         if (options.download !== false) {
             let filename = options.filename ?? 'table.csv';