excellentexport 3.8.1 → 3.9.0

package/.github/workflows/webpack.yml

@@ -16,12 +16,15 @@ jobs:
         node-version: [18.x]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
 
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
+        cache: 'yarn'
 
     - run: yarn install
 

package/README.md

@@ -12,9 +12,7 @@
 
  - A quick JavaScript library to create export to Excel/CSV from HTML tables in the browser. No server required.
 
- - As part of the new version 3.0.0+, there is support for _XLSX_. The drawback is that the library is 600+ KB.
-
- - If you only need _XLS_ or _CSV_, use _2.X.X_ versions.
+ - As part of the new version 3.0.0+, there is support for _XLSX_. The drawback is that the library is 200+ KB.
 
  - Check My Blog Page for Testing :
       [JavaScript export to Excel](http://jordiburgos.com/post/2013/javascript-export-to-excel.html)
@@ -23,6 +21,10 @@
 
 # Revision history:
 
+### 3.9.0
+
+* Cell types and formats!!! Now you can define the cell type and format. For example, you can define a cell as a date or a number. You can also define the format of the cell. For example, you can define a cell as a date with the format "dd/mm/yyyy" or a number with the format "#,##0.00".
+
 ### 3.8.1
 
 * Activate XLSX compression by default. The example of index.bigtable.html went from 18Mb to 3Mb.
@@ -160,7 +162,7 @@
  - Chrome
  - Internet Explorer 11+
 
-# Install 
+# Install
 
 ## npm
 
@@ -241,6 +243,7 @@
             fixValue: function(value, row, column) {return fixedValue} // Function to fix values, receiving value, row num, column num
             fixArray: function(array) {return array} // Function to manipulate the whole data array
             rtl: Use Right-to-left characters, boolean (optional)
+            formats: [...] // Array of formats for each column. See formats below.
             ...
         },
         {
@@ -250,7 +253,7 @@
 
 ## fixValue example
 
-This is an example for the _fixValue function_ to handle HTML tags inside a table cell. 
+This is an example for the _fixValue function_ to handle HTML tags inside a table cell.
 It transforms BR to line breaks and then strips all the HTML tags.
 
                 fixValue: (value, row, col) => {
@@ -259,6 +262,47 @@ It transforms BR to line breaks and then strips all the HTML tags.
                     return strippedString;
                 }
 
+## Formats
+
+You can specify an array with the formats for a specific cell range (i.e. A1:A100, A1:D100, A1:H1, etc).
+
+Each element in the format array consists on:
+
+```json
+{
+    "range": "A1:A100", // Range of cells to apply the format, mandatory
+    "format": {
+        "type": "<cell_type>", // Type of format, mandatory
+        "pattern": "<pattern>" // Pattern, optional
+    }
+}
+```
+
+`format` can be used from one of the predefined types if you use TypeScript
+
+```typescript
+{
+    "range": "A1:A100",
+    "format": PredefinedFormat.INTEGER
+}
+```
+
+`cell_type` can be one of the followint:
+
+    's': String
+    'n': Number
+    'd': Date
+    'b': Boolean
+
+`pattern` is a string with the format pattern used in Excel. For example:
+
+    '0' // Integer
+    '0.00' // 2 decimals
+    'dd/mm/yyyy' // Date
+    'dd/mm/yyyy hh:mm:ss' // Date and time
+    '0.00%' // Percentage
+    '0.00e+00' // Scientific notation
+    '@' // Text
 
 # Notes
 
@@ -279,7 +323,7 @@ It transforms BR to line breaks and then strips all the HTML tags.
 **Install dependencies:**
 
     npm install
-    
+
 **Build development version dist/excellentexport.js**
 
     npm run build

package/dist/excellentexport.d.ts

@@ -6,6 +6,7 @@
  * @url: https://github.com/jmaister/excellentexport
  *
  */
+import { FormatDefinition } from './format';
 declare global {
     interface Navigator {
         msSaveBlob?: (blob: any, defaultName?: string) => boolean;
@@ -30,9 +31,11 @@ export interface SheetOptions {
     fixValue?(value: any, row: number, column: number): any;
     fixArray?(array: any[][]): any[][];
     rtl?: boolean;
+    formats?: (FormatDefinition | null)[];
 }
 declare const ExcellentExport: {
     version: () => string;
+    formats: import("./format").CellFormats;
     excel: (anchor: (HTMLAnchorElement | string), table: HTMLTableElement, name: string) => boolean;
     csv: (anchor: (HTMLAnchorElement | string), table: HTMLTableElement, delimiter?: string, newLine?: string) => boolean;
     convert: (options: ConvertOptions, sheets: SheetOptions[]) => string | false;