1
0

index.tsx 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450
  1. /* eslint-disable max-len */
  2. import React from 'react';
  3. import classNames from 'classnames';
  4. import PropTypes from 'prop-types';
  5. import { FixedSizeList as List } from 'react-window';
  6. import { noop } from 'lodash-es';
  7. import PaginationFoundation, {
  8. AdapterPageList,
  9. KeyDownHandler,
  10. PageList, PaginationAdapter
  11. } from '@douyinfe/semi-foundation/pagination/foundation';
  12. import { cssClasses, numbers } from '@douyinfe/semi-foundation/pagination/constants';
  13. import '@douyinfe/semi-foundation/pagination/pagination.scss';
  14. import { numbers as popoverNumbers } from '@douyinfe/semi-foundation/popover/constants';
  15. import { IconChevronLeft, IconChevronRight } from '@douyinfe/semi-icons';
  16. import ConfigContext from '../configProvider/context';
  17. import LocaleConsumer from '../locale/localeConsumer';
  18. import { Locale } from '../locale/interface';
  19. import Select from '../select/index';
  20. import InputNumber from '../inputNumber/index';
  21. import BaseComponent from '../_base/baseComponent';
  22. import Popover from '../popover/index';
  23. import { Position } from '../tooltip';
  24. const prefixCls = cssClasses.PREFIX;
  25. const { Option } = Select;
  26. export interface PaginationProps {
  27. total?: number;
  28. showTotal?: boolean;
  29. pageSize?: number;
  30. pageSizeOpts?: Array<number>;
  31. size?: 'small' | 'default';
  32. currentPage?: number;
  33. defaultCurrentPage?: number;
  34. onPageChange?: (currentPage: number) => void;
  35. onPageSizeChange?: (newPageSize: number) => void;
  36. onChange?: (currentPage: number, pageSize: number) => void;
  37. prevText?: React.ReactNode;
  38. nextText?: React.ReactNode;
  39. showSizeChanger?: boolean;
  40. showQuickJumper?: boolean;
  41. popoverZIndex?: number;
  42. popoverPosition?: PopoverPosition;
  43. style?: React.CSSProperties;
  44. className?: string;
  45. hideOnSinglePage?: boolean;
  46. hoverShowPageSelect?: boolean;
  47. }
  48. export interface PaginationState {
  49. total: number;
  50. showTotal: boolean;
  51. currentPage: number;
  52. pageSize: number;
  53. pageList: PageList;
  54. prevDisabled: boolean;
  55. quickJumpPage: string | number;
  56. nextDisabled: boolean;
  57. restLeftPageList: number[];
  58. restRightPageList: number[];
  59. }
  60. export type PaginationLocale = Locale['Pagination'];
  61. export type PopoverPosition = Position;
  62. export { PageList };
  63. export default class Pagination extends BaseComponent<PaginationProps, PaginationState> {
  64. static contextType = ConfigContext;
  65. static propTypes = {
  66. total: PropTypes.number,
  67. showTotal: PropTypes.bool,
  68. pageSize: PropTypes.number,
  69. pageSizeOpts: PropTypes.array,
  70. size: PropTypes.string,
  71. currentPage: PropTypes.number,
  72. defaultCurrentPage: PropTypes.number,
  73. onPageChange: PropTypes.func,
  74. onPageSizeChange: PropTypes.func,
  75. onChange: PropTypes.func,
  76. prevText: PropTypes.node,
  77. nextText: PropTypes.node,
  78. showSizeChanger: PropTypes.bool,
  79. popoverZIndex: PropTypes.number,
  80. popoverPosition: PropTypes.string,
  81. style: PropTypes.object,
  82. className: PropTypes.string,
  83. hideOnSinglePage: PropTypes.bool,
  84. hoverShowPageSelect: PropTypes.bool,
  85. showQuickJumper: PropTypes.bool,
  86. };
  87. static defaultProps = {
  88. total: 1,
  89. popoverZIndex: popoverNumbers.DEFAULT_Z_INDEX,
  90. showTotal: false,
  91. pageSize: null as null,
  92. pageSizeOpts: numbers.PAGE_SIZE_OPTION,
  93. defaultCurrentPage: 1,
  94. size: 'default',
  95. onPageChange: noop,
  96. onPageSizeChange: noop,
  97. onChange: noop,
  98. showSizeChanger: false,
  99. className: '',
  100. hideOnSinglePage: false,
  101. showQuickJumper: false,
  102. };
  103. constructor(props: PaginationProps) {
  104. super(props);
  105. this.state = {
  106. total: props.total,
  107. showTotal: props.showTotal,
  108. currentPage: props.currentPage || props.defaultCurrentPage,
  109. pageSize: props.pageSize || props.pageSizeOpts[0] || numbers.DEFAULT_PAGE_SIZE, // Use pageSize first, use the first of pageSizeOpts when not, use the default value when none
  110. pageList: [],
  111. prevDisabled: false,
  112. nextDisabled: false,
  113. restLeftPageList: [],
  114. restRightPageList: [],
  115. quickJumpPage: '',
  116. };
  117. this.foundation = new PaginationFoundation(this.adapter);
  118. this.renderDefaultPage = this.renderDefaultPage.bind(this);
  119. this.renderSmallPage = this.renderSmallPage.bind(this);
  120. }
  121. get adapter(): PaginationAdapter<PaginationProps, PaginationState> {
  122. return {
  123. ...super.adapter,
  124. setPageList: (pageListState: AdapterPageList) => {
  125. const { pageList, restLeftPageList, restRightPageList } = pageListState;
  126. this.setState({ pageList, restLeftPageList, restRightPageList });
  127. },
  128. setDisabled: (prevIsDisabled: boolean, nextIsDisabled: boolean) => {
  129. this.setState({ prevDisabled: prevIsDisabled, nextDisabled: nextIsDisabled });
  130. },
  131. updateTotal: (total: number) => this.setState({ total }),
  132. updatePageSize: (pageSize: number) => this.setState({ pageSize }),
  133. updateQuickJumpPage: (quickJumpPage: string | number) => this.setState({ quickJumpPage }),
  134. // updateRestPageList: () => {},
  135. setCurrentPage: (pageIndex: number) => {
  136. this.setState({ currentPage: pageIndex });
  137. },
  138. registerKeyDownHandler: (handler: KeyDownHandler) => {
  139. document.addEventListener('keydown', handler);
  140. },
  141. unregisterKeyDownHandler: (handler: KeyDownHandler) => {
  142. document.removeEventListener('keydown', handler);
  143. },
  144. notifyPageChange: (pageIndex: number) => {
  145. this.props.onPageChange(pageIndex);
  146. },
  147. notifyPageSizeChange: (pageSize: number) => {
  148. this.props.onPageSizeChange(pageSize);
  149. },
  150. notifyChange: (pageIndex: number, pageSize: number) => {
  151. this.props.onChange(pageIndex, pageSize);
  152. }
  153. };
  154. }
  155. componentDidMount() {
  156. this.foundation.init();
  157. }
  158. componentWillUnmount() {
  159. this.foundation.destroy();
  160. }
  161. componentDidUpdate(prevProps: PaginationProps) {
  162. const pagerProps = {
  163. currentPage: this.props.currentPage,
  164. total: this.props.total,
  165. pageSize: this.props.pageSize,
  166. };
  167. let pagerHasChanged = false;
  168. if (prevProps.currentPage !== this.props.currentPage) {
  169. pagerHasChanged = true;
  170. // this.foundation.updatePage(this.props.currentPage);
  171. }
  172. if (prevProps.total !== this.props.total) {
  173. pagerHasChanged = true;
  174. }
  175. if (prevProps.pageSize !== this.props.pageSize) {
  176. pagerHasChanged = true;
  177. }
  178. if (pagerHasChanged) {
  179. this.foundation.updatePage(pagerProps.currentPage, pagerProps.total, pagerProps.pageSize);
  180. }
  181. }
  182. renderPrevBtn() {
  183. const { prevText } = this.props;
  184. const { prevDisabled } = this.state;
  185. const preClassName = classNames({
  186. [`${prefixCls}-item`]: true,
  187. [`${prefixCls}-prev`]: true,
  188. [`${prefixCls}-item-disabled`]: prevDisabled,
  189. });
  190. return (
  191. <li onClick={e => !prevDisabled && this.foundation.goPrev(e)} className={preClassName} tab-index={0}>
  192. {prevText || <IconChevronLeft size="large" />}
  193. </li>
  194. );
  195. }
  196. renderNextBtn() {
  197. const { nextText } = this.props;
  198. const { nextDisabled } = this.state;
  199. const nextClassName = classNames({
  200. [`${prefixCls}-item`]: true,
  201. [`${prefixCls}-item-disabled`]: nextDisabled,
  202. [`${prefixCls}-next`]: true,
  203. });
  204. return (
  205. <li onClick={e => !nextDisabled && this.foundation.goNext(e)} className={nextClassName} tab-index={0}>
  206. {nextText || <IconChevronRight size="large" />}
  207. </li>
  208. );
  209. }
  210. renderPageSizeSwitch(locale: PaginationLocale) {
  211. // rtl modify the default position
  212. const { direction } = this.context;
  213. const defaultPopoverPosition = direction === 'rtl' ? 'bottomRight' : 'bottomLeft';
  214. const { showSizeChanger, popoverPosition = defaultPopoverPosition } = this.props;
  215. const { pageSize } = this.state;
  216. const switchCls = classNames(`${prefixCls}-switch`);
  217. if (!showSizeChanger) {
  218. return null;
  219. }
  220. const pageSizeText = locale.pageSize;
  221. const newPageSizeOpts = this.foundation.pageSizeInOpts();
  222. const options = newPageSizeOpts.map((size: number) => (
  223. <Option value={size} key={size}>
  224. <span>
  225. {`${size} `}
  226. {pageSizeText}
  227. </span>
  228. </Option>
  229. ));
  230. return (
  231. <div className={switchCls}>
  232. <Select
  233. onChange={newPageSize => this.foundation.changePageSize(newPageSize)}
  234. value={pageSize}
  235. key={pageSizeText}
  236. position={popoverPosition || 'bottomRight'}
  237. clickToHide
  238. dropdownClassName={`${prefixCls}-select-dropdown`}
  239. >
  240. {options}
  241. </Select>
  242. </div>
  243. );
  244. }
  245. renderQuickJump(locale: PaginationLocale) {
  246. const { showQuickJumper } = this.props;
  247. const { quickJumpPage, total, pageSize } = this.state;
  248. if (!showQuickJumper) {
  249. return null;
  250. }
  251. const totalPageNum = this.foundation._getTotalPageNumber(total, pageSize);
  252. const isDisabled = totalPageNum === 1;
  253. const quickJumpCls = classNames({
  254. [`${prefixCls}-quickjump`]: true,
  255. [`${prefixCls}-quickjump-disabled`]: isDisabled
  256. });
  257. return (
  258. <div className={quickJumpCls}>
  259. <span>{locale.jumpTo}</span>
  260. <InputNumber
  261. value={quickJumpPage}
  262. className={`${prefixCls}-quickjump-input-number`}
  263. hideButtons
  264. disabled={isDisabled}
  265. onBlur={(e: React.MouseEvent) => this.foundation.handleQuickJumpBlur()}
  266. onEnterPress={(e: React.KeyboardEvent) => this.foundation.handleQuickJumpEnterPress((e.target as any).value)}
  267. onChange={(v: string | number) => this.foundation.handleQuickJumpNumberChange(v)}
  268. />
  269. <span>{locale.page}</span>
  270. </div>
  271. );
  272. }
  273. renderPageList() {
  274. const {
  275. pageList,
  276. currentPage,
  277. restLeftPageList,
  278. restRightPageList,
  279. } = this.state;
  280. const { popoverPosition, popoverZIndex } = this.props;
  281. return pageList.map((page, i) => {
  282. const pageListClassName = classNames(`${prefixCls}-item`, {
  283. [`${prefixCls}-item-active`]: currentPage === page,
  284. // [`${prefixCls}-item-rest-opening`]: (i < 3 && isLeftRestHover && page ==='...') || (i > 3 && isRightRestHover && page === '...')
  285. });
  286. const pageEl = (
  287. <li
  288. key={`${page}${i}`}
  289. onClick={() => this.foundation.goPage(page, i)}
  290. className={pageListClassName}
  291. tab-index={0}
  292. >
  293. {page}
  294. </li>
  295. );
  296. if (page === '...') {
  297. let content;
  298. i < 3 ? (content = restLeftPageList) : (content = restRightPageList);
  299. return (
  300. <Popover
  301. trigger="hover"
  302. // onVisibleChange={visible=>this.handleRestHover(visible, i < 3 ? 'left' : 'right')}
  303. content={this.renderRestPageList(content)}
  304. key={`${page}${i}`}
  305. position={popoverPosition}
  306. zIndex={popoverZIndex}
  307. >
  308. {pageEl}
  309. </Popover>
  310. );
  311. }
  312. return pageEl;
  313. });
  314. }
  315. renderRestPageList(restList: ('...' | number)[]) {
  316. // The number of pages may be tens of thousands, here is virtualized with the help of react-window
  317. const { direction } = this.context;
  318. const className = classNames(`${prefixCls}-rest-item`);
  319. const count = restList.length;
  320. const row = (item: { index: number; style: React.CSSProperties }) => {
  321. const { index, style } = item;
  322. const page = restList[index];
  323. return (
  324. <div
  325. key={`${page}${index}`}
  326. className={className}
  327. onClick={() => this.foundation.goPage(page, index)}
  328. style={style}
  329. >
  330. {page}
  331. </div>
  332. );
  333. };
  334. const itemHeight = 32;
  335. const listHeight = count >= 5 ? itemHeight * 5 : itemHeight * count;
  336. return (
  337. <List
  338. className={`${prefixCls}-rest-list`}
  339. itemData={restList}
  340. itemSize={itemHeight}
  341. width={78}
  342. itemCount={count}
  343. height={listHeight}
  344. style={{ direction }}
  345. >
  346. {row}
  347. </List>
  348. );
  349. }
  350. renderSmallPage(locale: PaginationLocale) {
  351. const { className, style, hideOnSinglePage, hoverShowPageSelect } = this.props;
  352. const paginationCls = classNames(`${prefixCls}-small`, prefixCls, className);
  353. const { currentPage, total, pageSize } = this.state;
  354. const totalPageNum = Math.ceil(total / pageSize);
  355. if (totalPageNum < 2 && hideOnSinglePage) {
  356. return null;
  357. }
  358. const pageNumbers = Array.from({ length: Math.ceil(total / pageSize) }, (v, i) => i + 1);
  359. const pageList = this.renderRestPageList(pageNumbers);
  360. const page = (<div className={`${prefixCls}-item ${prefixCls}-item-small`}>{currentPage}/{totalPageNum} </div>);
  361. return (
  362. <div className={paginationCls} style={style}>
  363. {this.renderPrevBtn()}
  364. {
  365. hoverShowPageSelect ? (
  366. <Popover
  367. content={pageList}
  368. >
  369. {page}
  370. </Popover>
  371. ) : page
  372. }
  373. {this.renderNextBtn()}
  374. {this.renderQuickJump(locale)}
  375. </div>
  376. );
  377. }
  378. renderDefaultPage(locale: PaginationLocale) {
  379. const { total, pageSize } = this.state;
  380. const { showTotal, className, style, hideOnSinglePage } = this.props;
  381. const paginationCls = classNames(className, `${prefixCls}`);
  382. const showTotalCls = `${prefixCls }-total`;
  383. const totalPageNum = Math.ceil(total / pageSize);
  384. if (totalPageNum < 2 && hideOnSinglePage) {
  385. return null;
  386. }
  387. return (
  388. <ul className={paginationCls} style={style}>
  389. {showTotal ? (
  390. <span className={showTotalCls}>
  391. {locale.total}
  392. {` ${Math.ceil(total / pageSize)} `}
  393. {locale.page}
  394. </span>
  395. ) : null}
  396. {this.renderPrevBtn()}
  397. {this.renderPageList()}
  398. {this.renderNextBtn()}
  399. {this.renderPageSizeSwitch(locale)}
  400. {this.renderQuickJump(locale)}
  401. </ul>
  402. );
  403. }
  404. render() {
  405. const { size } = this.props;
  406. return (
  407. <LocaleConsumer componentName="Pagination">
  408. {
  409. (locale: PaginationLocale) => (
  410. size === 'small' ? this.renderSmallPage(locale) : this.renderDefaultPage(locale)
  411. )
  412. }
  413. </LocaleConsumer>
  414. );
  415. }
  416. }