import * as React from 'react'; import { ToggleTemplate, ToggleTemplateProps } from './ToggleTemplate'; import styles from '@breakaway/react-styles/css/components/Pagination/pagination'; import { css } from '@breakaway/react-styles'; import { fillTemplate } from '../../helpers'; import { Navigation } from './Navigation'; import { PaginationOptionsMenu } from './PaginationOptionsMenu'; import { getOUIAProps, OUIAProps, getDefaultOUIAId } from '../../helpers'; import widthChars from '@patternfly/react-tokens/dist/esm/c_pagination__nav_page_select_c_form_control_width_chars'; import { PickOptional } from '../../helpers'; export enum PaginationVariant { bottom = 'bottom', top = 'top' } const defaultPerPageOptions = [ { title: '10', value: 10 }, { title: '20', value: 20 }, { title: '50', value: 50 }, { title: '100', value: 100 } ]; /** Properties to customize the content and behavior of the pagination dropdown options. These * properties should be passed into the pagination component's perPageOptions property. */ export interface PerPageOptions { /** The text title of the option, which is rendered inside the pagination dropdown menu. */ title?: string; /** The value of the option, which determines how many items are displayed per page. */ value?: number; } /** Properties to customize various pagination titles. The following properties should be * passed into the pagination component's title property. */ export interface PaginationTitles { /** Accessible label for the input displaying the current page. */ currPage?: string; /** The type or title of the items being paginated. */ items?: string; /** The title of the pagination options menu. */ itemsPerPage?: string; /** Label for the English word "of". */ ofWord?: string; /** Accessible label for the options toggle. */ optionsToggle?: string; /** The title of a page displayed beside the page number. */ page?: string; /** The title of a page displayed beside the page number (plural form). */ pages?: string; /** Accessible label for the pagination component. */ paginationTitle?: string; /** The suffix to be displayed after each option on the options menu dropdown. */ perPageSuffix?: string; /** Accessible label for the button which moves to the first page. */ toFirstPage?: string; /** Accessible label for the button which moves to the last page. */ toLastPage?: string; /** Accessible label for the button which moves to the next page. */ toNextPage?: string; /** Accessible label for the button which moves to the previous page. */ toPreviousPage?: string; } export type OnSetPage = ( _evt: React.MouseEvent | React.KeyboardEvent | MouseEvent, newPage: number, perPage?: number, startIdx?: number, endIdx?: number ) => void; export type OnPerPageSelect = ( _evt: React.MouseEvent | React.KeyboardEvent | MouseEvent, newPerPage: number, newPage: number, startIdx?: number, endIdx?: number ) => void; /** The main pagination component. */ export interface PaginationProps extends React.HTMLProps, OUIAProps { /** What should be rendered inside the pagination. */ children?: React.ReactNode; /** Additional classes for the pagination container. */ className?: string; /** Indicate whether to show last full page of results when user selects perPage value * greater than remaining rows. */ defaultToFullPage?: boolean; /** Direction of dropdown context menu. */ dropDirection?: 'up' | 'down'; /** Page to start at. */ firstPage?: number; /** Flag indicating if pagination is compact. */ isCompact?: boolean; /** Flag indicating if pagination is disabled. */ isDisabled?: boolean; /** Flag indicating if pagination should not be sticky on mobile. */ isStatic?: boolean; /** Flag indicating if pagination should stick to its position (based on variant). */ isSticky?: boolean; /** Total number of items. */ itemCount?: number; /** Last index of items on current page. */ itemsEnd?: number; /** First index of items on current page. */ itemsStart?: number; /** Start index of rows to display, used in place of providing page. */ offset?: number; /** Current page number. */ page?: number; /** Number of items per page. */ perPage?: number; /** Component to be used for wrapping the toggle contents. Use "button" when you want * all of the toggle text to be clickable. */ perPageComponent?: 'div' | 'button'; /** Array of the number of items per page options. */ perPageOptions?: PerPageOptions[]; /** Function called when user clicks on navigate to first page. */ onFirstClick?: (event: React.SyntheticEvent, page: number) => void; /** Function called when user clicks on navigate to last page. */ onLastClick?: (event: React.SyntheticEvent, page: number) => void; /** Function called when user clicks on navigate to next page. */ onNextClick?: (event: React.SyntheticEvent, page: number) => void; /** Function called when user inputs page number. */ onPageInput?: (event: React.SyntheticEvent, page: number) => void; /** Function called when user selects number of items per page. */ onPerPageSelect?: OnPerPageSelect; /** Function called when user clicks on navigate to previous page. */ onPreviousClick?: (event: React.SyntheticEvent, page: number) => void; /** Function called when user sets page. */ onSetPage?: OnSetPage; /** Object with titles to display in pagination. */ titles?: PaginationTitles; /** This will be shown in pagination toggle span. You can use firstIndex, lastIndex, * itemCount, itemsTitle, and/or ofWord props. */ toggleTemplate?: ((props: ToggleTemplateProps) => React.ReactElement) | string; /** Position where pagination is rendered. */ variant?: 'top' | 'bottom' | PaginationVariant; /** Id to ideintify widget on page. */ widgetId?: string; /** Value to overwrite the randomly generated data-ouia-component-id.*/ ouiaId?: number | string; /** Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false. */ ouiaSafe?: boolean; } const handleInputWidth = (lastPage: number, node: HTMLDivElement) => { if (!node) { return; } const len = String(lastPage).length; if (len >= 3) { node.style.setProperty(widthChars.name, `${len}`); } else { node.style.setProperty(widthChars.name, '2'); } }; export class Pagination extends React.Component { static displayName = 'Pagination'; paginationRef = React.createRef(); static defaultProps: PickOptional = { children: null, className: '', variant: PaginationVariant.top, isDisabled: false, isCompact: false, isSticky: false, perPage: defaultPerPageOptions[0].value, titles: { items: '', page: '', pages: '', itemsPerPage: 'Items per page', perPageSuffix: 'per page', toFirstPage: 'Go to first page', toPreviousPage: 'Go to previous page', toLastPage: 'Go to last page', toNextPage: 'Go to next page', optionsToggle: '', currPage: 'Current page', paginationTitle: 'Pagination', ofWord: 'of' }, firstPage: 1, page: 0, offset: 0, defaultToFullPage: false, itemsStart: null, itemsEnd: null, perPageOptions: defaultPerPageOptions, widgetId: 'options-menu', onSetPage: () => undefined, onPerPageSelect: () => undefined, onFirstClick: () => undefined, onPreviousClick: () => undefined, onNextClick: () => undefined, onPageInput: () => undefined, onLastClick: () => undefined, ouiaSafe: true, perPageComponent: 'div' }; state = { ouiaStateId: getDefaultOUIAId(Pagination.displayName, this.props.variant) }; getLastPage() { const { itemCount, perPage, page } = this.props; // when itemCount is not known let's set lastPage as page+1 as we don't know the total count return itemCount || itemCount === 0 ? Math.ceil(itemCount / perPage) || 0 : page + 1; } componentDidMount() { const node = this.paginationRef.current; handleInputWidth(this.getLastPage(), node); } componentDidUpdate(prevProps: PaginationProps & OUIAProps) { const node = this.paginationRef.current; if (prevProps.perPage !== this.props.perPage || prevProps.itemCount !== this.props.itemCount) { handleInputWidth(this.getLastPage(), node); } } render() { const { children, className, variant, isDisabled, isCompact, isStatic, isSticky, perPage, titles, firstPage, page: propPage, offset, defaultToFullPage, itemCount, itemsStart, itemsEnd, perPageOptions, dropDirection: dropDirectionProp, widgetId, toggleTemplate, onSetPage, onPerPageSelect, onFirstClick, onPreviousClick, onNextClick, onPageInput, onLastClick, ouiaId, ouiaSafe, perPageComponent, ...props } = this.props; const dropDirection = dropDirectionProp || (variant === 'bottom' && !isStatic ? 'up' : 'down'); let page = propPage; if (!page && offset) { page = Math.ceil(offset / perPage); } if (page === 0 && !itemCount) { page = 1; } const lastPage = this.getLastPage(); let firstIndex = (page - 1) * perPage + 1; let lastIndex = page * perPage; if (itemCount || itemCount === 0) { firstIndex = itemCount <= 0 ? 0 : (page - 1) * perPage + 1; if (page < firstPage && itemCount > 0) { page = firstPage; } else if (page > lastPage) { page = lastPage; } if (itemCount >= 0) { lastIndex = page === lastPage || itemCount === 0 ? itemCount : page * perPage; } } const toggleTemplateProps = { firstIndex, lastIndex, itemCount, itemsTitle: titles.items, ofWord: titles.ofWord }; return (
{variant === PaginationVariant.top && (
{toggleTemplate && typeof toggleTemplate === 'string' && fillTemplate(toggleTemplate, toggleTemplateProps)} {toggleTemplate && typeof toggleTemplate !== 'string' && (toggleTemplate as (props: ToggleTemplateProps) => React.ReactElement)(toggleTemplateProps)} {!toggleTemplate && ( )}
)} {children}
); } }