diff --git a/README.md b/README.md index cbdf445..8936948 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,24 @@ This library uses [guyonroche/exceljs](https://github.com/guyonroche/exceljs) un # Installation +## Browser + Just add a script tag: ```html ``` +## Node + +```bash +npm install @linways/table-to-excel --save +``` + +```javascript +import TableToExcel from "@linways/table-to-excel"; +``` + # Usage Create your HTML table as normal. @@ -38,13 +50,13 @@ TableToExcel.convert(document.getElementById("table1"), { # Cell Types -Cell types can be set using the following data attributes: +Cell types can be set using the following data attributes: -|Attribute| Description| Possible Values| -|---------|------------|----------------| -|`data-t`| To specify the data type of a cell| `s` : String (Default)
`n` : Number
`b` : Boolean
`d` : Date| -|`data-hyperlink`| To add hyper link to cell | External URL or hyperlink to another sheet| -|`data-error`| To add value of a cell as error| | +| Attribute | Description | Possible Values | +| ---------------- | ---------------------------------- | -------------------------------------------------------------------------- | +| `data-t` | To specify the data type of a cell | `s` : String (Default)
`n` : Number
`b` : Boolean
`d` : Date | +| `data-hyperlink` | To add hyper link to cell | External URL or hyperlink to another sheet | +| `data-error` | To add value of a cell as error | | Example: @@ -140,6 +152,7 @@ Example: [Migration Guide](https://github.com/linways/table-to-excel/wiki/Migration-guide-for-V0.2.1-to-V1.0.0) for migrating from V0.2.1 to V1.0.0 +- Changed the backend to Exce[guyonroche/exceljs](https://github.com/guyonroche/exceljs)lJS - Added border color - Option to set style and color for all borders - Exclude row diff --git a/package.json b/package.json index baae5fe..d9dde01 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,23 @@ { - "name": "table-to-excel", - "version": "1.0.0", - "description": "", - "main": "index.js", + "name": "@linways/table-to-excel", + "version": "1.0.1", + "description": "Javascript library to create 'valid' excel file from html table with styles", + "main": "./dist/tableToExcel.js", + "repository": { + "type": "git", + "url": "https://github.com/linways/table-to-excel" + }, + "bugs": { + "url": "https://github.com/linways/table-to-excel/issues" + }, + "homepage": "https://github.com/linways/table-to-excel#readme", + "keywords": [ + "html table to excel", + "excel with styles", + "excel js", + "table to excel", + "html to xlsx" + ], "scripts": { "dev": "parcel sample/index.html", "build": "parcel build src/tableToExcel.js",