@mui/material
Version:
Material UI is an open-source React component library that implements Google's Material Design. It's comprehensive and can be used in production out of the box.
512 lines (510 loc) • 19 kB
JavaScript
"use strict";
'use client';
var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _react = _interopRequireWildcard(require("react"));
var React = _react;
var _propTypes = _interopRequireDefault(require("prop-types"));
var _clsx = _interopRequireDefault(require("clsx"));
var _integerPropType = _interopRequireDefault(require("@mui/utils/integerPropType"));
var _chainPropTypes = _interopRequireDefault(require("@mui/utils/chainPropTypes"));
var _composeClasses = _interopRequireDefault(require("@mui/utils/composeClasses"));
var _zeroStyled = require("../zero-styled");
var _memoTheme = _interopRequireDefault(require("../utils/memoTheme"));
var _DefaultPropsProvider = require("../DefaultPropsProvider");
var _InputBase2 = _interopRequireDefault(require("../InputBase"));
var _MenuItem = _interopRequireDefault(require("../MenuItem"));
var _Select = _interopRequireDefault(require("../Select"));
var _TableCell = _interopRequireDefault(require("../TableCell"));
var _Toolbar = _interopRequireDefault(require("../Toolbar"));
var _TablePaginationActions = _interopRequireDefault(require("./TablePaginationActions"));
var _useId = _interopRequireDefault(require("../utils/useId"));
var _tablePaginationClasses = _interopRequireWildcard(require("./tablePaginationClasses"));
var _useSlot = _interopRequireDefault(require("../utils/useSlot"));
var _jsxRuntime = require("react/jsx-runtime");
var _InputBase;
const TablePaginationRoot = (0, _zeroStyled.styled)(_TableCell.default, {
name: 'MuiTablePagination',
slot: 'Root',
overridesResolver: (props, styles) => styles.root
})((0, _memoTheme.default)(({
theme
}) => ({
overflow: 'auto',
color: (theme.vars || theme).palette.text.primary,
fontSize: theme.typography.pxToRem(14),
// Increase the specificity to override TableCell.
'&:last-child': {
padding: 0
}
})));
const TablePaginationToolbar = (0, _zeroStyled.styled)(_Toolbar.default, {
name: 'MuiTablePagination',
slot: 'Toolbar',
overridesResolver: (props, styles) => ({
[`& .${_tablePaginationClasses.default.actions}`]: styles.actions,
...styles.toolbar
})
})((0, _memoTheme.default)(({
theme
}) => ({
minHeight: 52,
paddingRight: 2,
[`${theme.breakpoints.up('xs')} and (orientation: landscape)`]: {
minHeight: 52
},
[theme.breakpoints.up('sm')]: {
minHeight: 52,
paddingRight: 2
},
[`& .${_tablePaginationClasses.default.actions}`]: {
flexShrink: 0,
marginLeft: 20
}
})));
const TablePaginationSpacer = (0, _zeroStyled.styled)('div', {
name: 'MuiTablePagination',
slot: 'Spacer',
overridesResolver: (props, styles) => styles.spacer
})({
flex: '1 1 100%'
});
const TablePaginationSelectLabel = (0, _zeroStyled.styled)('p', {
name: 'MuiTablePagination',
slot: 'SelectLabel',
overridesResolver: (props, styles) => styles.selectLabel
})((0, _memoTheme.default)(({
theme
}) => ({
...theme.typography.body2,
flexShrink: 0
})));
const TablePaginationSelect = (0, _zeroStyled.styled)(_Select.default, {
name: 'MuiTablePagination',
slot: 'Select',
overridesResolver: (props, styles) => ({
[`& .${_tablePaginationClasses.default.selectIcon}`]: styles.selectIcon,
[`& .${_tablePaginationClasses.default.select}`]: styles.select,
...styles.input,
...styles.selectRoot
})
})({
color: 'inherit',
fontSize: 'inherit',
flexShrink: 0,
marginRight: 32,
marginLeft: 8,
[`& .${_tablePaginationClasses.default.select}`]: {
paddingLeft: 8,
paddingRight: 24,
textAlign: 'right',
textAlignLast: 'right' // Align <select> on Chrome.
}
});
const TablePaginationMenuItem = (0, _zeroStyled.styled)(_MenuItem.default, {
name: 'MuiTablePagination',
slot: 'MenuItem',
overridesResolver: (props, styles) => styles.menuItem
})({});
const TablePaginationDisplayedRows = (0, _zeroStyled.styled)('p', {
name: 'MuiTablePagination',
slot: 'DisplayedRows',
overridesResolver: (props, styles) => styles.displayedRows
})((0, _memoTheme.default)(({
theme
}) => ({
...theme.typography.body2,
flexShrink: 0
})));
function defaultLabelDisplayedRows({
from,
to,
count
}) {
return `${from}–${to} of ${count !== -1 ? count : `more than ${to}`}`;
}
function defaultGetAriaLabel(type) {
return `Go to ${type} page`;
}
const useUtilityClasses = ownerState => {
const {
classes
} = ownerState;
const slots = {
root: ['root'],
toolbar: ['toolbar'],
spacer: ['spacer'],
selectLabel: ['selectLabel'],
select: ['select'],
input: ['input'],
selectIcon: ['selectIcon'],
menuItem: ['menuItem'],
displayedRows: ['displayedRows'],
actions: ['actions']
};
return (0, _composeClasses.default)(slots, _tablePaginationClasses.getTablePaginationUtilityClass, classes);
};
/**
* A `TableCell` based component for placing inside `TableFooter` for pagination.
*/
const TablePagination = /*#__PURE__*/React.forwardRef(function TablePagination(inProps, ref) {
const props = (0, _DefaultPropsProvider.useDefaultProps)({
props: inProps,
name: 'MuiTablePagination'
});
const {
ActionsComponent = _TablePaginationActions.default,
backIconButtonProps,
colSpan: colSpanProp,
component = _TableCell.default,
count,
disabled = false,
getItemAriaLabel = defaultGetAriaLabel,
labelDisplayedRows = defaultLabelDisplayedRows,
labelRowsPerPage = 'Rows per page:',
nextIconButtonProps,
onPageChange,
onRowsPerPageChange,
page,
rowsPerPage,
rowsPerPageOptions = [10, 25, 50, 100],
SelectProps = {},
showFirstButton = false,
showLastButton = false,
slotProps = {},
slots = {},
...other
} = props;
const ownerState = props;
const classes = useUtilityClasses(ownerState);
const selectProps = slotProps?.select ?? SelectProps;
const MenuItemComponent = selectProps.native ? 'option' : TablePaginationMenuItem;
let colSpan;
if (component === _TableCell.default || component === 'td') {
colSpan = colSpanProp || 1000; // col-span over everything
}
const selectId = (0, _useId.default)(selectProps.id);
const labelId = (0, _useId.default)(selectProps.labelId);
const getLabelDisplayedRowsTo = () => {
if (count === -1) {
return (page + 1) * rowsPerPage;
}
return rowsPerPage === -1 ? count : Math.min(count, (page + 1) * rowsPerPage);
};
const externalForwardedProps = {
slots,
slotProps
};
const [RootSlot, rootSlotProps] = (0, _useSlot.default)('root', {
ref,
className: classes.root,
elementType: TablePaginationRoot,
externalForwardedProps: {
...externalForwardedProps,
component,
...other
},
ownerState,
additionalProps: {
colSpan
}
});
const [ToolbarSlot, toolbarSlotProps] = (0, _useSlot.default)('toolbar', {
className: classes.toolbar,
elementType: TablePaginationToolbar,
externalForwardedProps,
ownerState
});
const [SpacerSlot, spacerSlotProps] = (0, _useSlot.default)('spacer', {
className: classes.spacer,
elementType: TablePaginationSpacer,
externalForwardedProps,
ownerState
});
const [SelectLabelSlot, selectLabelSlotProps] = (0, _useSlot.default)('selectLabel', {
className: classes.selectLabel,
elementType: TablePaginationSelectLabel,
externalForwardedProps,
ownerState,
additionalProps: {
id: labelId
}
});
const [SelectSlot, selectSlotProps] = (0, _useSlot.default)('select', {
className: classes.select,
elementType: TablePaginationSelect,
externalForwardedProps,
ownerState
});
const [MenuItemSlot, menuItemSlotProps] = (0, _useSlot.default)('menuItem', {
className: classes.menuItem,
elementType: MenuItemComponent,
externalForwardedProps,
ownerState
});
const [DisplayedRows, displayedRowsProps] = (0, _useSlot.default)('displayedRows', {
className: classes.displayedRows,
elementType: TablePaginationDisplayedRows,
externalForwardedProps,
ownerState
});
return /*#__PURE__*/(0, _jsxRuntime.jsx)(RootSlot, {
...rootSlotProps,
children: /*#__PURE__*/(0, _jsxRuntime.jsxs)(ToolbarSlot, {
...toolbarSlotProps,
children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(SpacerSlot, {
...spacerSlotProps
}), rowsPerPageOptions.length > 1 && /*#__PURE__*/(0, _jsxRuntime.jsx)(SelectLabelSlot, {
...selectLabelSlotProps,
children: labelRowsPerPage
}), rowsPerPageOptions.length > 1 && /*#__PURE__*/(0, _jsxRuntime.jsx)(SelectSlot, {
variant: "standard",
...(!selectProps.variant && {
input: _InputBase || (_InputBase = /*#__PURE__*/(0, _jsxRuntime.jsx)(_InputBase2.default, {}))
}),
value: rowsPerPage,
onChange: onRowsPerPageChange,
id: selectId,
labelId: labelId,
...selectProps,
classes: {
...selectProps.classes,
// TODO v5 remove `classes.input`
root: (0, _clsx.default)(classes.input, classes.selectRoot, (selectProps.classes || {}).root),
select: (0, _clsx.default)(classes.select, (selectProps.classes || {}).select),
// TODO v5 remove `selectIcon`
icon: (0, _clsx.default)(classes.selectIcon, (selectProps.classes || {}).icon)
},
disabled: disabled,
...selectSlotProps,
children: rowsPerPageOptions.map(rowsPerPageOption => /*#__PURE__*/(0, _react.createElement)(MenuItemSlot, {
...menuItemSlotProps,
key: rowsPerPageOption.label ? rowsPerPageOption.label : rowsPerPageOption,
value: rowsPerPageOption.value ? rowsPerPageOption.value : rowsPerPageOption
}, rowsPerPageOption.label ? rowsPerPageOption.label : rowsPerPageOption))
}), /*#__PURE__*/(0, _jsxRuntime.jsx)(DisplayedRows, {
...displayedRowsProps,
children: labelDisplayedRows({
from: count === 0 ? 0 : page * rowsPerPage + 1,
to: getLabelDisplayedRowsTo(),
count: count === -1 ? -1 : count,
page
})
}), /*#__PURE__*/(0, _jsxRuntime.jsx)(ActionsComponent, {
className: classes.actions,
backIconButtonProps: backIconButtonProps,
count: count,
nextIconButtonProps: nextIconButtonProps,
onPageChange: onPageChange,
page: page,
rowsPerPage: rowsPerPage,
showFirstButton: showFirstButton,
showLastButton: showLastButton,
slotProps: slotProps.actions,
slots: slots.actions,
getItemAriaLabel: getItemAriaLabel,
disabled: disabled
})]
})
});
});
process.env.NODE_ENV !== "production" ? TablePagination.propTypes /* remove-proptypes */ = {
// ┌────────────────────────────── Warning ──────────────────────────────┐
// │ These PropTypes are generated from the TypeScript type definitions. │
// │ To update them, edit the d.ts file and run `pnpm proptypes`. │
// └─────────────────────────────────────────────────────────────────────┘
/**
* The component used for displaying the actions.
* Either a string to use a HTML element or a component.
* @default TablePaginationActions
*/
ActionsComponent: _propTypes.default.elementType,
/**
* Props applied to the back arrow [`IconButton`](https://mui.com/material-ui/api/icon-button/) component.
*
* This prop is an alias for `slotProps.actions.previousButton` and will be overriden by it if both are used.
* @deprecated Use `slotProps.actions.previousButton` instead.
*/
backIconButtonProps: _propTypes.default.object,
/**
* Override or extend the styles applied to the component.
*/
classes: _propTypes.default.object,
/**
* @ignore
*/
colSpan: _propTypes.default.number,
/**
* The component used for the root node.
* Either a string to use a HTML element or a component.
*/
component: _propTypes.default.elementType,
/**
* The total number of rows.
*
* To enable server side pagination for an unknown number of items, provide -1.
*/
count: _integerPropType.default.isRequired,
/**
* If `true`, the component is disabled.
* @default false
*/
disabled: _propTypes.default.bool,
/**
* Accepts a function which returns a string value that provides a user-friendly name for the current page.
* This is important for screen reader users.
*
* For localization purposes, you can use the provided [translations](https://mui.com/material-ui/guides/localization/).
* @param {string} type The link or button type to format ('first' | 'last' | 'next' | 'previous').
* @returns {string}
* @default function defaultGetAriaLabel(type) {
* return `Go to ${type} page`;
* }
*/
getItemAriaLabel: _propTypes.default.func,
/**
* Customize the displayed rows label. Invoked with a `{ from, to, count, page }`
* object.
*
* For localization purposes, you can use the provided [translations](https://mui.com/material-ui/guides/localization/).
* @default function defaultLabelDisplayedRows({ from, to, count }) {
* return `${from}–${to} of ${count !== -1 ? count : `more than ${to}`}`;
* }
*/
labelDisplayedRows: _propTypes.default.func,
/**
* Customize the rows per page label.
*
* For localization purposes, you can use the provided [translations](https://mui.com/material-ui/guides/localization/).
* @default 'Rows per page:'
*/
labelRowsPerPage: _propTypes.default.node,
/**
* Props applied to the next arrow [`IconButton`](https://mui.com/material-ui/api/icon-button/) element.
*
* This prop is an alias for `slotProps.actions.nextButton` and will be overriden by it if both are used.
* @deprecated Use `slotProps.actions.nextButton` instead.
*/
nextIconButtonProps: _propTypes.default.object,
/**
* Callback fired when the page is changed.
*
* @param {React.MouseEvent<HTMLButtonElement> | null} event The event source of the callback.
* @param {number} page The page selected.
*/
onPageChange: _propTypes.default.func.isRequired,
/**
* Callback fired when the number of rows per page is changed.
*
* @param {React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>} event The event source of the callback.
*/
onRowsPerPageChange: _propTypes.default.func,
/**
* The zero-based index of the current page.
*/
page: (0, _chainPropTypes.default)(_integerPropType.default.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('MUI: 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.
*
* Set -1 to display all the rows.
*/
rowsPerPage: _integerPropType.default.isRequired,
/**
* Customizes the options of the rows per page select field. If less than two options are
* available, no select field will be displayed.
* Use -1 for the value with a custom label to show all the rows.
* @default [10, 25, 50, 100]
*/
rowsPerPageOptions: _propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.shape({
label: _propTypes.default.string.isRequired,
value: _propTypes.default.number.isRequired
})]).isRequired),
/**
* Props applied to the rows per page [`Select`](https://mui.com/material-ui/api/select/) element.
*
* This prop is an alias for `slotProps.select` and will be overriden by it if both are used.
* @deprecated Use `slotProps.select` instead.
*
* @default {}
*/
SelectProps: _propTypes.default.object,
/**
* If `true`, show the first-page button.
* @default false
*/
showFirstButton: _propTypes.default.bool,
/**
* If `true`, show the last-page button.
* @default false
*/
showLastButton: _propTypes.default.bool,
/**
* The props used for each slot inside.
* @default {}
*/
slotProps: _propTypes.default.shape({
actions: _propTypes.default.shape({
firstButton: _propTypes.default.object,
firstButtonIcon: _propTypes.default.object,
lastButton: _propTypes.default.object,
lastButtonIcon: _propTypes.default.object,
nextButton: _propTypes.default.object,
nextButtonIcon: _propTypes.default.object,
previousButton: _propTypes.default.object,
previousButtonIcon: _propTypes.default.object
}),
displayedRows: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
menuItem: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
root: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
select: _propTypes.default.object,
selectLabel: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
spacer: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
toolbar: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object])
}),
/**
* The components used for each slot inside.
* @default {}
*/
slots: _propTypes.default.shape({
actions: _propTypes.default.shape({
firstButton: _propTypes.default.elementType,
firstButtonIcon: _propTypes.default.elementType,
lastButton: _propTypes.default.elementType,
lastButtonIcon: _propTypes.default.elementType,
nextButton: _propTypes.default.elementType,
nextButtonIcon: _propTypes.default.elementType,
previousButton: _propTypes.default.elementType,
previousButtonIcon: _propTypes.default.elementType
}),
displayedRows: _propTypes.default.elementType,
menuItem: _propTypes.default.elementType,
root: _propTypes.default.elementType,
select: _propTypes.default.elementType,
selectLabel: _propTypes.default.elementType,
spacer: _propTypes.default.elementType,
toolbar: _propTypes.default.elementType
}),
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object, _propTypes.default.bool])), _propTypes.default.func, _propTypes.default.object])
} : void 0;
var _default = exports.default = TablePagination;