Fix issues table export.jquery.plugin deprecated #8070 by marktech0813 · Pull Request #8071 · wenzhixin/bootstrap-table

marktech0813 · 2025-11-13T14:51:20Z

What I changed

Implemented a built-in exporter in src/extensions/export/bootstrap-table-export.js that:
Supports types: json, xml, csv, txt, sql, and maps excel to CSV (.xls).
Preserves existing behaviors: fileName function support, footer export, column visibility (forceExport/forceHide), selected/all/basic export, and detail-view column exclusion via ignoreColumn.
Uses safe Blob download, avoiding deprecated/vulnerable plugin code.
Updated docs in site/src/pages/docs/extensions/export.mdx:
Removed plugin requirement.
Documented built-in options (fileName, csvDelimiter, tableName) and supported types.
Updated CONTRIBUTING.md to reflect that Table Export is now built-in.

Notes

Users no longer need to include the deprecated plugin; exports work out of the box.
If you publish new artifacts, run the build to regenerate dist/ so consumers loading from dist/ get the changes.
Status: I replaced the plugin with a built-in exporter, updated docs, and removed references.
I removed the deprecated tableExport.jquery.plugin usage and implemented a built‑in exporter.

Contribution by Gittensor, learn more at https://gittensor.io/

Updated CONTRIBUTING.md to reflect that Table Export is now built-in.

Updated docs in site/src/pages/docs/extensions/export.mdx: - Removed plugin requirement. - Documented built-in options (fileName, csvDelimiter, tableName) and supported types.

Implemented a built-in exporter in src/extensions/export/bootstrap-table-export.js that: - Supports types: json, xml, csv, txt, sql, and maps excel to CSV (.xls). - Preserves existing behaviors: fileName function support, footer export, column visibility (forceExport/forceHide), selected/all/basic export, and detail-view column exclusion via ignoreColumn. - Uses safe Blob download, avoiding deprecated/vulnerable plugin code. Contribution by Gittensor, learn more at https://gittensor.io/

marktech0813 · 2025-11-13T14:51:49Z

Please check PR.
thanks.

ajiho · 2025-11-15T13:19:30Z

That's awesome!

…ixin#8071 Refactor CSV escaping and table matrix collection logic for improved readability and null handling. - Using strict equality checks for null/undefined. - Adding required blank lines between declarations and control statements. - Removing unnecessary arrow parens and extra parentheses. - Using template literals instead of string concatenation. - Ensuring single quotes and proper brace style. - Splitting multi-statements onto separate lines.

marktech0813 · 2025-11-19T05:36:39Z

I fixed, Please check PR again,
thanks.

fsay2604 · 2025-12-10T18:16:52Z

Nice! Any idea when/if it will be merge?

MartinPerrie · 2026-02-02T11:43:24Z

Same question as @fsay2604 ! Any idea when this might be merged? I hit an issue with jQuery 4, where the the "trim" function has been removed. This function is used by tableexport.jquery.plugin - so the Export extension won't work with jQuery 4.

simonsolutions · 2026-02-17T13:17:55Z

+1 for review, this is a great change to not rely on external (and now deprecated) repos. Well done <3

wenzhixin · 2026-02-17T15:34:38Z

Okay, I will review and conduct test verification as soon as possible.

Copilot

Pull request overview

Replaces the deprecated tableExport.jquery.plugin dependency with a built-in export implementation in the export extension, and updates documentation/contribution guidance accordingly.

Changes:

Implemented built-in export generation + Blob download for json, xml, csv, txt, sql, and legacy excel (mapped to CSV content with .xls extension).
Updated export extension docs to remove the external plugin requirement and document built-in options/types.
Updated CONTRIBUTING dependency list to reflect the built-in exporter.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File	Description
src/extensions/export/bootstrap-table-export.js	Replaces plugin-based export with built-in content builders and a Blob-based download flow.
site/src/pages/docs/extensions/export.mdx	Updates docs to describe built-in exporter options and supported types.
CONTRIBUTING.md	Updates dependency documentation for the export extension.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-17T15:48:00Z

