Files F102030931

Pagination.js
No OneTemporary
Actions

Subscribers

None

File Metadata

Created: Sun, Feb 16, 09:38

Pagination.js
View Options

	import _extends from "@babel/runtime/helpers/esm/extends";
	import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
	const _excluded = ["boundaryCount", "className", "color", "count", "defaultPage", "disabled", "getItemAriaLabel", "hideNextButton", "hidePrevButton", "onChange", "page", "renderItem", "shape", "showFirstButton", "showLastButton", "siblingCount", "size", "variant"];
	import * as React from 'react';
	import PropTypes from 'prop-types';
	import clsx from 'clsx';
	import { unstable_composeClasses as composeClasses } from '@mui/base';
	import { integerPropType } from '@mui/utils';
	import useThemeProps from '../styles/useThemeProps';
	import { getPaginationUtilityClass } from './paginationClasses';
	import usePagination from '../usePagination';
	import PaginationItem from '../PaginationItem';
	import styled from '../styles/styled';
	import { jsx as _jsx } from "react/jsx-runtime";
	const useUtilityClasses = ownerState => {
	const {
	classes,
	variant
	} = ownerState;
	const slots = {
	root: ['root', variant],
	ul: ['ul']
	};
	return composeClasses(slots, getPaginationUtilityClass, classes);
	};
	const PaginationRoot = styled('nav', {
	name: 'MuiPagination',
	slot: 'Root',
	overridesResolver: (props, styles) => {
	const {
	ownerState
	} = props;
	return [styles.root, styles[ownerState.variant]];
	}
	})({});
	const PaginationUl = styled('ul', {
	name: 'MuiPagination',
	slot: 'Ul',
	overridesResolver: (props, styles) => styles.ul
	})({
	display: 'flex',
	flexWrap: 'wrap',
	alignItems: 'center',
	padding: 0,
	margin: 0,
	listStyle: 'none'
	});
	function defaultGetAriaLabel(type, page, selected) {
	if (type === 'page') {
	return `${selected ? '' : 'Go to '}page ${page}`;
	}
	return `Go to ${type} page`;
	}
	const Pagination = /#__PURE__/React.forwardRef(function Pagination(inProps, ref) {
	const props = useThemeProps({
	props: inProps,
	name: 'MuiPagination'
	});
	const {
	boundaryCount = 1,
	className,
	color = 'standard',
	count = 1,
	defaultPage = 1,
	disabled = false,
	getItemAriaLabel = defaultGetAriaLabel,
	hideNextButton = false,
	hidePrevButton = false,
	renderItem = item => /#__PURE__/_jsx(PaginationItem, _extends({}, item)),
	shape = 'circular',
	showFirstButton = false,
	showLastButton = false,
	siblingCount = 1,
	size = 'medium',
	variant = 'text'
	} = props,
	other = _objectWithoutPropertiesLoose(props, _excluded);
	const {
	items
	} = usePagination(_extends({}, props, {
	componentName: 'Pagination'
	}));
	const ownerState = _extends({}, props, {
	boundaryCount,
	color,
	count,
	defaultPage,
	disabled,
	getItemAriaLabel,
	hideNextButton,
	hidePrevButton,
	renderItem,
	shape,
	showFirstButton,
	showLastButton,
	siblingCount,
	size,
	variant
	});
	const classes = useUtilityClasses(ownerState);
	return /#__PURE__/_jsx(PaginationRoot, _extends({
	"aria-label": "pagination navigation",
	className: clsx(classes.root, className),
	ownerState: ownerState,
	ref: ref
	}, other, {
	children: /#__PURE__/_jsx(PaginationUl, {
	className: classes.ul,
	ownerState: ownerState,
	children: items.map((item, index) => /#__PURE__/_jsx("li", {
	children: renderItem(_extends({}, item, {
	color,
	'aria-label': getItemAriaLabel(item.type, item.page, item.selected),
	shape,
	size,
	variant
	}))
	}, index))
	})
	}));
	});

	// @default tags synced with default values from usePagination

	process.env.NODE_ENV !== "production" ? Pagination.propTypes /* remove-proptypes */ = {
	// ----------------------------- Warning --------------------------------
	// \| These PropTypes are generated from the TypeScript type definitions \|
	// \| To update them edit the d.ts file and run "yarn proptypes" \|
	// ----------------------------------------------------------------------
	/**
	* Number of always visible pages at the beginning and end.
	* @default 1
	*/
	boundaryCount: integerPropType,
	/**
	* Override or extend the styles applied to the component.
	*/
	classes: PropTypes.object,
	/**
	* @ignore
	*/
	className: PropTypes.string,
	/**
	* The active color.
	* It supports both default and custom theme colors, which can be added as shown in the
	* [palette customization guide](https://mui.com/material-ui/customization/palette/#adding-new-colors).
	* @default 'standard'
	*/
	color: PropTypes /* @typescript-to-proptypes-ignore */.oneOfType([PropTypes.oneOf(['primary', 'secondary', 'standard']), PropTypes.string]),
	/**
	* The total number of pages.
	* @default 1
	*/
	count: integerPropType,
	/**
	* The page selected by default when the component is uncontrolled.
	* @default 1
	*/
	defaultPage: integerPropType,
	/**
	* If `true`, the component is disabled.
	* @default false
	*/
	disabled: PropTypes.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](/material-ui/guides/localization/).
	* @param {string} type The link or button type to format ('page' \| 'first' \| 'last' \| 'next' \| 'previous'). Defaults to 'page'.
	* @param {number} page The page number to format.
	* @param {bool} selected If true, the current page is selected.
	* @returns {string}
	*/
	getItemAriaLabel: PropTypes.func,
	/**
	* If `true`, hide the next-page button.
	* @default false
	*/
	hideNextButton: PropTypes.bool,
	/**
	* If `true`, hide the previous-page button.
	* @default false
	*/
	hidePrevButton: PropTypes.bool,
	/**
	* Callback fired when the page is changed.
	*
	* @param {React.ChangeEvent<unknown>} event The event source of the callback.
	* @param {number} page The page selected.
	*/
	onChange: PropTypes.func,
	/**
	* The current page.
	*/
	page: integerPropType,
	/**
	* Render the item.
	* @param {PaginationRenderItemParams} params The props to spread on a PaginationItem.
	* @returns {ReactNode}
	* @default (item) => <PaginationItem {...item} />
	*/
	renderItem: PropTypes.func,
	/**
	* The shape of the pagination items.
	* @default 'circular'
	*/
	shape: PropTypes.oneOf(['circular', 'rounded']),
	/**
	* If `true`, show the first-page button.
	* @default false
	*/
	showFirstButton: PropTypes.bool,
	/**
	* If `true`, show the last-page button.
	* @default false
	*/
	showLastButton: PropTypes.bool,
	/**
	* Number of always visible pages before and after the current page.
	* @default 1
	*/
	siblingCount: integerPropType,
	/**
	* The size of the component.
	* @default 'medium'
	*/
	size: PropTypes /* @typescript-to-proptypes-ignore */.oneOfType([PropTypes.oneOf(['small', 'medium', 'large']), PropTypes.string]),
	/**
	* The system prop that allows defining system overrides as well as additional CSS styles.
	*/
	sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
	/**
	* The variant to use.
	* @default 'text'
	*/
	variant: PropTypes /* @typescript-to-proptypes-ignore */.oneOfType([PropTypes.oneOf(['outlined', 'text']), PropTypes.string])
	} : void 0;
	export default Pagination;

Event Timeline