\n \n\n[](https://snyk.io/test/npm/xlsx-js-style) [](https://www.npmjs.com/package/xlsx-js-style)\n[](https://img.shields.io/npm/types/xlsx-js-style)\n\n## đ Installation\n\nInstall [npm](https://www.npmjs.org/package/xlsx-js-style):\n\n```sh\nnpm install xlsx-js-style\n```\n\nInstall browser:\n\n```html\n\n```\n\n## đ Core API\n\n- Refer to the [SheetJS](https://sheetjs.com/) documentation for core API reference\n- Current version of sheetjs used: **0.18.5**\n\n## đ Style API\n\n### Cell Style Example\n\n```js\n// STEP 1: Create a new workbook\nconst wb = XLSX.utils.book_new();\n\n// STEP 2: Create data rows and styles\nlet row = [\n\t{ v: \"Courier: 24\", t: \"s\", s: { font: { name: \"Courier\", sz: 24 } } },\n\t{ v: \"bold & color\", t: \"s\", s: { font: { bold: true, color: { rgb: \"FF0000\" } } } },\n\t{ v: \"fill: color\", t: \"s\", s: { fill: { fgColor: { rgb: \"E9E9E9\" } } } },\n\t{ v: \"line\\nbreak\", t: \"s\", s: { alignment: { wrapText: true } } },\n];\n\n// STEP 3: Create worksheet with rows; Add worksheet to workbook\nconst ws = XLSX.utils.aoa_to_sheet([row]);\nXLSX.utils.book_append_sheet(wb, ws, \"readme demo\");\n\n// STEP 4: Write Excel file to browser\nXLSX.writeFile(wb, \"xlsx-js-style-demo.xlsx\");\n```\n\n### Cell Style Properties\n\n- Cell styles are specified by a style object that roughly parallels the OpenXML structure.\n- Style properties currently supported are: `alignment`, `border`, `fill`, `font`, `numFmt`.\n\n| Style Prop | Sub Prop | Default | Description/Values |\n| :---------- | :------------- | :---------- | ------------------------------------------------------------------------------------------------- |\n| `alignment` | `vertical` | `bottom` | `\"top\"` or `\"center\"` or `\"bottom\"` |\n| | `horizontal` | `left` | `\"left\"` or `\"center\"` or `\"right\"` |\n| | `wrapText` | `false` | `true` or `false` |\n| | `textRotation` | `0` | `0` to `180`, or `255` // `180` is rotated down 180 degrees, `255` is special, aligned vertically |\n| `border` | `top` | | `{ style: BORDER_STYLE, color: COLOR_STYLE }` |\n| | `bottom` | | `{ style: BORDER_STYLE, color: COLOR_STYLE }` |\n| | `left` | | `{ style: BORDER_STYLE, color: COLOR_STYLE }` |\n| | `right` | | `{ style: BORDER_STYLE, color: COLOR_STYLE }` |\n| | `diagonal` | | `{ style: BORDER_STYLE, color: COLOR_STYLE, diagonalUp: true/false, diagonalDown: true/false }` |\n| `fill` | `patternType` | `\"none\"` | `\"solid\"` or `\"none\"` |\n| | `fgColor` | | foreground color: see `COLOR_STYLE` |\n| | `bgColor` | | background color: see `COLOR_STYLE` |\n| `font` | `bold` | `false` | font bold `true` or `false` |\n| | `color` | | font color `COLOR_STYLE` |\n| | `italic` | `false` | font italic `true` or `false` |\n| | `name` | `\"Calibri\"` | font name |\n| | `strike` | `false` | font strikethrough `true` or `false` |\n| | `sz` | `\"11\"` | font size (points) |\n| | `underline` | `false` | font underline `true` or `false` |\n| | `vertAlign` | | `\"superscript\"` or `\"subscript\"` |\n| `numFmt` | | `0` | Ex: `\"0\"` // integer index to built in formats, see StyleBuilder.SSF property |\n| | | | Ex: `\"0.00%\"` // string matching a built-in format, see StyleBuilder.SSF |\n| | | | Ex: `\"0.0%\"` // string specifying a custom format |\n| | | | Ex: `\"0.00%;\\\\(0.00%\\\\);\\\\-;@\"` // string specifying a custom format, escaping special characters |\n| | | | Ex: `\"m/dd/yy\"` // string a date format using Excel's format notation |\n\n### `COLOR_STYLE` {object} Properties\n\nColors for `border`, `fill`, `font` are specified as an name/value object - use one of the following:\n\n| Color Prop | Description | Example |\n| :--------- | ----------------- | --------------------------------------------------------------- |\n| `rgb` | hex RGB value | `{rgb: \"FFCC00\"}` |\n| `theme` | theme color index | `{theme: 4}` // (0-n) // Theme color index 4 (\"Blue, Accent 1\") |\n| `tint` | tint by percent | `{theme: 1, tint: 0.4}` // (\"Blue, Accent 1, Lighter 40%\") |\n\n### `BORDER_STYLE` {string} Properties\n\nBorder style property is one of the following values:\n\n- `dashDotDot`\n- `dashDot`\n- `dashed`\n- `dotted`\n- `hair`\n- `mediumDashDotDot`\n- `mediumDashDot`\n- `mediumDashed`\n- `medium`\n- `slantDashDot`\n- `thick`\n- `thin`\n\n**Border Notes**\n\nBorders for merged areas are specified for each cell within the merged area. For example, to apply a box border to a merged area of 3x3 cells, border styles would need to be specified for eight different cells:\n\n- left borders (for the three cells on the left)\n- right borders (for the cells on the right)\n- top borders (for the cells on the top)\n- bottom borders (for the cells on the left)\n\n## đ Thanks\n\nThis project is a fork of [SheetJS/sheetjs](https://github.com/sheetjs/sheetjs) combined with code from\n[sheetjs-style](https://www.npmjs.com/package/sheetjs-style) (by [ShanaMaid](https://github.com/ShanaMaid/))\nand [sheetjs-style-v2](https://www.npmjs.com/package/sheetjs-style-v2) (by [Raul Gonzalez](https://www.npmjs.com/~armandourbina)).\n\nAll projects are under the Apache 2.0 License\n\n- [sheetjs](https://github.com/SheetJS/sheetjs)\n- [js-xlsx](https://github.com/protobi/js-xlsx)\n- [sheetjs-style](https://www.npmjs.com/package/sheetjs-style)\n- [sheetjs-style-v2](https://www.npmjs.com/package/sheetjs-style-v2)\n\n## đ License\n\nPlease consult the attached [LICENSE](https://github.com/gitbrent/xlsx-js-style/blob/master/LICENSE) file for details. All rights not explicitly\ngranted by the Apache 2.0 License are reserved by the Original Author.\n","readmeFilename":"README.md"}
![\"xlsx-js-style](\"https://github.com/gitbrent/xlsx-js-style/blob/7664a045cd8f96b6b1b92ad563babebb8d6e0b4a/demos/browser/images/readme_banner.png\"/ "\\"xlsx-js-style")
\n \n