Blame view

天文台pc/tianwentai-ui/node_modules/@mui/material/esm/Pagination/Pagination.d.ts 3.13 KB
bc518174   王天杨   提交两个项目文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
  import * as React from 'react';
  import { OverridableStringUnion } from '@mui/types';
  import { SxProps } from '@mui/system';
  import { Theme } from "../styles/index.js";
  import { InternalStandardProps as StandardProps } from "../internal/index.js";
  import { UsePaginationItem, UsePaginationProps } from "../usePagination/usePagination.js";
  import { PaginationClasses } from "./paginationClasses.js";
  export interface PaginationRenderItemParams extends UsePaginationItem {
    color: PaginationProps['color'];
    shape: PaginationProps['shape'];
    size: PaginationProps['size'];
    variant: PaginationProps['variant'];
  }
  export interface PaginationPropsVariantOverrides {}
  export interface PaginationPropsSizeOverrides {}
  export interface PaginationPropsColorOverrides {}
  export interface PaginationProps extends UsePaginationProps, StandardProps<React.HTMLAttributes<HTMLElement>, 'children' | 'onChange'> {
    /**
     * Override or extend the styles applied to the component.
     */
    classes?: Partial<PaginationClasses>;
    /**
     * 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/#custom-colors).
     * @default 'standard'
     */
    color?: OverridableStringUnion<'primary' | 'secondary' | 'standard', PaginationPropsColorOverrides>;
    /**
     * 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 ('page' | 'first' | 'last' | 'next' | 'previous' | 'start-ellipsis' | 'end-ellipsis'). Defaults to 'page'.
     * @param {number | null} page The page number to format.
     * @param {boolean} selected If true, the current page is selected.
     * @returns {string}
     */
    getItemAriaLabel?: (type: UsePaginationItem['type'], page: UsePaginationItem['page'], selected: UsePaginationItem['selected']) => string;
  
    /**
     * Render the item.
     * @param {PaginationRenderItemParams} params The props to spread on a PaginationItem.
     * @returns {ReactNode}
     * @default (item) => <PaginationItem {...item} />
     */
    renderItem?: (params: PaginationRenderItemParams) => React.ReactNode;
    /**
     * The shape of the pagination items.
     * @default 'circular'
     */
    shape?: 'circular' | 'rounded';
    /**
     * The size of the component.
     * @default 'medium'
     */
    size?: OverridableStringUnion<'small' | 'medium' | 'large', PaginationPropsSizeOverrides>;
    /**
     * The system prop that allows defining system overrides as well as additional CSS styles.
     */
    sx?: SxProps<Theme>;
    /**
     * The variant to use.
     * @default 'text'
     */
    variant?: OverridableStringUnion<'text' | 'outlined', PaginationPropsVariantOverrides>;
  }
  
  /**
   *
   * Demos:
   *
   * - [Pagination](https://mui.com/material-ui/react-pagination/)
   *
   * API:
   *
   * - [Pagination API](https://mui.com/material-ui/api/pagination/)
   */
  export default function Pagination(props: PaginationProps): React.JSX.Element;