sp-dev-fx-webparts/samples/react-csv-importer/README.md

5.8 KiB

CSV Importer

Summary

This web part allows users to import CSV files into an existing SharePoint list.

CSV Importer preview

CSV Importer preview

Compatibility

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

SPFx 1.15.2 Node.js v14 | v12 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Unsupported Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Get your own free development tenant by subscribing to Microsoft 365 developer program

Solution

Solution Author(s)
react-csv-importer Michał Romiszewski (@romiszewski)

Version history

Version Date Comments
1.0 October 11, 2022 Initial release

Minimal path to awesome

  • Clone this repository (or download this solution as a .ZIP file then unzip it)
  • From your command line, change your current directory to the directory containing this sample (react-csv-importer, located under samples)
  • in the command line run:
    • npm install
    • gulp serve
  • To package and deploy:
    • Use gulp bundle --ship & gulp package-solution --ship
    • Add the .sppkg to your SharePoint App Catalog

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Features

  • Uploader and CSV parser
  • Raw file preview
  • User selectable column mapping (drag and drop UI)
  • Automatically map fields to SharePoint list column names

This sample uses PnP/PnPjs library, @pnp/spfx-controls-react, @pnp/spfx-property-controls and React CSV Importer component.

Help

We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.