@dslab/ra-export-all-button NPM

React-Admin Export All Button

The Export All Button for React-Admin exports the current list with filters, sorting, and pagination settings applied.

Install

yarn install @dslab/ra-export-all-button

Usage

import { ExportAllButton } from '@dslab/ra-export-all-button';

const ListActions = () => (
    <TopToolbar>
        <ExportAllButton />
    </TopToolbar>
);

export const List = () => <List actions={<ListActions />}></List>;

Props

The button accepts the following props:

Prop	Required	Type	Default	Description
`maxResults`	Optional	`number`	10000	Maximum number of records to export
`perPage`	Optional	`number`	perPage of the list	Number of records in each request
`label`	Optional	`string`	'ra.action.export'	Label or translation message to use
`icon`	Optional	`ReactElement`	`<DownloadIcon>`	iconElement, e.g. `<CommentIcon />`
`exporter`	Optional	`Function`	-	Override the List exporter function
`meta`	Optional	`any`	undefined	Metadata passed to the dataProvider

Author

SmartCommunityLab React-admin

Website: http://www.smartcommunitylab.it/
Github: @smartcommunitylab

Show your support

Give a ⭐️ if this project helped you!

License

@everything-registry/sub-chunk-258

1.0.1

6 months ago

1.0.0

6 months ago