TablePaginationActions.d.ts
3.34 KB
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
import * as React from 'react';
import { IconButtonProps } from "../IconButton/IconButton.js";
import { SvgIconProps } from "../SvgIcon/index.js";
export interface TablePaginationActionsProps extends React.HTMLAttributes<HTMLDivElement> {
/**
* This prop is an alias for `slotProps.previousButton` and will be overridden by it if both are used.
* @deprecated Use `slotProps.previousButton` instead.
*/
backIconButtonProps?: Partial<IconButtonProps>;
/**
* Override or extend the styles applied to the component.
*/
classes?: {};
className?: string;
count: number;
/**
* If `true`, the component is disabled.
* @default false
*/
disabled?: boolean;
/**
* 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}
*/
getItemAriaLabel: (type: 'first' | 'last' | 'next' | 'previous') => string;
/**
* This prop is an alias for `slotProps.nextButton` and will be overridden by it if both are used.
* @deprecated Use `slotProps.nextButton` instead.
*/
nextIconButtonProps?: Partial<IconButtonProps>;
onPageChange: (event: React.MouseEvent<HTMLButtonElement> | null, page: number) => void;
page: number;
rowsPerPage: number;
showFirstButton: boolean;
showLastButton: boolean;
slotProps?: {
firstButton?: Partial<IconButtonProps>;
lastButton?: Partial<IconButtonProps>;
nextButton?: Partial<IconButtonProps>;
previousButton?: Partial<IconButtonProps>;
firstButtonIcon?: Partial<SvgIconProps>;
lastButtonIcon?: Partial<SvgIconProps>;
nextButtonIcon?: Partial<SvgIconProps>;
previousButtonIcon?: Partial<SvgIconProps>;
};
slots?: TablePaginationActionsSlots;
}
export interface TablePaginationActionsSlots {
/**
* The component that renders the first button.
* @default IconButton
*/
firstButton?: React.ElementType;
/**
* The component that renders the last button.
* @default IconButton
*/
lastButton?: React.ElementType;
/**
* The component that renders the next button.
* @default IconButton
*/
nextButton?: React.ElementType;
/**
* The component that renders the previous button.
* @default IconButton
*/
previousButton?: React.ElementType;
/**
* The component that renders the first button icon.
* @default FirstPageIcon
*/
firstButtonIcon?: React.ElementType;
/**
* The component that renders the last button icon.
* @default LastPageIcon
*/
lastButtonIcon?: React.ElementType;
/**
* The component that renders the next button icon.
* @default KeyboardArrowRight
*/
nextButtonIcon?: React.ElementType;
/**
* The component that renders the previous button icon.
* @default KeyboardArrowLeft
*/
previousButtonIcon?: React.ElementType;
}
/**
*
* Demos:
*
* - [Pagination](https://mui.com/material-ui/react-pagination/)
*
* API:
*
* - [TablePaginationActions API](https://mui.com/material-ui/api/table-pagination-actions/)
*/
declare const TablePaginationActions: React.JSXElementConstructor<TablePaginationActionsProps>;
export default TablePaginationActions;