@mui/x-data-grid-premium
Version:
The Premium plan edition of the MUI X Data Grid Components.
139 lines (138 loc) • 5.81 kB
JavaScript
import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
const _excluded = ["worker", "exceljsPostProcess", "exceljsPreProcess", "columnsStyles", "includeHeaders", "getRowsToExport", "valueOptionsSheetName"];
import * as React from 'react';
import { useGridApiMethod, useGridLogger, useGridEventPriority } from '@mui/x-data-grid';
import { useGridRegisterPipeProcessor, exportAs, getColumnsToExport, defaultGetRowsToExport } from '@mui/x-data-grid/internals';
import { buildExcel, getDataForValueOptionsSheet, serializeColumns, serializeRowUnsafe } from "./serializer/excelSerializer.js";
import { GridExcelExportMenuItem } from "../../../components/index.js";
import { jsx as _jsx } from "react/jsx-runtime";
/**
* @requires useGridColumns (state)
* @requires useGridFilter (state)
* @requires useGridSorting (state)
* @requires useGridSelection (state)
* @requires useGridParamsApi (method)
*/
export const useGridExcelExport = (apiRef, props) => {
const logger = useGridLogger(apiRef, 'useGridExcelExport');
const getDataAsExcel = React.useCallback((options = {}) => {
logger.debug(`Get data as excel`);
const getRowsToExport = options.getRowsToExport ?? defaultGetRowsToExport;
const exportedRowIds = getRowsToExport({
apiRef
});
const exportedColumns = getColumnsToExport({
apiRef,
options
});
return buildExcel({
columns: exportedColumns,
rowIds: exportedRowIds,
includeHeaders: options.includeHeaders ?? true,
includeColumnGroupsHeaders: options.includeColumnGroupsHeaders ?? true,
valueOptionsSheetName: options?.valueOptionsSheetName || 'Options',
columnsStyles: options?.columnsStyles,
exceljsPreProcess: options?.exceljsPreProcess,
exceljsPostProcess: options?.exceljsPostProcess,
escapeFormulas: options.escapeFormulas ?? true
}, apiRef);
}, [logger, apiRef]);
const exportDataAsExcel = React.useCallback(async (options = {}) => {
const {
worker: workerFn,
exceljsPostProcess,
exceljsPreProcess,
getRowsToExport = defaultGetRowsToExport,
valueOptionsSheetName = 'Options'
} = options,
cloneableOptions = _objectWithoutPropertiesLoose(options, _excluded);
const sendExcelToUser = buffer => {
const blob = new Blob([buffer], {
type: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
});
exportAs(blob, 'xlsx', options?.fileName);
};
if (!workerFn) {
apiRef.current.publishEvent('excelExportStateChange', 'pending');
const workbook = await getDataAsExcel(options);
if (workbook === null) {
return;
}
const content = await workbook.xlsx.writeBuffer();
apiRef.current.publishEvent('excelExportStateChange', 'finished');
sendExcelToUser(content);
return;
}
if (process.env.NODE_ENV !== 'production') {
if (exceljsPostProcess) {
console.warn([`MUI X: The exceljsPostProcess option is not supported when a web worker is used.`, 'As alternative, pass the callback to the same option in setupExcelExportWebWorker.'].join('\n'));
}
if (exceljsPreProcess) {
console.warn([`MUI X: The exceljsPreProcess option is not supported when a web worker is used.`, 'As alternative, pass the callback to the same option in setupExcelExportWebWorker.'].join('\n'));
}
}
const worker = workerFn();
apiRef.current.publishEvent('excelExportStateChange', 'pending');
worker.onmessage = async event => {
sendExcelToUser(event.data);
apiRef.current.publishEvent('excelExportStateChange', 'finished');
worker.terminate();
};
const exportedRowIds = getRowsToExport({
apiRef
});
const exportedColumns = getColumnsToExport({
apiRef,
options
});
const valueOptionsData = await getDataForValueOptionsSheet(exportedColumns, valueOptionsSheetName, apiRef.current);
const serializedColumns = serializeColumns(exportedColumns, options.columnsStyles || {});
apiRef.current.resetColSpan();
const serializedRows = [];
for (let i = 0; i < exportedRowIds.length; i += 1) {
const id = exportedRowIds[i];
const serializedRow = serializeRowUnsafe(id, exportedColumns, apiRef, valueOptionsData, {
escapeFormulas: options.escapeFormulas ?? true
});
serializedRows.push(serializedRow);
}
apiRef.current.resetColSpan();
const columnGroupPaths = exportedColumns.reduce((acc, column) => {
acc[column.field] = apiRef.current.getColumnGroupPath(column.field);
return acc;
}, {});
const message = {
// workers share the pub-sub channel namespace. Use this property to filter out messages.
namespace: 'mui-x-data-grid-export',
serializedColumns,
serializedRows,
valueOptionsData,
columnGroupPaths,
columnGroupDetails: apiRef.current.getAllGroupDetails(),
options: cloneableOptions,
valueOptionsSheetName
};
worker.postMessage(message);
}, [apiRef, getDataAsExcel]);
const excelExportApi = {
getDataAsExcel,
exportDataAsExcel
};
useGridApiMethod(apiRef, excelExportApi, 'public');
/**
* PRE-PROCESSING
*/
const addExportMenuButtons = React.useCallback((initialValue, options) => {
if (options.excelOptions?.disableToolbarButton) {
return initialValue;
}
return [...initialValue, {
component: /*#__PURE__*/_jsx(GridExcelExportMenuItem, {
options: options.excelOptions
}),
componentName: 'excelExport'
}];
}, []);
useGridRegisterPipeProcessor(apiRef, 'exportMenu', addExportMenuButtons);
useGridEventPriority(apiRef, 'excelExportStateChange', props.onExcelExportStateChange);
};