UNPKG

@material-ui/core

Version:

React components that implement Google's Material Design.

265 lines (233 loc) 7.41 kB
import _extends from "@babel/runtime/helpers/esm/extends"; import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose"; import React from 'react'; import PropTypes from 'prop-types'; import { chainPropTypes } from '@material-ui/utils'; import clsx from 'clsx'; 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'; export const styles = theme => ({ /* Styles applied to the root element. */ root: { color: theme.palette.text.secondary, fontSize: theme.typography.pxToRem(12), // Increase the specificity to override TableCell. '&:last-child': { padding: 0 } }, /* Styles applied to the Toolbar component. */ toolbar: { height: 56, minHeight: 56, 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 }, /* Styles applied to the Select component root element. */ selectRoot: { // `.selectRoot` should be merged with `.input` in v5. 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. }, /* Styles applied to the Select component `icon` class. */ selectIcon: { top: 1 }, /* 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}`; const defaultRowsPerPageOptions = [10, 25, 50, 100]; /** * A `TableCell` based component for placing inside `TableFooter` for pagination. */ const TablePagination = React.forwardRef(function TablePagination(props, ref) { const { ActionsComponent = TablePaginationActions, backIconButtonProps, classes, colSpan: colSpanProp, component: Component = TableCell, count, labelDisplayedRows = defaultLabelDisplayedRows, labelRowsPerPage = 'Rows per page:', nextIconButtonProps, onChangePage, onChangeRowsPerPage, page, rowsPerPage, rowsPerPageOptions = defaultRowsPerPageOptions, SelectProps = {} } = props, other = _objectWithoutPropertiesLoose(props, ["ActionsComponent", "backIconButtonProps", "classes", "colSpan", "component", "count", "labelDisplayedRows", "labelRowsPerPage", "nextIconButtonProps", "onChangePage", "onChangeRowsPerPage", "page", "rowsPerPage", "rowsPerPageOptions", "SelectProps"]); let colSpan; if (Component === TableCell || Component === 'td') { colSpan = colSpanProp || 1000; // col-span over everything } const MenuItemComponent = SelectProps.native ? 'option' : MenuItem; return React.createElement(Component, _extends({ className: classes.root, colSpan: colSpan, ref: ref }, other), React.createElement(Toolbar, { className: classes.toolbar }, React.createElement("div", { className: classes.spacer }), rowsPerPageOptions.length > 1 && React.createElement(Typography, { color: "inherit", variant: "caption", className: classes.caption }, labelRowsPerPage), rowsPerPageOptions.length > 1 && React.createElement(Select, _extends({ classes: { select: classes.select, icon: classes.selectIcon }, input: React.createElement(InputBase, { className: clsx(classes.input, classes.selectRoot) }), value: rowsPerPage, onChange: onChangeRowsPerPage }, SelectProps), rowsPerPageOptions.map(rowsPerPageOption => React.createElement(MenuItemComponent, { className: classes.menuItem, key: rowsPerPageOption, value: rowsPerPageOption }, rowsPerPageOption))), React.createElement(Typography, { color: "inherit", variant: "caption", className: classes.caption }, labelDisplayedRows({ from: count === 0 ? 0 : page * rowsPerPage + 1, to: Math.min(count, (page + 1) * rowsPerPage), count, page })), React.createElement(ActionsComponent, { className: classes.actions, backIconButtonProps: backIconButtonProps, count: count, nextIconButtonProps: nextIconButtonProps, onChangePage: onChangePage, page: page, rowsPerPage: rowsPerPage }))); }); process.env.NODE_ENV !== "production" ? TablePagination.propTypes = { /** * The component used for displaying the actions. * Either a string to use a DOM element or a component. */ ActionsComponent: PropTypes.elementType, /** * Props applied to the back arrow [`IconButton`](/api/icon-button/) component. */ backIconButtonProps: PropTypes.object, /** * Override or extend the styles applied to the component. * See [CSS API](#css) below for more details. */ classes: PropTypes.object.isRequired, /** * @ignore */ colSpan: PropTypes.number, /** * The component used for the root node. * Either a string to use a DOM element or a component. */ component: PropTypes.elementType, /** * The total number of rows. */ count: PropTypes.number.isRequired, /** * Customize the displayed rows label. */ labelDisplayedRows: PropTypes.func, /** * Customize the rows per page label. Invoked with a `{ from, to, count, page }` * object. */ labelRowsPerPage: PropTypes.node, /** * Props applied to the next arrow [`IconButton`](/api/icon-button/) element. */ nextIconButtonProps: PropTypes.object, /** * Callback fired when the page is changed. * * @param {object} event The event source of the callback * @param {number} page The page selected */ onChangePage: PropTypes.func.isRequired, /** * Callback fired when the number of rows per page is changed. * * @param {object} event The event source of the callback */ onChangeRowsPerPage: PropTypes.func, /** * The zero-based index of the current page. */ page: chainPropTypes(PropTypes.number.isRequired, props => { const { count, page, rowsPerPage } = props; 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);