FrontPastel/node_modules/@mui/material/MenuList/MenuList.d.ts

74 lines
2.2 KiB
TypeScript
Raw Normal View History

2024-04-17 13:55:11 +00:00
import * as React from 'react';
import { ExtendList, ExtendListTypeMap } from '../List';
import { OverrideProps } from '../OverridableComponent';
export interface MenuListOwnProps {
/**
* If `true`, will focus the `[role="menu"]` container and move into tab order.
* @default false
*/
autoFocus?: boolean;
/**
* If `true`, will focus the first menuitem if `variant="menu"` or selected item
* if `variant="selectedMenu"`.
* @default false
*/
autoFocusItem?: boolean;
/**
* MenuList contents, normally `MenuItem`s.
*/
children?: React.ReactNode;
/**
* If `true`, will allow focus on disabled items.
* @default false
*/
disabledItemsFocusable?: boolean;
/**
* If `true`, the menu items will not wrap focus.
* @default false
*/
disableListWrap?: boolean;
/**
* The variant to use. Use `menu` to prevent selected items from impacting the initial focus
* and the vertical alignment relative to the anchor element.
* @default 'selectedMenu'
*/
variant?: 'menu' | 'selectedMenu';
}
export type MenuListTypeMap<
AdditionalProps = {},
RootComponent extends React.ElementType = 'ul',
> = ExtendListTypeMap<{
props: AdditionalProps & MenuListOwnProps;
defaultComponent: RootComponent;
}>;
export type MenuListClassKey = keyof NonNullable<MenuListTypeMap['props']['classes']>;
/**
* A permanently displayed menu following https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/.
* It's exposed to help customization of the [`Menu`](https://mui.com/material-ui/api/menu/) component if you
* use it separately you need to move focus into the component manually. Once
* the focus is placed inside the component it is fully keyboard accessible.
*
* Demos:
*
* - [Menu](https://mui.com/material-ui/react-menu/)
*
* API:
*
* - [MenuList API](https://mui.com/material-ui/api/menu-list/)
* - inherits [List API](https://mui.com/material-ui/api/list/)
*/
declare const MenuList: ExtendList<MenuListTypeMap>;
export type MenuListProps<
RootComponent extends React.ElementType = MenuListTypeMap['defaultComponent'],
AdditionalProps = {},
> = OverrideProps<MenuListTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
component?: React.ElementType;
};
export default MenuList;