Skip to contentSkip to content
🚀 Material UI and MUI X v9 are out! Check out the announcement blogpost.

ExportExcel API

API reference docs for the React ExportExcel component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import { ExportExcel } from '@mui/x-data-grid-premium/components';
// or
import { ExportExcel } from '@mui/x-data-grid-premium';

Learn about the difference by reading this guide on minimizing bundle size.



A button that triggers an Excel export. It renders the baseButton slot.

Props

If true, the button is disabled.

Type:bool

The id of the button element.

Type:string

The options to apply on the Excel export.

Type:{ allColumns?: bool, columnsStyles?: object, escapeFormulas?: bool, exceljsPostProcess?: func, exceljsPreProcess?: func, fields?: Array<string>, fileName?: string, getRowsToExport?: func, includeColumnGroupsHeaders?: bool, includeHeaders?: bool, valueOptionsSheetName?: string, worker?: func }

A function to customize rendering of the component.

Type:element
| func

The ARIA role of the button element.

Type:string

The size of the button.

Type:'large'
| 'medium'
| 'small'

Element placed before the children.

Type:node

The tabIndex of the button element.

Type:number

The title of the button element.

Type:string

The ref is forwarded to the root element.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.