svelte-csv - npm Package Compare versions

Comparing version 1.1.0 to 1.2.0

package.json

 {
   "name": "svelte-csv",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "svelte-csv is the fastest in-browser CSV (or delimited text) parser for Svelte. It is full of useful features such as CSVReader, CSVDownloader, readString, jsonToCSV, readRemoteFile, ... etc.",
@@ -5,0 +5,0 @@ "author": "Bunlong",

README.md

@@ -21,2 +21,3 @@ # svelte-csv
 
+* CSVDownloader
 * readString
@@ -28,2 +29,85 @@ * readRemoteFile
 
+### 🎀 CSVDownloader
+
+If you want to open your CSV files in Excel, you might want to set `bom={true}` or `bom`, default is `false`. This option adds the so called BOM byte `'\ufeff'` to the beginning of your CSV files and tells Excel that the encoding is UTF8.
+
+#### Link
+
+```javascript
+import { CSVDownloader } from 'svelte-csv';
+
+<CSVDownloader
+  data={[
+    {
+      "Column 1": "1-1",
+      "Column 2": "1-2",
+      "Column 3": "1-3",
+      "Column 4": "1-4",
+    },
+    {
+      "Column 1": "2-1",
+      "Column 2": "2-2",
+      "Column 3": "2-3",
+      "Column 4": "2-4",
+    },
+    {
+      "Column 1": "3-1",
+      "Column 2": "3-2",
+      "Column 3": "3-3",
+      "Column 4": "3-4",
+    },
+    {
+      "Column 1": 4,
+      "Column 2": 5,
+      "Column 3": 6,
+      "Column 4": 7,
+    },
+  ]}
+  filename={'filename'}
+  bom={true}
+>
+  Download
+</CSVDownloader>
+```
+
+#### Link
+
+```javascript
+import { CSVDownloader } from 'svelte-csv';
+
+<CSVDownloader
+  data={[
+    {
+      "Column 1": "1-1",
+      "Column 2": "1-2",
+      "Column 3": "1-3",
+      "Column 4": "1-4",
+    },
+    {
+      "Column 1": "2-1",
+      "Column 2": "2-2",
+      "Column 3": "2-3",
+      "Column 4": "2-4",
+    },
+    {
+      "Column 1": "3-1",
+      "Column 2": "3-2",
+      "Column 3": "3-3",
+      "Column 4": "3-4",
+    },
+    {
+      "Column 1": 4,
+      "Column 2": 5,
+      "Column 3": 6,
+      "Column 4": 7,
+    },
+  ]}
+  type={'button'}
+  filename={'filename'}
+  bom={true}
+>
+  Download
+</CSVDownloader>
+```
+
 ### 🎀 readString
@@ -30,0 +114,0 @@

src/index.js

 export { readString } from './readString.svelte';
 export { jsonToCSV } from './jsonToCSV.svelte';
 export { readRemoteFile } from './readRemoteFile.svelte';
+import CSVDownloader from './CSVDownloader.svelte';
+export { CSVDownloader };

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

155316

increased by38.92%

Number of package files

10

increased by25%

Lines of code

4374

increased by32.75%

Number of lines in readme file

195

increased by75.68%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes