--- sidebar_position: 2 --- # Hyperlinks
File Format Support (click to show) | Formats | Link | Tooltip | Link Type | |:------------------|:-----:|:-------:|:----------| | XLSX / XLSM | ✔ | ✔ | Cell Link | | XLSB | ✔ | ✔ | Cell Link | | XLS (BIFF8) | ✔ | ✔ | Cell Link | | XLML | ✔ | ✔ | Cell Link | | ODS / FODS / UOS | ✔ | | Span Link | | HTML | ✔ | ✕ | Span Link | | NUMBERS | ✔ | ✕ | Span Link | X (✕) marks features that are not supported by the file formats. For example, the NUMBERS file format does not support custom tooltips. For "Span Link" formats, parsers apply the first hyperlink to the entire cell and writers apply the hyperlink to the entire cell text.
Hyperlinks are stored in the `l` key of cell objects. The `Target` field of the hyperlink object is the target of the link, including the URI fragment. Tooltips are stored in the `Tooltip` field and are displayed when hovering over the text. For example, the following snippet creates a link from cell `A3` to with the tip `"Find us @ SheetJS.com!"`: ```js ws["A1"].l = { Target: "https://sheetjs.com", Tooltip: "Find us @ SheetJS.com!" }; ``` :::note Following traditional software, hyperlinks are applied to entire cell objects. Some formats (including HTML) attach links to text spans. The parsers apply the first link to the entire cell. Writers apply links to the entire cell text. ::: :::caution Excel does not automatically style hyperlinks. They will be displayed using the default cell style. SheetJS Pro Basic includes support for general hyperlink styling. :::
Live Example (click to hide) ```jsx live /* The live editor requires this function wrapper */ function ExportSimpleLink(props) { return ( ); } ```
## Remote Links HTTP / HTTPS links can be used directly: ```js ws["A2"].l = { Target: "https://docs.sheetjs.com/docs/csf/features/hyperlinks" }; ws["A3"].l = { Target: "http://localhost:7262/yes_localhost_works" }; ``` Excel also supports `mailto` email links with subject line: ```js ws["A4"].l = { Target: "mailto:ignored@dev.null" }; ws["A5"].l = { Target: "mailto:ignored@dev.null?subject=Test Subject" }; ```
Live Example (click to show) **This demo creates a XLSX spreadsheet with a `mailto` email link. The email address input in the form never leaves your machine.** ```jsx live /* The live editor requires this function wrapper */ function ExportRemoteLink(props) { const [email, setEmail] = React.useState("ignored@dev.null"); const set_email = React.useCallback((evt) => setEmail(evt.target.value)); /* Callback invoked when the button is clicked */ const xport = React.useCallback(() => { /* Create worksheet */ var ws = XLSX.utils.aoa_to_sheet([ [ "HTTPS", "mailto" ] ]); /* Add links */ ws["A1"].l = { Target: "https://sheetjs.com" }; ws["B1"].l = { Target: `mailto:${email}` }; /* Export to file (start a download) */ var wb = XLSX.utils.book_new(); XLSX.utils.book_append_sheet(wb, ws, "Sheet1"); XLSX.writeFile(wb, "SheetJSRemoteLink.xlsx"); }); return ( <> Email:
); } ```
## Local Links Links to absolute paths should use the `file://` URI scheme: ```js ws["B1"].l = { Target: "file:///SheetJS/t.xlsx" }; /* Link to /SheetJS/t.xlsx */ ws["B2"].l = { Target: "file:///c:/SheetJS.xlsx" }; /* Link to c:\SheetJS.xlsx */ ``` Links to relative paths can be specified without a scheme: ```js ws["B3"].l = { Target: "SheetJS.xlsb" }; /* Link to SheetJS.xlsb */ ws["B4"].l = { Target: "../SheetJS.xlsm" }; /* Link to ../SheetJS.xlsm */ ``` :::caution Relative Paths have undefined behavior in the SpreadsheetML 2003 format. Excel 2019 will treat a `..\` parent mark as two levels up. ::: ## Internal Links Links where the target is a cell or range or defined name in the same workbook ("Internal Links") are marked with a leading hash character: ```js ws["C1"].l = { Target: "#E2" }; /* Link to cell E2 */ ws["C2"].l = { Target: "#Sheet2!E2" }; /* Link to cell E2 in sheet Sheet2 */ ws["C3"].l = { Target: "#SheetJSDName" }; /* Link to Defined Name */ ```
Live Example (click to show) ```jsx live /* The live editor requires this function wrapper */ function ExportInternalLink(props) { return ( ); } ```
:::caution Some third-party tools like Google Sheets do not correctly parse hyperlinks in XLSX documents. A workaround was added in library version 0.18.12. ::: ## HTML The HTML DOM parser will process `` links in the table:
Live Example (click to hide) ```jsx live /* The live editor requires this function wrapper */ function ExportHyperlink(props) { /* Callback invoked when the button is clicked */ const xport = React.useCallback(() => { /* Create worksheet from HTML DOM TABLE */ const table = document.getElementById("TableLink"); const wb = XLSX.utils.table_to_book(table); /* Export to file (start a download) */ XLSX.writeFile(wb, "SheetJSHTMLHyperlink.xlsx"); }); return ( <> ); } ```