+    const csvEscape = (value, delimiter) => {
+      const d = delimiter || ','
+
+      if (value === null || value === undefined) return ''
+
+      const str = String(value)
+      const mustQuote = str.includes(d) || str.includes('"') || str.includes('\n') || str.includes('\r')
+


The added helper code introduces trailing whitespace on blank lines (e.g., around this block). ESLint is configured with no-trailing-spaces: 'error' (eslint.config.js:85), so this will fail lint. Please remove the trailing spaces (or run the project formatter/linter autofix) in the new code.

Copilot · 2026-02-17T15:48:00Z

+          const lines = ['<?xml version="1.0" encoding="UTF-8"?>', `<${tableName}>`]
+


tableName is interpolated directly as the XML root element name. If exportOptions.tableName contains spaces or other invalid XML name characters, the generated XML becomes invalid. Please sanitize/normalize tableName to a safe XML element name (and fall back to a default when it cannot be made valid).

Copilot · 2026-02-17T15:48:01Z

+            r.forEach((v, i) => {
+              const key = headerRow[i] || `col${i + 1}`
+              lines.push(`    <${key}>${esc(v)}</${key}>`)
+            })


XML element names are derived from header text (key = headerRow[i]). Header labels commonly contain spaces/special characters, which produces invalid XML tags like <First Name>. Please normalize header-derived keys into valid XML element names (e.g., replace invalid characters, ensure a valid starting character) and fall back to colN when needed.

Copilot · 2026-02-17T15:48:01Z

+          const values = rows.map(r => `(${r.map(v => {
+            if (v === null || v === undefined || v === '') return 'NULL'
+            const s = String(v).replace(/'/g, '\'\'' )
+            return `'${s}'`
+          }).join(', ')})`)
+
+          const sql = `INSERT INTO \`${tableName}\` (\`${cols.join('`, `')}\`) VALUES\n${values.join(',\n')};`


In the SQL export, tableName is used inside backticks without escaping backticks in the name, and when rows is empty the generated statement becomes VALUES\n; (invalid SQL). Please escape backticks in tableName similarly to column names, and handle the no-rows case by returning an empty string/file or a comment instead of an invalid INSERT.

Suggested change

const values = rows.map(r => `(${r.map(v => {

if (v === null || v === undefined || v === '') return 'NULL'

const s = String(v).replace(/'/g, '\'\'' )

return `'${s}'`

}).join(', ')})`)

const sql = `INSERT INTO \`${tableName}\` (\`${cols.join('`, `')}\`) VALUES\n${values.join(',\n')};`

// If there are no rows, avoid generating an invalid INSERT statement.

if (!rows.length) {

return { mime: 'application/sql;charset=utf-8', ext: 'sql', content: '' }

}

const values = rows.map(r => `(${r.map(v => {

if (v === null || v === undefined || v === '') return 'NULL'

const s = String(v).replace(/'/g, '\'\'' )

return `'${s}'`

}).join(', ')})`)

const safeTableName = String(tableName).replace(/`/g, '``')

const sql = `INSERT INTO \`${safeTableName}\` (\`${cols.join('`, `')}\`) VALUES\n${values.join(',\n')};`

Copilot · 2026-02-17T15:48:01Z

+      if (!built) {
+        // unsupported type without deprecated plugin; no-op but still restore state
+        onAfter()
+        return
+      }


When the export type is unsupported, doExport silently no-ops and restores state, but the caller still fires the export-saved event, which is misleading because no file was produced. Please have doExport return a success/failure flag (or throw/trigger an error event) so unsupported types can avoid emitting export-saved and optionally notify the user.

wenzhixin · 2026-05-01T17:20:53Z

Hi @marktech0813, thanks for working on this! Replacing the deprecated plugin with a built-in exporter is a much-needed change. I've reviewed the PR in detail and have some feedback:

Key Issues

1. Data collection via DOM parsing instead of data API

collectTableMatrix() reads table content from the DOM using $(td).text().trim(). This approach has several problems:

It only captures the display text, not the original data values (e.g., formatted numbers, dates get exported as display strings, not raw values)
It conflicts with the existing forceExport/forceHide logic — the code still calls showColumn/hideColumn to manipulate which columns are visible, but the actual data collection walks the DOM independently
It may produce inconsistent results depending on current sort/filter state

I'd recommend collecting export data from bootstrap-table's internal data model (getData(), getVisibleFields(), column definitions with field, formatter etc.) rather than scraping the rendered DOM.

2. Export type reduction is a breaking change

The plugin previously supported 10 types (json, xml, png, csv, txt, sql, doc, excel, xlsx, pdf). This PR reduces it to 6, dropping png, xlsx, pdf, doc, and powerpoint. For users who rely on PDF or Excel exports, this is a breaking change.

Would you consider keeping optional support for these types via lightweight libraries (e.g., SheetJS for xlsx, jsPDF for pdf)?

3. `excel` type is misleading

The excel type generates CSV content but uses a .xls extension. This causes Excel to show a format warning when opening the file. It's not a real Excel file — please consider being upfront about this in the docs, or use .csv extension instead.

Copilot Review Items (agreed)

The Copilot review raised valid points that should be addressed:

Trailing whitespace — ESLint will fail with no-trailing-spaces: 'error'
XML tag names from headers — Headers with spaces (e.g., "First Name") produce invalid XML tags like <First Name>. Header-derived tag names should be sanitized to valid XML element names, falling back to colN
tableName in XML root — Should be sanitized for valid XML element names
SQL export edge cases — tableName not escaped for backticks; empty rows produce invalid INSERT statement (VALUES\n;). Should return empty content when no rows exist
Unsupported types silently no-op — When an unsupported type is passed, export-saved event still fires even though no file was produced. Should return a flag or skip the event

Missing Updates

Chinese docs not updated — Only the English export.mdx was updated. site/src/pages/zh-cn/docs/extensions/export.mdx still references the old plugin
Cypress tests need rewriting — cypress/extensions/export/options.js (line 184-211) mocks $.fn.tableExport and asserts the plugin was called. These tests need to be updated to verify the built-in exporter behavior instead

Summary

The direction is right and this PR is much needed (especially for jQuery 4 compatibility). The main concern is the DOM-based data collection approach — switching to a data-API-driven approach would make the exporter more robust and consistent with the rest of bootstrap-table's architecture.

marktech0813 added 3 commits November 13, 2025 16:42

Update CONTRIBUTING.md

f3bc0b4

Updated CONTRIBUTING.md to reflect that Table Export is now built-in.

Update export.mdx

36f2377

Updated docs in site/src/pages/docs/extensions/export.mdx: - Removed plugin requirement. - Documented built-in options (fileName, csvDelimiter, tableName) and supported types.

marktech0813 marked this pull request as draft February 9, 2026 14:38

marktech0813 marked this pull request as ready for review February 9, 2026 14:38

wenzhixin requested a review from Copilot February 17, 2026 15:33

Copilot started reviewing on behalf of wenzhixin February 17, 2026 15:42 View session

Copilot AI reviewed Feb 17, 2026

View reviewed changes

wenzhixin mentioned this pull request Apr 11, 2026

Add export extension test HTML pages for Cypress tests wenzhixin/bootstrap-table-examples#574

Merged

		const lines = ['<?xml version="1.0" encoding="UTF-8"?>', `<${tableName}>`]

Uh oh!

Conversation

marktech0813 commented Nov 13, 2025

Uh oh!

marktech0813 commented Nov 13, 2025

Uh oh!

ajiho commented Nov 15, 2025

Uh oh!

marktech0813 commented Nov 19, 2025

Uh oh!

fsay2604 commented Dec 10, 2025

Uh oh!

MartinPerrie commented Feb 2, 2026

Uh oh!

simonsolutions commented Feb 17, 2026

Uh oh!

wenzhixin commented Feb 17, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

wenzhixin commented May 1, 2026

Key Issues

1. Data collection via DOM parsing instead of data API

2. Export type reduction is a breaking change

3. excel type is misleading

Copilot Review Items (agreed)

Missing Updates

Summary

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

3. `excel` type is misleading