paradiego
This commit is contained in:
188
node_modules/@mui/material/TablePagination/TablePagination.d.ts
generated
vendored
Normal file
188
node_modules/@mui/material/TablePagination/TablePagination.d.ts
generated
vendored
Normal file
@@ -0,0 +1,188 @@
|
||||
import * as React from 'react';
|
||||
import { SxProps } from '@mui/system';
|
||||
import { Theme } from '../styles';
|
||||
import { OverridableComponent, OverrideProps } from '../OverridableComponent';
|
||||
import { TablePaginationActionsProps } from './TablePaginationActions';
|
||||
import { TableCellProps } from '../TableCell';
|
||||
import { IconButtonProps } from '../IconButton';
|
||||
import { SelectProps } from '../Select';
|
||||
import { TablePaginationClasses } from './tablePaginationClasses';
|
||||
|
||||
export interface LabelDisplayedRowsArgs {
|
||||
from: number;
|
||||
to: number;
|
||||
count: number;
|
||||
page: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* This type is kept for compatibility. Use `TablePaginationOwnProps` instead.
|
||||
*/
|
||||
export type TablePaginationBaseProps = Omit<TableCellProps, 'classes' | 'component' | 'children'>;
|
||||
|
||||
export interface TablePaginationOwnProps extends TablePaginationBaseProps {
|
||||
/**
|
||||
* The component used for displaying the actions.
|
||||
* Either a string to use a HTML element or a component.
|
||||
* @default TablePaginationActions
|
||||
*/
|
||||
ActionsComponent?: React.ElementType<TablePaginationActionsProps>;
|
||||
/**
|
||||
* Props applied to the back arrow [`IconButton`](https://mui.com/material-ui/api/icon-button/) component.
|
||||
*
|
||||
* This prop is an alias for `slotProps.actions.previousButton` and will be overriden by it if both are used.
|
||||
* @deprecated Use `slotProps.actions.previousButton` instead.
|
||||
*/
|
||||
backIconButtonProps?: Partial<IconButtonProps>;
|
||||
/**
|
||||
* Override or extend the styles applied to the component.
|
||||
*/
|
||||
classes?: Partial<TablePaginationClasses>;
|
||||
/**
|
||||
* The total number of rows.
|
||||
*
|
||||
* To enable server side pagination for an unknown number of items, provide -1.
|
||||
*/
|
||||
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}
|
||||
* @default function defaultGetAriaLabel(type) {
|
||||
* return `Go to ${type} page`;
|
||||
* }
|
||||
*/
|
||||
getItemAriaLabel?: (type: 'first' | 'last' | 'next' | 'previous') => string;
|
||||
/**
|
||||
* Customize the displayed rows label. Invoked with a `{ from, to, count, page }`
|
||||
* object.
|
||||
*
|
||||
* For localization purposes, you can use the provided [translations](https://mui.com/material-ui/guides/localization/).
|
||||
* @default function defaultLabelDisplayedRows({ from, to, count }) {
|
||||
* return `${from}–${to} of ${count !== -1 ? count : `more than ${to}`}`;
|
||||
* }
|
||||
*/
|
||||
labelDisplayedRows?: (paginationInfo: LabelDisplayedRowsArgs) => React.ReactNode;
|
||||
/**
|
||||
* Customize the rows per page label.
|
||||
*
|
||||
* For localization purposes, you can use the provided [translations](https://mui.com/material-ui/guides/localization/).
|
||||
* @default 'Rows per page:'
|
||||
*/
|
||||
labelRowsPerPage?: React.ReactNode;
|
||||
/**
|
||||
* Props applied to the next arrow [`IconButton`](https://mui.com/material-ui/api/icon-button/) element.
|
||||
*
|
||||
* This prop is an alias for `slotProps.actions.nextButton` and will be overriden by it if both are used.
|
||||
* @deprecated Use `slotProps.actions.nextButton` instead.
|
||||
*/
|
||||
nextIconButtonProps?: Partial<IconButtonProps>;
|
||||
/**
|
||||
* Callback fired when the page is changed.
|
||||
*
|
||||
* @param {React.MouseEvent<HTMLButtonElement> | null} event The event source of the callback.
|
||||
* @param {number} page The page selected.
|
||||
*/
|
||||
onPageChange: (event: React.MouseEvent<HTMLButtonElement> | null, page: number) => void;
|
||||
/**
|
||||
* Callback fired when the number of rows per page is changed.
|
||||
*
|
||||
* @param {React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>} event The event source of the callback.
|
||||
*/
|
||||
onRowsPerPageChange?: React.ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement>;
|
||||
/**
|
||||
* The zero-based index of the current page.
|
||||
*/
|
||||
page: number;
|
||||
/**
|
||||
* The number of rows per page.
|
||||
*
|
||||
* Set -1 to display all the rows.
|
||||
*/
|
||||
rowsPerPage: number;
|
||||
/**
|
||||
* Customizes the options of the rows per page select field. If less than two options are
|
||||
* available, no select field will be displayed.
|
||||
* Use -1 for the value with a custom label to show all the rows.
|
||||
* @default [10, 25, 50, 100]
|
||||
*/
|
||||
rowsPerPageOptions?: ReadonlyArray<number | { value: number; label: string }>;
|
||||
/**
|
||||
* Props applied to the rows per page [`Select`](https://mui.com/material-ui/api/select/) element.
|
||||
*
|
||||
* This prop is an alias for `slotProps.select` and will be overriden by it if both are used.
|
||||
* @deprecated Use `slotProps.select` instead.
|
||||
*
|
||||
* @default {}
|
||||
*/
|
||||
SelectProps?: Partial<SelectProps>;
|
||||
/**
|
||||
* If `true`, show the first-page button.
|
||||
* @default false
|
||||
*/
|
||||
showFirstButton?: boolean;
|
||||
/**
|
||||
* If `true`, show the last-page button.
|
||||
* @default false
|
||||
*/
|
||||
showLastButton?: boolean;
|
||||
/**
|
||||
* The props used for each slot inside the TablePagination.
|
||||
* @default {}
|
||||
*/
|
||||
slotProps?: {
|
||||
actions?: TablePaginationActionsProps['slotProps'];
|
||||
select?: Partial<SelectProps>;
|
||||
};
|
||||
/**
|
||||
* The components used for each slot inside the TablePagination.
|
||||
* Either a string to use a HTML element or a component.
|
||||
* @default {}
|
||||
*/
|
||||
slots?: {
|
||||
actions?: TablePaginationActionsProps['slots'];
|
||||
};
|
||||
/**
|
||||
* The system prop that allows defining system overrides as well as additional CSS styles.
|
||||
*/
|
||||
sx?: SxProps<Theme>;
|
||||
}
|
||||
|
||||
export interface TablePaginationTypeMap<AdditionalProps, RootComponent extends React.ElementType> {
|
||||
props: AdditionalProps & TablePaginationOwnProps;
|
||||
defaultComponent: RootComponent;
|
||||
}
|
||||
|
||||
/**
|
||||
* A `TableCell` based component for placing inside `TableFooter` for pagination.
|
||||
*
|
||||
* Demos:
|
||||
*
|
||||
* - [Pagination](https://mui.com/material-ui/react-pagination/)
|
||||
* - [Table](https://mui.com/material-ui/react-table/)
|
||||
*
|
||||
* API:
|
||||
*
|
||||
* - [TablePagination API](https://mui.com/material-ui/api/table-pagination/)
|
||||
* - inherits [TableCell API](https://mui.com/material-ui/api/table-cell/)
|
||||
*/
|
||||
declare const TablePagination: OverridableComponent<
|
||||
TablePaginationTypeMap<{}, React.JSXElementConstructor<TablePaginationBaseProps>>
|
||||
>;
|
||||
|
||||
export type TablePaginationProps<
|
||||
RootComponent extends React.ElementType = React.JSXElementConstructor<TablePaginationBaseProps>,
|
||||
AdditionalProps = {},
|
||||
> = OverrideProps<TablePaginationTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
|
||||
component?: React.ElementType;
|
||||
};
|
||||
|
||||
export default TablePagination;
|
||||
Reference in New Issue
Block a user