Socket
Socket
Sign inDemoInstall

github.com/linways/table-to-excel

Package Overview
Dependencies
Alerts
File Explorer
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

github.com/linways/table-to-excel


Version published
Created
Source

Table to Excel 2

Build Status

Export HTML table to valid excel file effortlessly. This library uses guyonroche/exceljs under the hood to create the excel.
(Initial version of this library was using protobi/js-xlsx, it can be found here)

Installation

Browser

Just add a script tag:

<script type="text/javascript" src="../dist/tableToExcel.js"></script>

Node

npm install @linways/table-to-excel --save
import TableToExcel from "@linways/table-to-excel";

Usage

Create your HTML table as normal.
To export content of table #table1 run:

TableToExcel.convert(document.getElementById("table1"));

or

TableToExcel.convert(document.getElementById("table1"), {
  name: "table1.xlsx",
  sheet: {
    name: "Sheet 1"
  }
});

Check this pen for working example.

Cell Types

Cell types can be set using the following data attributes:

AttributeDescriptionPossible Values
data-tTo specify the data type of a cells : String (Default)
n : Number
b : Boolean
d : Date
data-hyperlinkTo add hyper link to cellExternal URL or hyperlink to another sheet
data-errorTo add value of a cell as error

Example:

<!-- for setting a cell type as number -->
<td data-t="n">2500</td>
<!-- for setting a cell type as date -->
<td data-t="d">05-23-2018</td>
<!-- for setting a cell type as boolean. String "true/false" will be accepted as Boolean-->
<td data-t="b">true</td>
<!-- for setting a cell type as boolean using integer. 0 will be false and any non zero value will be true -->
<td data-t="b">0</td>
<!-- For adding hyperlink -->
<td data-hyperlink="https://google.com">Google</td>

Cell Styling

All styles are set using data attributes on td tags. There are 5 types of attributes: data-f-*, data-a-*, data-b-*, data-fill-* and data-num-fmt which corresponds to five top-level attributes font, alignment, border, fill and numFmt.

CategoryAttributeDescriptionValues
fontdata-f-nameFont name"Calibri" ,"Arial" etc.
data-f-szFont size"11" // font size in points
data-f-colorFont colorA hex ARGB value. Eg: FFFFOOOO for opaque red.
data-f-boldBoldtrue or false
data-f-italicItalictrue or false
data-underlineUnderlinetrue or false
data-f-strikeStriketrue or false
Alignmentdata-a-hHorizontal alignmentleft, center, right, fill, justify, centerContinuous, distributed
data-a-vVertical alignmentbottom, middle, top, distributed, justify
data-a-wrapWrap texttrue or false
data-a-indentIndentInteger
data-a-rtlText direction: Right to Lefttrue or false
data-a-text-rotationText rotation0 to 90
-1 to -90
vertical
Borderdata-b-a-sBorder style (all borders)Refer BORDER_STYLES
data-b-t-sBorder top styleRefer BORDER_STYLES
data-b-b-sBorder bottom styleRefer BORDER_STYLES
data-b-l-sBorder left styleRefer BORDER_STYLES
data-b-r-sBorder right styleRefer BORDER_STYLES
data-b-a-cBorder color (all borders)A hex ARGB value. Eg: FFFFOOOO for opaque red.
data-b-t-cBorder top colorA hex ARGB value.
data-b-b-cBorder bottom colorA hex ARGB value.
data-b-l-cBorder left colorA hex ARGB value.
data-b-r-cBorder right colorA hex ARGB value.
Filldata-fill-colorCell background colorA hex ARGB value.
numFmtdata-num-fmtNumber Format"0"
"0.00%"
"0.0%" // string specifying a custom format
"0.00%;\(0.00%\);\-;@" // string specifying a custom format, escaping special characters

BORDER_STYLES: thin, dotted, dashDot, hair, dashDotDot, slantDashDot, mediumDashed, mediumDashDotDot, mediumDashDot, medium, double, thick

Exclude Cells and rows

To exclude a cell or a row from the exported excel add data-exclude="true" to the corresponding td or tr.
Example:

<!-- Exclude entire row -->
<tr data-exclude="true">
  <td>Excluded row</td>
  <td>Something</td>
</tr>

<!-- Exclude a single cell -->
<tr>
  <td>Included Cell</td>
  <td data-exclude="true">Excluded Cell</td>
  <td>Included Cell</td>
</tr>

Column Width

Column width's can be set by specifying data-cols-width in the <table> tag. data-cols-width accepts comma separated column widths specified in character count . data-cols-width="10,20" will set width of first coulmn as width of 10 charaters and second column as 20 characters wide.
Example:

<table data-cols-width="10,20,30">
  ...
</table>

Row Height

Row Height can be set by specifying data-height in the <tr> tag.
Example:

<tr data-height="42.5">
  <td>Cell 1</td>
  <td>Cell 2</td>
</tr>

Release Changelog

1.0.0

Migration Guide for migrating from V0.2.1 to V1.0.0

  • Changed the backend to Exceguyonroche/exceljslJS
  • Added border color
  • Option to set style and color for all borders
  • Exclude row
  • Added text underline
  • Added support for hyperlinks
  • Text intent
  • RTL support
  • Extra alignment options
  • String "true/false" will be accepted as Boolean
  • Changed border style values
  • Text rotation values changed

1.0.2

  • Fixed bug in handling multiple columns merges in a sheet

1.0.3

  • Option to specify row height

FAQs

Package last updated on 06 May 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc