Export

Export a collection: scope (selected / current view / all), columns (searchable, reorderable, personal data maskable), format (CSV, XLSX, JSON) with locale CSV conventions, a reason for personal-data exports, and background jobs with a focusable download link. exportToBlob writes the file; XLSX loads write-excel-file only when chosen.

Installation

Usage

import { ExportDialog, exportToBlob } from "@vamos-ui/react/business";

<ExportDialog
  resource="contacts"
  columns={columns}
  listState={listState}
  selectedCount={selection.length}
  filteredCount={total}
  totalCount={allContacts}
  trigger={<Button><Download /> Export</Button>}
  onExport={async (r) => r.scope === "all" ? api.exports.start(r) /* → { jobId } */ : { blob: await exportToBlob({ rows, columns: pick(r.columns), format: r.format, masked: r.masked }) }}
  pollJob={api.exports.status}
/>

Scope and format are radio groups, columns a checkbox list with select-all and drag or keyboard reordering. File names carry the local date: contacts-2026-11-10.csv. Writing the audit entry is the app's job — onExport receives the reason.

Examples

API