ExportExcel API

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

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Data Grid - Export component

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.

Props

disabled

Type:bool

Type:string

material

Type:Partial

options

The options to apply on the Excel export.

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

render

A function to customize rendering of the component.

Type:ref

role

Type:string

size

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

startIcon

Type:node

style

Type:CSSProperties

tabIndex

Type:number

title

Type:string

touchRippleRef

Type:any

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.