@mui/material 7.0.0-beta.0 → 7.0.0-beta.2

package/TablePagination/TablePagination.d.ts

@@ -0,0 +1,263 @@
+import * as React from 'react';
+import { SxProps } from '@mui/system';
+import { Theme } from "../styles/index.js";
+import { OverridableComponent, OverrideProps } from "../OverridableComponent/index.js";
+import { TablePaginationActionsProps, TablePaginationActionsSlots } from "./TablePaginationActions.js";
+import { TableCellProps } from "../TableCell/index.js";
+import { IconButtonProps } from "../IconButton/index.js";
+import { SelectProps } from "../Select/index.js";
+import { TablePaginationClasses } from "./tablePaginationClasses.js";
+import { CreateSlotsAndSlotProps, SlotProps } from "../utils/types.js";
+import { ToolbarProps } from "../Toolbar/index.js";
+import { MenuItemProps } from "../MenuItem/index.js";
+export interface LabelDisplayedRowsArgs {
+  from: number;
+  to: number;
+  count: number;
+  page: number;
+}
+export interface TablePaginationRootSlotPropsOverrides {}
+export interface TablePaginationToolbarSlotPropsOverrides {}
+export interface TablePaginationSpacerSlotPropsOverrides {}
+export interface TablePaginationSelectLabelSlotPropsOverrides {}
+export interface TablePaginationSelectSlotPropsOverrides {}
+export interface TablePaginationMenuItemSlotPropsOverrides {}
+export interface TablePaginationDisplayedRowsSlotPropsOverrides {}
+export interface TablePaginationActionsSlotPropsOverrides {}
+export interface TablePaginationSlots {
+  /**
+   * The component that renders the root slot.
+   * [Follow this guide](https://mui.com/material-ui/api/table-cell/#props) to learn more about the requirements for this component.
+   * @default TableCell
+   */
+  root: React.ElementType;
+  /**
+   * The component that renders the toolbar slot.
+   * [Follow this guide](https://mui.com/material-ui/api/toolbar/#props) to learn more about the requirements for this component.
+   * @default Toolbar
+   */
+  toolbar: React.ElementType;
+  /**
+   * The tag that renders the spacer slot.
+   * @default 'div'
+   */
+  spacer: React.ElementType;
+  /**
+   * The tag that renders the selectLabel slot.
+   * @default 'p'
+   */
+  selectLabel: React.ElementType;
+  /**
+   * The component that renders the select slot.
+   * [Follow this guide](https://mui.com/material-ui/api/select/#props) to learn more about the requirements for this component.
+   * @default Select
+   */
+  select: React.ElementType;
+  /**
+   * The component that renders the select slot.
+   * [Follow this guide](https://mui.com/material-ui/api/menu-item/#props) to learn more about the requirements for this component.
+   * @default MenuItem
+   */
+  menuItem: React.ElementType;
+  /**
+   * The tag that renders the displayedRows slot.
+   * @default 'p'
+   */
+  displayedRows: React.ElementType;
+  /**
+   * The slots that passed to the actions slot.
+   */
+  actions: TablePaginationActionsSlots;
+}
+export type TablePaginationSlotsAndSlotProps = CreateSlotsAndSlotProps<TablePaginationSlots, {
+  /**
+   * Props forwarded to the root slot.
+   * By default, the avaible props are based on the [TableCell](https://mui.com/material-ui/api/table-cell/#props) component.
+   */
+  root: SlotProps<React.ElementType<TableCellProps>, TablePaginationRootSlotPropsOverrides, TablePaginationOwnerState>;
+  /**
+   * Props forwarded to the toolbar slot.
+   * By default, the avaible props are based on the [Toolbar](https://mui.com/material-ui/api/toolbar/#props) component.
+   */
+  toolbar: SlotProps<React.ElementType<ToolbarProps>, TablePaginationToolbarSlotPropsOverrides, TablePaginationOwnerState>;
+  /**
+   * Props forwarded to the spacer slot.
+   * By default, the avaible props are based on the div element.
+   */
+  spacer: SlotProps<'div', TablePaginationSpacerSlotPropsOverrides, TablePaginationOwnerState>;
+  /**
+   * Props forwarded to the selectLabel slot.
+   * By default, the avaible props are based on the paragraph element.
+   */
+  selectLabel: SlotProps<'p', TablePaginationSelectLabelSlotPropsOverrides, TablePaginationOwnerState>;
+  /**
+   * Props forwarded to the select slot.
+   * By default, the avaible props are based on the [Select](https://mui.com/material-ui/api/select/#props) component.
+   */
+  select: Partial<SelectProps> & TablePaginationSelectSlotPropsOverrides;
+  /**
+   * Props forwarded to the menuItem slot.
+   * By default, the avaible props are based on the [MenuItem](https://mui.com/material-ui/api/menu-item/#props) component.
+   */
+  menuItem: SlotProps<React.ElementType<MenuItemProps>, TablePaginationMenuItemSlotPropsOverrides, TablePaginationOwnerState>;
+  /**
+   * Props forwarded to the displayedRows slot.
+   * By default, the avaible props are based on the paragraph element.
+   */
+  displayedRows: SlotProps<'p', TablePaginationDisplayedRowsSlotPropsOverrides, TablePaginationOwnerState>;
+  /**
+   * Props forwarded to the actions slot.
+   */
+  actions: TablePaginationActionsProps['slotProps'] & TablePaginationActionsSlotPropsOverrides;
+}>;
+
+/**
+ * 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 system prop that allows defining system overrides as well as additional CSS styles.
+   */
+  sx?: SxProps<Theme>;
+}
+export interface TablePaginationOwnerState extends TablePaginationOwnProps {}
+export interface TablePaginationTypeMap<AdditionalProps, RootComponent extends React.ElementType> {
+  props: AdditionalProps & TablePaginationOwnProps & TablePaginationSlotsAndSlotProps;
+  defaultComponent: RootComponent;
+}
+
+/**
+ * A `TableCell` based component for placing inside `TableFooter` for pagination.
+ *
+ * Demos:
+ *
+ * - [Pagination](https://next.mui.com/material-ui/react-pagination/)
+ * - [Table](https://next.mui.com/material-ui/react-table/)
+ *
+ * API:
+ *
+ * - [TablePagination API](https://next.mui.com/material-ui/api/table-pagination/)
+ * - inherits [TableCell API](https://next.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;

package/TablePagination/TablePaginationActions.d.ts

@@ -0,0 +1,94 @@
+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 overriden by it if both are used.
+   * @deprecated Use `slotProps.previousButton` instead.
+   */
+  backIconButtonProps?: Partial<IconButtonProps>;
+  /**
+   * Override or extend the styles applied to the component.
+   */
+  classes?: {};
+  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 overriden 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;
+}
+declare const TablePaginationActions: React.JSXElementConstructor<TablePaginationActionsProps>;
+export default TablePaginationActions;

