ExcelImport

ExcelImport is a modal wizard from the @svar-uivue-excel-import package that uploads .xlsx, .csv, or .tsv files, lets users map spreadsheet columns to card fields, and returns transformed rows. Mount it conditionally and unmount it in the onclose handler.

Usage

import { ExcelImport } from "@svar-uivue-excel-import";

<ExcelImport
  :fields="FieldDefinition[]"
  :generateIds="boolean"
  :onimport="(rows, result) => void"
  :onclose="() => void"
/>

Configuration is passed as individual props (spread an object if needed - <ExcelImport v-bind="config" />). A single config prop doesn't work.

Props:

Prop	Type	Default	Description
fields	FieldDefinition[]	-	Target output fields. Required.
generateIds	boolean	false	Assigns numeric IDs to rows that lack them
headerRow	boolean	true	Treat the first row as headers
autoDetection	boolean	true	Auto-match columns to fields by name and type
autoClose	boolean	false	Close after import instead of showing a summary
selectors	"both" | "top" | "right"	"both"	Column mapping UI layout
accept	string	".xlsx,.csv,.tsv"	Accepted file types
previewRowCount	number	10	Number of preview rows shown (all rows are imported)
data	ParsedExcelData	undefined	Pre-parsed data; skips the upload stage
onimport	(rows: TransformedRow[], result: ImportResult) => void	-	Fires after transform with the mapped rows
validate	(mappings: FieldMappings, sheet: ParsedSheetData) => ValidationResult	-	Validates mappings before import; return valid: false to disable the Import button
onclose	() => void	-	Fires on close; the host must unmount the component

FieldDefinition:

Field	Type	Description
id	string	Output key in the transformed row
label	string	Display label shown in the mapping UI
expectedType	"text" | "number" | "date" | "boolean" | "mixed"	Strict type conversion; incompatible rows are skipped
required	boolean	Skip rows where this field is empty
keywords	string[]	Extra terms for auto-detection matching

Example

Importing spreadsheet rows into the kanban board:

<script setup>
  import { Kanban } from "@svar-uivue-kanban";
  import { ExcelImport } from "@svar-uivue-excel-import";

  const api = ref(null);
  const open = ref(false);

  function handleImport(cards) {
    cards.forEach(card => (card.column = card.column || "todo"));
    api.value.exec("provide-data", { cards });
    open.value = false;
  }
</script>

<template>
  <button :onclick="() => (open = true)">Import from Excel</button>
  <Kanban ref="api" :cards="cards" :columns="columns" />

  <ExcelImport
    v-if="open"
    :fields="[
      { label: 'Title', id: 'label' },
      { label: 'Deadline', id: 'deadline' },
      { label: 'Description', id: 'description' },
    ]"
    :generateIds="true"
    :onimport="handleImport"
    :onclose="() => (open = false)"
  />
</template>

Related

• Export and import guide - import workflow and provide-data usage
• provide-data - upserts imported cards into the store