React Common - Utils - pdfExporter

An object that serves as a namespace for the methods that export DevExtreme UI components to PDF.

exportDataGrid(options) CTP

Exports grid data to a PDF file.

import { exportDataGrid } from "devextreme/pdf_exporter"
Parameters:

Export settings.

Return Value:

Promise<void> (jQuery or native)

A Promise that is resolved when the grid data is prepared for export. It is a native Promise or a jQuery.Promise when you use jQuery.

NOTE
This functionality is available as a community technology preview (CTP). Should you have any questions or suggestions prior to its official release, please create a new ticket in the DevExpress Support Center.

This method requires the jsPDF library to export data and the jsPDF-AutoTable plugin to create tables in exported files.

You can call this method at any point in your application. In this example, we call this method in a standalone button's onClick handler:

Installation command
App.js
  • npm install jspdf jspdf-autotable
  • import React from 'react';
  • import 'devextreme/dist/css/dx.light.css';
  •  
  • import DataGrid from 'devextreme-react/data-grid';
  • import Button from 'devextreme-react/button';
  • import { jsPDF } from 'jspdf';
  • import 'jspdf-autotable';
  • import { exportDataGrid as exportDataGridToPdf } from 'devextreme/pdf_exporter';
  •  
  • export default function App() {
  • const dataGridRef = useRef(null);
  •  
  • function exportGrid() {
  • const doc = new jsPDF();
  • const dataGrid = dataGridRef.current.instance;
  •  
  • exportDataGridToPdf({
  • jsPDFDocument: doc,
  • component: dataGrid
  • }).then(() => {
  • doc.save('Customers.pdf');
  • });
  • }
  •  
  • return (
  • <React.Fragment>
  • <div>
  • <Button ...
  • onClick={exportGrid}
  • />
  • <DataGrid ...
  • ref={dataGridRef}
  • >
  • {/* ... */}
  • </DataGrid>
  • </div>
  • </React.Fragment>
  • );
  • }

View Demo