package/TablePagination/index.d.ts

@@ -0,0 +1,4 @@
+export { default } from "./TablePagination.js";
+export * from "./TablePagination.js";
+export { default as tablePaginationClasses } from "./tablePaginationClasses.js";
+export * from "./tablePaginationClasses.js";

package/TablePagination/tablePaginationClasses.d.ts

@@ -0,0 +1,28 @@
+export interface TablePaginationClasses {
+  /** Styles applied to the root element. */
+  root: string;
+  /** Styles applied to the Toolbar component. */
+  toolbar: string;
+  /** Styles applied to the spacer element. */
+  spacer: string;
+  /** Styles applied to the select label Typography element. */
+  selectLabel: string;
+  /** Styles applied to the Select component `root` element. */
+  selectRoot: string;
+  /** Styles applied to the Select component `select` class. */
+  select: string;
+  /** Styles applied to the Select component `icon` class. */
+  selectIcon: string;
+  /** Styles applied to the Select component `root` element. */
+  input: string;
+  /** Styles applied to the MenuItem component. */
+  menuItem: string;
+  /** Styles applied to the displayed rows Typography element. */
+  displayedRows: string;
+  /** Styles applied to the internal `TablePaginationActions` component. */
+  actions: string;
+}
+export type TablePaginationClassKey = keyof TablePaginationClasses;
+export declare function getTablePaginationUtilityClass(slot: string): string;
+declare const tablePaginationClasses: TablePaginationClasses;
+export default tablePaginationClasses;

package/TableRow/TableRow.d.ts

