Excel

Import and Export from XLSX files

Use the @rowsncolumns/toolkit package to read, write and download Excel files from SheetData object

Import from Excel

Converts an excel file to sheets, sheetData which can be used in the CanvasGrid.

Note: To generate patches, undo/redo when an excel file is uploaded, use onInsertFile function from useSpreadsheetStatehook

import { createRowDataFromExcelFile } from "@rowsncolumns/toolkit";

const App = () => {
  const { onInsertFile } = useSpreadsheetState()
  const handleChange = async (e) => {
    const file = e.target.files[0]
    
    // Option 1: To let useSpreadsheetState hook to manage collab, undo/redo state
    onInsertFile(file)
    
    // Option 2: To manually update state
    const { sheets, sheetData, tables } = await createRowDataFromExcelFile(file)
    
    onChange(sheets)
    onChangSheetData(sheetData)
    onChangeTables(tables)
    
    // Call calculateNow to trigger a full-recalc if you are using
    // useSpreadsheetState hook
  }
  return (
    <div>
      <input type="file" onChange={handleChange} />
    </div>
  )
}

Importing large excel files

createRowDataFromExcelFile when run on the main thread can block UI interactions which is why you can createExcelImporterthat outputs each sheet in an async iterator

import { createExcelImporter } from "@rowsncolumns/toolkit";
import { useLoadingIndicator } from "@rowsncolumns/spreadsheet"
 
const App = () => {
    const [showLoader, hideLoader] = useLoadingIndicator();
    return (
        <input
            type="file"
            onChange={async (e) => {
              const file = e.target.files?.[0];
              if (file) {
                showLoader("Parsing excel file");
                for await (const result of createExcelImporter(file)) {
                  if ("sheet" in result) {
                    const {
                      rowData,
                      sheet,
                      conditionalFormatting,
                      embeds,
                      fontFamilies,
                      namedRanges,
                      tables,
                      processedSheetCount,
                    } = result;

                    // Add sheet
                    onChangeSheets((prev) => {
                      if (processedSheetCount === 1) {
                        return [sheet];
                      }
                      return [...prev, sheet];
                    });

                    // Add rowData
                    onChangeSheetData((prevSheetData) => {
                      if (processedSheetCount === 1) {
                        prevSheetData = {};
                      }
                      prevSheetData[sheet.sheetId] = rowData;
                      return prevSheetData;
                    });
                  } else {
                    showLoader(`Processing: ${result.sheetTitle}`);
                  }
                }

                hideLoader();
              }
            }}
          />
    )
}

Export to Excel

Toolkit provides createExcelFile and exportToExcel functions to either create a excel ArrayBuffer or create a downloadable excel file.

// Export toolkit
import {
  createExcelFile,
  exportToExcel,
} from "@rowsncolumns/toolkit";

import React, { useState } from "react"
import { useSpreadsheetState, SheeData } from "@rowsncolumns/spreadsheet-state"
import { functionDescriptions, functions } from "@rowsncolumns/functions";
import { 
  SpreadsheetProvider,
  CanvasGrid, 
  CellData, 
  Sheet, 
  EmbeddedChart, 
  EmbeddedObject, 
  TableView 
} from "@rowsncolumns/spreadsheet"

const MySpreadSheet = () => {
  const [sheets, onChangeSheets] = useState<Sheet[]>([]);
  const [sheetData, onChangeSheetData] = useState<SheetData<CellData>>({});
  const [scale, onChangeScale] = useState(1);
  const [charts, onChangeCharts] = useState<EmbeddedChart[]>([]);
  const [embeds, onChangeEmbeds] = useState<EmbeddedObject[]>([]);
  const [tables, onChangeTables] = useState<TableView[]>([]);
  
  return (
    <button onClick={async () => {
      // Download excel file
      await exportToExcel({
        filename: "my_excel_file",
        sheets,
        sheetData,
        tables
      })
      
      // OR Create a Array buffer
      const blob = await createExcelFile({ sheets, sheetData, tables })
      
    }}>Download excel</button>
  )
}