Skip to content

Corbe30/FortuneExcel

 
 

Repository files navigation

FortuneExcel

FortuneExcel is an .xlsx and .csv import/export plugin for FortuneSheet / ProsperaSheet.

Usage

  1. Install the package:

    npm i @corbe30/fortune-excel
  2. Import/export toolbar item (code example)

    Note: <FortuneExcelHelper /> is a hidden component.

    import { FortuneExcelHelper, importToolBarItem, exportToolBarItem } from "@corbe30/fortune-excel";
    
    function App() {
      const sheetRef = useRef();
      const [key, setKey] = useState(0);
      const [sheets, setSheets] = useState(data);
    
      return (
        <>
          <FortuneExcelHelper
            setKey={setKey}
            setSheets={setSheets}
            sheetRef={sheetRef}
            config={{ // default = all values are true
              import: { xlsx: true, csv: true },
              export: { xlsx: true, csv: true },
            }}
          />
          <Workbook
            key={key} data={sheets} ref={sheetRef}
            customToolbarItems={[importToolBarItem(), exportToolBarItem()]}
          />
        </>
      );
    }
  3. Programmatic import/export (code example)

    import { transformFortuneToExcel } from "@corbe30/fortune-excel";
    
    const manualExport = async () => {
      const exportedFile = await transformFortuneToExcel(
        sheetRef.current,
        "xlsx", // or "csv"; default = "xlsx"
        true // start automatic download; default = true
      );
      console.log("Exported file data:", exportedFile);
    };
    
    <button onClick={manualExport}>Export</button>
    import { transformExcelToFortune } from "@corbe30/fortune-excel";
     
    const manualImport = async (event) => {
      await transformExcelToFortune(
        event.target.files[0], // file type (csv/xlsx) is automatically identified
        setSheets,
        setKey,
        sheetRef.current
      )
    }

Authors and acknowledgment

Developers of FortuneSheetExcel:

Export support:

Contribution

  1. Install node v20.17.0
  2. npm run prepare
  3. npm run build-storybook
  4. npm run storybook

License

MIT

About

Excel import/export library for FortuneSheet

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.9%
  • JavaScript 0.1%