@@ -0,0 +1,50 @@
+import * as React from 'react';
+import { SxProps } from '@mui/system';
+import { Theme } from "../index.js";
+import { OverridableComponent, OverrideProps } from "../OverridableComponent/index.js";
+import { TableRowClasses } from "./tableRowClasses.js";
+export interface TableRowOwnProps {
+  /**
+   * Should be valid `<tr>` children such as `TableCell`.
+   */
+  children?: React.ReactNode;
+  /**
+   * Override or extend the styles applied to the component.
+   */
+  classes?: Partial<TableRowClasses>;
+  /**
+   * If `true`, the table row will shade on hover.
+   * @default false
+   */
+  hover?: boolean;
+  /**
+   * If `true`, the table row will have the selected shading.
+   * @default false
+   */
+  selected?: boolean;
+  /**
+   * The system prop that allows defining system overrides as well as additional CSS styles.
+   */
+  sx?: SxProps<Theme>;
+}
+export interface TableRowTypeMap<AdditionalProps = {}, RootComponent extends React.ElementType = 'tr'> {
+  props: AdditionalProps & TableRowOwnProps;
+  defaultComponent: RootComponent;
+}
+/**
+ * Will automatically set dynamic row height
+ * based on the material table element parent (head, body, etc).
+ *
+ * Demos:
+ *
+ * - [Table](https://next.mui.com/material-ui/react-table/)
+ *
+ * API:
+ *
+ * - [TableRow API](https://next.mui.com/material-ui/api/table-row/)
+ */
+declare const TableRow: OverridableComponent<TableRowTypeMap>;
+export type TableRowProps<RootComponent extends React.ElementType = TableRowTypeMap['defaultComponent'], AdditionalProps = {}> = OverrideProps<TableRowTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
+  component?: React.ElementType;
+};
+export default TableRow;

package/TableRow/index.d.ts

@@ -0,0 +1,4 @@
+export { default } from "./TableRow.js";
+export * from "./TableRow.js";
+export { default as tableRowClasses } from "./tableRowClasses.js";
+export * from "./tableRowClasses.js";

package/TableRow/tableRowClasses.d.ts

@@ -0,0 +1,16 @@
+export interface TableRowClasses {
+  /** Styles applied to the root element. */
+  root: string;
+  /** State class applied to the root element if `selected={true}`. */
+  selected: string;
+  /** State class applied to the root element if `hover={true}`. */
+  hover: string;
+  /** Styles applied to the root element if table variant="head". */
+  head: string;
+  /** Styles applied to the root element if table variant="footer". */
+  footer: string;
+}
+export type TableRowClassKey = keyof TableRowClasses;
+export declare function getTableRowUtilityClass(slot: string): string;
+declare const tableRowClasses: TableRowClasses;
+export default tableRowClasses;

package/TableSortLabel/TableSortLabel.d.ts

