Updated sample.json, readme

pnp · Oct 21, 2024 · d154c38 · d154c38
1 parent 24afe63
commit d154c38
Show file tree

Hide file tree

Showing 2 changed files with 73 additions and 12 deletions.
diff --git a/samples/react-csv-importer/README.md b/samples/react-csv-importer/README.md
@@ -15,8 +15,8 @@ This web part allows users to import CSV files into an existing SharePoint list.
 | 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.20](https://img.shields.io/badge/SPFx-1.20.0-green.svg) 
-![Node.js v18](https://img.shields.io/badge/Node.js-v18-green.svg) 
+![SPFx 1.20](https://img.shields.io/badge/SPFx-1.20.0-green.svg)
+![Node.js v18](https://img.shields.io/badge/Node.js-v18-green.svg)
 ![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
 ![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower")
 ![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
@@ -37,12 +37,13 @@ This web part allows users to import CSV files into an existing SharePoint list.
 
 ## Version history
 
-Version|Date|Comments
--------|----|--------
-1.0|October 11, 2022|Initial release
-1.1|October 20, 2024|Updated to SPFx 1.20 and added capability for chunk size configuration
+|Version|Date|Comments|
+|-------|----|--------|
+|1.0|October 11, 2022|Initial release|
+|1.1|October 20, 2024|Updated to SPFx 1.20 and added capability for chunk size configuration|
 
 ## Minimal path to awesome
+
 * Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-csv-importer) 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:
@@ -55,6 +56,7 @@ Version|Date|Comments
 > This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). 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)
@@ -63,22 +65,23 @@ Version|Date|Comments
 This sample uses [PnP/PnPjs](https://pnp.github.io/pnpjs/) library, [@pnp/spfx-controls-react](https://pnp.github.io/sp-dev-fx-controls-react/), @pnp/[spfx-property-controls](https://pnp.github.io/sp-dev-fx-property-controls/) and [React CSV Importer](https://github.com/beamworks/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](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
 
-You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20YOUR-SOLUTION-NAME%22) to see if anybody else is having the same issues.
+You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-csv-importer%22) to see if anybody else is having the same issues.
 
-You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=YOUR-SOLUTION-NAME) and see what the community is saying.
+You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-csv-importer) and see what the community is saying.
 
-If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20YOUR-SOLUTION-NAME&template=bug-report.yml&sample=YOUR-SOLUTION-NAME&authors=@YOURGITHUBUSERNAME&title=YOUR-SOLUTION-NAME%20-%20).
+If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-csv-importer&template=bug-report.yml&sample=react-csv-importer&authors=@mromiszewski&title=react-csv-importer%20-%20).
 
-For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20YOUR-SOLUTION-NAME&template=question.yml&sample=YOUR-SOLUTION-NAME&authors=@YOURGITHUBUSERNAME&title=YOUR-SOLUTION-NAME%20-%20).
+For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-csv-importer&template=question.yml&sample=react-csv-importer&authors=@mromiszewski&title=react-csv-importer%20-%20).
 
-Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20YOUR-SOLUTION-NAME&template=suggestion.yml&sample=YOUR-SOLUTION-NAME&authors=@YOURGITHUBUSERNAME&title=YOUR-SOLUTION-NAME%20-%20).
+Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-csv-importer&template=suggestion.yml&sample=react-csv-importer&authors=@mromiszewski&title=react-csv-importer%20-%20).
 
 ## 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.**
 
-<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-csv-importer" />
+<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-csv-importer" />
diff --git a/samples/react-csv-importer/assets/sample.json b/samples/react-csv-importer/assets/sample.json
@@ -0,0 +1,58 @@
+[
+    {
+        "name": "pnp-sp-dev-spfx-web-parts-react-csv-importer",
+        "source": "pnp",
+        "title": "CSV Importer",
+        "shortDescription": "This web part allows users to import CSV files into an existing SharePoint list",
+        "url": "https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-csv-importer",
+        "downloadUrl": "https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-csv-importer",
+        "longDescription": [
+            "This web part allows users to import CSV files into an existing SharePoint list"
+        ],
+        "creationDateTime": "2022-10-11",
+        "updateDateTime": "2024-10-20",
+        "products": [
+            "SharePoint"
+        ],
+        "metadata": [
+            {
+                "key": "CLIENT-SIDE-DEV",
+                "value": "React"
+            },
+            {
+                "key": "SPFX-VERSION",
+                "value": "1.20.0"
+            }
+        ],
+        "thumbnails": [
+            {
+                "name": "react-csv-importer.gif",
+                "type": "image",
+                "order": 100,
+                "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-csv-importer/assets/D:\\GitHub\\pnp\\sp-dev-fx-webparts\\samples\\react-csv-importer\\assets\\react-csv-importer.gif",
+                "alt": "Web Part Preview"
+            },
+            {
+                "name": "react-csv-importer.png",
+                "type": "image",
+                "order": 101,
+                "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-csv-importer/assets/D:\\GitHub\\pnp\\sp-dev-fx-webparts\\samples\\react-csv-importer\\assets\\react-csv-importer.png",
+                "alt": "Web Part Preview"
+            }
+        ],
+        "authors": [
+            {
+                "gitHubAccount": "mromiszewski",
+                "pictureUrl": "https://github.com/mromiszewski.png",
+                "name": "Michał Romiszewski"
+            }
+        ],
+        "references": [
+            {
+                "name": "Build your first SharePoint client-side web part",
+                "description": "Client-side web parts are client-side components that run in the context of a SharePoint page. Client-side web parts can be deployed to SharePoint environments that support the SharePoint Framework. You can also use modern JavaScript web frameworks, tools, and libraries to build them.",
+                "url": "https://learn.microsoft.com/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part"
+            }
+        ]
+    }
+]