@material-ui/core
Version:
React components that implement Google's Material Design.
333 lines (294 loc) • 10.1 kB
JavaScript
import _extends from "@babel/runtime/helpers/esm/extends";
import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
import * as React from 'react';
import PropTypes from 'prop-types';
import { chainPropTypes } from '@material-ui/utils';
import clsx from 'clsx';
import deprecatedPropType from '../utils/deprecatedPropType';
import withStyles from '../styles/withStyles';
import InputBase from '../InputBase';
import MenuItem from '../MenuItem';
import Select from '../Select';
import TableCell from '../TableCell';
import Toolbar from '../Toolbar';
import Typography from '../Typography';
import TablePaginationActions from './TablePaginationActions';
import useId from '../utils/unstable_useId';
export const styles = theme => ({
/* Styles applied to the root element. */
root: {
color: theme.palette.text.primary,
fontSize: theme.typography.pxToRem(14),
overflow: 'auto',
// Increase the specificity to override TableCell.
'&:last-child': {
padding: 0
}
},
/* Styles applied to the Toolbar component. */
toolbar: {
minHeight: 52,
paddingRight: 2
},
/* Styles applied to the spacer element. */
spacer: {
flex: '1 1 100%'
},
/* Styles applied to the caption Typography components if `variant="caption"`. */
caption: {
flexShrink: 0
},
// TODO v5: `.selectRoot` should be merged with `.input`
/* Styles applied to the Select component root element. */
selectRoot: {
marginRight: 32,
marginLeft: 8
},
/* Styles applied to the Select component `select` class. */
select: {
paddingLeft: 8,
paddingRight: 24,
textAlign: 'right',
textAlignLast: 'right' // Align <select> on Chrome.
},
// TODO v5: remove
/* Styles applied to the Select component `icon` class. */
selectIcon: {},
/* Styles applied to the `InputBase` component. */
input: {
color: 'inherit',
fontSize: 'inherit',
flexShrink: 0
},
/* Styles applied to the MenuItem component. */
menuItem: {},
/* Styles applied to the internal `TablePaginationActions` component. */
actions: {
flexShrink: 0,
marginLeft: 20
}
});
const defaultLabelDisplayedRows = ({
from,
to,
count
}) => `${from}-${to} of ${count !== -1 ? count : `more than ${to}`}`;
const defaultRowsPerPageOptions = [10, 25, 50, 100];
/**
* A `TableCell` based component for placing inside `TableFooter` for pagination.
*/
const TablePagination = /*#__PURE__*/React.forwardRef(function TablePagination(props, ref) {
const {
ActionsComponent = TablePaginationActions,
backIconButtonProps,
backIconButtonText = 'Previous page',
classes,
className,
colSpan: colSpanProp,
component: Component = TableCell,
count,
labelDisplayedRows = defaultLabelDisplayedRows,
labelRowsPerPage = 'Rows per page:',
nextIconButtonProps,
nextIconButtonText = 'Next page',
onChangePage,
onPageChange,
onChangeRowsPerPage: onChangeRowsPerPageProp,
onRowsPerPageChange: onRowsPerPageChangeProp,
page,
rowsPerPage,
rowsPerPageOptions = defaultRowsPerPageOptions,
SelectProps = {}
} = props,
other = _objectWithoutPropertiesLoose(props, ["ActionsComponent", "backIconButtonProps", "backIconButtonText", "classes", "className", "colSpan", "component", "count", "labelDisplayedRows", "labelRowsPerPage", "nextIconButtonProps", "nextIconButtonText", "onChangePage", "onPageChange", "onChangeRowsPerPage", "onRowsPerPageChange", "page", "rowsPerPage", "rowsPerPageOptions", "SelectProps"]);
const onChangeRowsPerPage = onChangeRowsPerPageProp || onRowsPerPageChangeProp;
let colSpan;
if (Component === TableCell || Component === 'td') {
colSpan = colSpanProp || 1000; // col-span over everything
}
const selectId = useId();
const labelId = useId();
const MenuItemComponent = SelectProps.native ? 'option' : MenuItem;
return /*#__PURE__*/React.createElement(Component, _extends({
className: clsx(classes.root, className),
colSpan: colSpan,
ref: ref
}, other), /*#__PURE__*/React.createElement(Toolbar, {
className: classes.toolbar
}, /*#__PURE__*/React.createElement("div", {
className: classes.spacer
}), rowsPerPageOptions.length > 1 && /*#__PURE__*/React.createElement(Typography, {
color: "inherit",
variant: "body2",
className: classes.caption,
id: labelId
}, labelRowsPerPage), rowsPerPageOptions.length > 1 && /*#__PURE__*/React.createElement(Select, _extends({
classes: {
select: classes.select,
icon: classes.selectIcon
},
input: /*#__PURE__*/React.createElement(InputBase, {
className: clsx(classes.input, classes.selectRoot)
}),
value: rowsPerPage,
onChange: onChangeRowsPerPage,
id: selectId,
labelId: labelId
}, SelectProps), rowsPerPageOptions.map(rowsPerPageOption => /*#__PURE__*/React.createElement(MenuItemComponent, {
className: classes.menuItem,
key: rowsPerPageOption.value ? rowsPerPageOption.value : rowsPerPageOption,
value: rowsPerPageOption.value ? rowsPerPageOption.value : rowsPerPageOption
}, rowsPerPageOption.label ? rowsPerPageOption.label : rowsPerPageOption))), /*#__PURE__*/React.createElement(Typography, {
color: "inherit",
variant: "body2",
className: classes.caption
}, labelDisplayedRows({
from: count === 0 ? 0 : page * rowsPerPage + 1,
to: count !== -1 ? Math.min(count, (page + 1) * rowsPerPage) : (page + 1) * rowsPerPage,
count: count === -1 ? -1 : count,
page
})), /*#__PURE__*/React.createElement(ActionsComponent, {
className: classes.actions,
backIconButtonProps: _extends({
title: backIconButtonText,
'aria-label': backIconButtonText
}, backIconButtonProps),
count: count,
nextIconButtonProps: _extends({
title: nextIconButtonText,
'aria-label': nextIconButtonText
}, nextIconButtonProps),
onChangePage: onChangePage,
onPageChange: onPageChange,
page: page,
rowsPerPage: rowsPerPage
})));
});
process.env.NODE_ENV !== "production" ? TablePagination.propTypes = {
/**
* The component used for displaying the actions.
* Either a string to use a HTML element or a component.
*/
ActionsComponent: PropTypes.elementType,
/**
* Props applied to the back arrow [`IconButton`](/api/icon-button/) component.
*/
backIconButtonProps: PropTypes.object,
/**
* Text label for the back arrow icon button.
*
* For localization purposes, you can use the provided [translations](/guides/localization/).
*/
backIconButtonText: PropTypes.string,
/**
* Override or extend the styles applied to the component.
* See [CSS API](#css) below for more details.
*/
classes: PropTypes.object.isRequired,
/**
* @ignore
*/
className: PropTypes.string,
/**
* @ignore
*/
colSpan: PropTypes.number,
/**
* The component used for the root node.
* Either a string to use a HTML element or a component.
*/
component: PropTypes
/* @typescript-to-proptypes-ignore */
.elementType,
/**
* The total number of rows.
*
* To enable server side pagination for an unknown number of items, provide -1.
*/
count: PropTypes.number.isRequired,
/**
* Customize the displayed rows label. Invoked with a `{ from, to, count, page }`
* object.
*
* For localization purposes, you can use the provided [translations](/guides/localization/).
*/
labelDisplayedRows: PropTypes.func,
/**
* Customize the rows per page label.
*
* For localization purposes, you can use the provided [translations](/guides/localization/).
*/
labelRowsPerPage: PropTypes.node,
/**
* Props applied to the next arrow [`IconButton`](/api/icon-button/) element.
*/
nextIconButtonProps: PropTypes.object,
/**
* Text label for the next arrow icon button.
*
* For localization purposes, you can use the provided [translations](/guides/localization/).
*/
nextIconButtonText: PropTypes.string,
/**
* Callback fired when the page is changed.
*
* @param {object} event The event source of the callback.
* @param {number} page The page selected.
* @deprecated Use the onPageChange prop instead.
*/
onChangePage: deprecatedPropType(PropTypes.func, 'Use the `onPageChange` prop instead.'),
/**
* Callback fired when the number of rows per page is changed.
*
* @param {object} event The event source of the callback.
* @deprecated Use the onRowsPerPageChange prop instead.
*/
onChangeRowsPerPage: deprecatedPropType(PropTypes.func, 'Use the `onRowsPerPageChange` prop instead.'),
/**
* Callback fired when the page is changed.
*
* @param {object} event The event source of the callback.
* @param {number} page The page selected.
*/
onPageChange: PropTypes.func.isRequired,
/**
* Callback fired when the number of rows per page is changed.
*
* @param {object} event The event source of the callback.
*/
onRowsPerPageChange: PropTypes.func,
/**
* The zero-based index of the current page.
*/
page: chainPropTypes(PropTypes.number.isRequired, props => {
const {
count,
page,
rowsPerPage
} = props;
if (count === -1) {
return null;
}
const newLastPage = Math.max(0, Math.ceil(count / rowsPerPage) - 1);
if (page < 0 || page > newLastPage) {
return new Error('Material-UI: The page prop of a TablePagination is out of range ' + `(0 to ${newLastPage}, but page is ${page}).`);
}
return null;
}),
/**
* The number of rows per page.
*/
rowsPerPage: PropTypes.number.isRequired,
/**
* Customizes the options of the rows per page select field. If less than two options are
* available, no select field will be displayed.
*/
rowsPerPageOptions: PropTypes.array,
/**
* Props applied to the rows per page [`Select`](/api/select/) element.
*/
SelectProps: PropTypes.object
} : void 0;
export default withStyles(styles, {
name: 'MuiTablePagination'
})(TablePagination);