@@ -0,0 +1,90 @@
+import * as React from 'react';
+import { SxProps } from '@mui/system';
+import { Theme } from "../index.js";
+import { ExtendButtonBase, ExtendButtonBaseTypeMap } from "../ButtonBase/index.js";
+import { OverrideProps } from "../OverridableComponent/index.js";
+import { TableSortLabelClasses } from "./tableSortLabelClasses.js";
+import { CreateSlotsAndSlotProps, SlotProps } from "../utils/types.js";
+export interface TableSortLabelRootSlotPropsOverrides {}
+export interface TableSortLabelIconSlotPropsOverrides {}
+export interface TableSortLabelSlots {
+  /**
+   * The component that renders the root slot.
+   * @default span
+   */
+  root?: React.ElementType;
+  /**
+   * The component that renders the icon slot.
+   * @default ArrowDownwardIcon
+   */
+  icon?: React.ElementType;
+}
+export type TableSortLabelSlotsAndSlotProps = CreateSlotsAndSlotProps<TableSortLabelSlots, {
+  /**
+   * Props forwarded to the root slot.
+   */
+  root: SlotProps<React.ElementType<React.HTMLAttributes<HTMLSpanElement>>, TableSortLabelRootSlotPropsOverrides, TableSortLabelOwnerState>;
+  /**
+   * Props forwarded to the icon slot.
+   */
+  icon: SlotProps<React.ElementType<React.SVGAttributes<SVGSVGElement>>, TableSortLabelIconSlotPropsOverrides, TableSortLabelOwnerState>;
+}>;
+export interface TableSortLabelOwnerState extends TableSortLabelOwnProps {}
+export interface TableSortLabelOwnProps {
+  /**
+   * If `true`, the label will have the active styling (should be true for the sorted column).
+   * @default false
+   */
+  active?: boolean;
+  /**
+   * Label contents, the arrow will be appended automatically.
+   */
+  children?: React.ReactNode;
+  /**
+   * Override or extend the styles applied to the component.
+   */
+  classes?: Partial<TableSortLabelClasses>;
+  /**
+   * The current sort direction.
+   * @default 'asc'
+   */
+  direction?: 'asc' | 'desc';
+  /**
+   * Hide sort icon when active is false.
+   * @default false
+   */
+  hideSortIcon?: boolean;
+  /**
+   * Sort icon to use.
+   * @default ArrowDownwardIcon
+   */
+  IconComponent?: React.JSXElementConstructor<{
+    className: string;
+  }>;
+  /**
+   * The system prop that allows defining system overrides as well as additional CSS styles.
+   */
+  sx?: SxProps<Theme>;
+}
+export type TableSortLabelTypeMap<AdditionalProps = {}, RootComponent extends React.ElementType = 'span'> = ExtendButtonBaseTypeMap<{
+  props: AdditionalProps & TableSortLabelOwnProps & TableSortLabelSlotsAndSlotProps;
+  defaultComponent: RootComponent;
+}>;
+
+/**
+ * A button based label for placing inside `TableCell` for column sorting.
+ *
+ * Demos:
+ *
+ * - [Table](https://next.mui.com/material-ui/react-table/)
+ *
+ * API:
+ *
+ * - [TableSortLabel API](https://next.mui.com/material-ui/api/table-sort-label/)
+ * - inherits [ButtonBase API](https://next.mui.com/material-ui/api/button-base/)
+ */
+declare const TableSortLabel: ExtendButtonBase<TableSortLabelTypeMap>;
+export type TableSortLabelProps<RootComponent extends React.ElementType = TableSortLabelTypeMap['defaultComponent'], AdditionalProps = {}> = OverrideProps<TableSortLabelTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
+  component?: React.ElementType;
+};
+export default TableSortLabel;

package/TableSortLabel/index.d.ts

@@ -0,0 +1,4 @@
+export { default } from "./TableSortLabel.js";
+export * from "./TableSortLabel.js";
+export { default as tableSortLabelClasses } from "./tableSortLabelClasses.js";
+export * from "./tableSortLabelClasses.js";

package/TableSortLabel/tableSortLabelClasses.d.ts

@@ -0,0 +1,24 @@
+export interface TableSortLabelClasses {
+  /** Styles applied to the root element. */
+  root: string;
+  /** Styles applied to the root element if `direction="desc"`. */
+  directionDesc: string;
+  /** Styles applied to the root element if `direction="asc"`. */
+  directionAsc: string;
+  /** State class applied to the root element if `active={true}`. */
+  active: string;
+  /** Styles applied to the icon component. */
+  icon: string;
+  /** Styles applied to the icon component if `direction="desc"`.
+   * @deprecated Combine the [.MuiTableSortLabel-icon](/material-ui/api/table-sort-label/#table-sort-label-classes-icon) and [.MuiTableSortLabel-directionDesc](/material-ui/api/table-sort-label/#table-sort-label-classes-direction-desc) classes instead. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details.
+   */
+  iconDirectionDesc: string;
+  /** Styles applied to the icon component if `direction="asc"`.
+   * @deprecated Combine the [.MuiTableSortLabel-icon](/material-ui/api/table-sort-label/#table-sort-label-classes-icon) and [.MuiTableSortLabel-directionAsc](/material-ui/api/table-sort-label/#table-sort-label-classes-direction-asc) classes instead. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details.
+   */
+  iconDirectionAsc: string;
+}
+export type TableSortLabelClassKey = keyof TableSortLabelClasses;
+export declare function getTableSortLabelUtilityClass(slot: string): string;
+declare const tableSortLabelClasses: TableSortLabelClasses;
+export default tableSortLabelClasses;