230 lines
No EOL
8.6 KiB
TypeScript
230 lines
No EOL
8.6 KiB
TypeScript
import * as React from 'react';
|
|
import { MUIStyledCommonProps, SxProps } from '@mui/system';
|
|
import { PopperProps } from "../Popper/index.js";
|
|
import { Theme } from "../styles/index.js";
|
|
import { InternalStandardProps as StandardProps } from "../internal/index.js";
|
|
import { CreateSlotsAndSlotProps, SlotProps } from "../utils/types.js";
|
|
import { TransitionProps } from "../transitions/transition.js";
|
|
import { TooltipClasses } from "./tooltipClasses.js";
|
|
export interface TooltipComponentsPropsOverrides {}
|
|
export interface TooltipPopperSlotPropsOverrides {}
|
|
export interface TooltipTransitionSlotPropsOverrides {}
|
|
export interface TooltipTooltipSlotPropsOverrides {}
|
|
export interface TooltipArrowSlotPropsOverrides {}
|
|
export interface TooltipSlots {
|
|
/**
|
|
* The component used for the popper.
|
|
* @default Popper
|
|
*/
|
|
popper: React.ElementType;
|
|
/**
|
|
* The component used for the transition.
|
|
* [Follow this guide](https://mui.com/material-ui/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.
|
|
* @default Grow
|
|
*/
|
|
transition: React.ElementType;
|
|
/**
|
|
* The component used for the tooltip.
|
|
*/
|
|
tooltip: React.ElementType;
|
|
/**
|
|
* The component used for the arrow.
|
|
*/
|
|
arrow: React.ElementType;
|
|
}
|
|
export type TooltipSlotsAndSlotProps = CreateSlotsAndSlotProps<TooltipSlots, {
|
|
/**
|
|
* Props forwarded to the popper slot.
|
|
* By default, the avaible props are based on the [Popper](https://mui.com/material-ui/api/popper/#props) component.
|
|
*/
|
|
popper: SlotProps<React.ElementType<PopperProps>, TooltipPopperSlotPropsOverrides, TooltipOwnerState>;
|
|
/**
|
|
* Props forwarded to the transition slot.
|
|
* By default, the avaible props are based on the [Grow](https://mui.com/material-ui/api/grow/#props) component.
|
|
*/
|
|
transition: SlotProps<React.ElementType, TransitionProps & TooltipTransitionSlotPropsOverrides, TooltipOwnerState>;
|
|
/**
|
|
* Props forwarded to the tooltip slot.
|
|
* By default, the avaible props are based on the div element.
|
|
*/
|
|
tooltip: SlotProps<'div', TooltipTooltipSlotPropsOverrides, TooltipOwnerState>;
|
|
/**
|
|
* Props forwarded to the tooltip slot.
|
|
* By default, the avaible props are based on the span element.
|
|
*/
|
|
arrow: SlotProps<'span', TooltipArrowSlotPropsOverrides, TooltipOwnerState>;
|
|
}>;
|
|
export interface TooltipProps extends StandardProps<React.HTMLAttributes<HTMLDivElement>, 'title'>, TooltipSlotsAndSlotProps {
|
|
/**
|
|
* If `true`, adds an arrow to the tooltip.
|
|
* @default false
|
|
*/
|
|
arrow?: boolean;
|
|
/**
|
|
* Tooltip reference element.
|
|
*/
|
|
children: React.ReactElement<unknown, any>;
|
|
/**
|
|
* Override or extend the styles applied to the component.
|
|
*/
|
|
classes?: Partial<TooltipClasses>;
|
|
/**
|
|
* The components used for each slot inside.
|
|
*
|
|
* @deprecated use the `slots` prop instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details.
|
|
*
|
|
* @default {}
|
|
*/
|
|
components?: {
|
|
Popper?: React.ElementType<PopperProps>;
|
|
Transition?: React.ElementType;
|
|
Tooltip?: React.ElementType;
|
|
Arrow?: React.ElementType;
|
|
};
|
|
/**
|
|
* The extra props for the slot components.
|
|
* You can override the existing props or add new ones.
|
|
*
|
|
* @deprecated use the `slotProps` prop instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details.
|
|
*
|
|
* @default {}
|
|
*/
|
|
componentsProps?: {
|
|
popper?: Partial<PopperProps> & TooltipComponentsPropsOverrides;
|
|
transition?: TransitionProps & TooltipComponentsPropsOverrides;
|
|
tooltip?: React.HTMLProps<HTMLDivElement> & MUIStyledCommonProps & TooltipComponentsPropsOverrides;
|
|
arrow?: React.HTMLProps<HTMLSpanElement> & MUIStyledCommonProps & TooltipComponentsPropsOverrides;
|
|
};
|
|
/**
|
|
* Set to `true` if the `title` acts as an accessible description.
|
|
* By default the `title` acts as an accessible label for the child.
|
|
* @default false
|
|
*/
|
|
describeChild?: boolean;
|
|
/**
|
|
* Do not respond to focus-visible events.
|
|
* @default false
|
|
*/
|
|
disableFocusListener?: boolean;
|
|
/**
|
|
* Do not respond to hover events.
|
|
* @default false
|
|
*/
|
|
disableHoverListener?: boolean;
|
|
/**
|
|
* Makes a tooltip not interactive, i.e. it will close when the user
|
|
* hovers over the tooltip before the `leaveDelay` is expired.
|
|
* @default false
|
|
*/
|
|
disableInteractive?: boolean;
|
|
/**
|
|
* Do not respond to long press touch events.
|
|
* @default false
|
|
*/
|
|
disableTouchListener?: boolean;
|
|
/**
|
|
* The number of milliseconds to wait before showing the tooltip.
|
|
* This prop won't impact the enter touch delay (`enterTouchDelay`).
|
|
* @default 100
|
|
*/
|
|
enterDelay?: number;
|
|
/**
|
|
* The number of milliseconds to wait before showing the tooltip when one was already recently opened.
|
|
* @default 0
|
|
*/
|
|
enterNextDelay?: number;
|
|
/**
|
|
* The number of milliseconds a user must touch the element before showing the tooltip.
|
|
* @default 700
|
|
*/
|
|
enterTouchDelay?: number;
|
|
/**
|
|
* If `true`, the tooltip follow the cursor over the wrapped element.
|
|
* @default false
|
|
*/
|
|
followCursor?: boolean;
|
|
/**
|
|
* This prop is used to help implement the accessibility logic.
|
|
* If you don't provide this prop. It falls back to a randomly generated id.
|
|
*/
|
|
id?: string;
|
|
/**
|
|
* The number of milliseconds to wait before hiding the tooltip.
|
|
* This prop won't impact the leave touch delay (`leaveTouchDelay`).
|
|
* @default 0
|
|
*/
|
|
leaveDelay?: number;
|
|
/**
|
|
* The number of milliseconds after the user stops touching an element before hiding the tooltip.
|
|
* @default 1500
|
|
*/
|
|
leaveTouchDelay?: number;
|
|
/**
|
|
* Callback fired when the component requests to be closed.
|
|
*
|
|
* @param {React.SyntheticEvent} event The event source of the callback.
|
|
*/
|
|
onClose?: (event: React.SyntheticEvent | Event) => void;
|
|
/**
|
|
* Callback fired when the component requests to be open.
|
|
*
|
|
* @param {React.SyntheticEvent} event The event source of the callback.
|
|
*/
|
|
onOpen?: (event: React.SyntheticEvent) => void;
|
|
/**
|
|
* If `true`, the component is shown.
|
|
*/
|
|
open?: boolean;
|
|
/**
|
|
* Tooltip placement.
|
|
* @default 'bottom'
|
|
*/
|
|
placement?: PopperProps['placement'];
|
|
/**
|
|
* The component used for the popper.
|
|
* @deprecated use the `slots.popper` prop instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details.
|
|
*/
|
|
PopperComponent?: React.JSXElementConstructor<PopperProps>;
|
|
/**
|
|
* Props applied to the [`Popper`](https://mui.com/material-ui/api/popper/) element.
|
|
* @deprecated use the `slotProps.popper` prop instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details.
|
|
* @default {}
|
|
*/
|
|
PopperProps?: Partial<PopperProps>;
|
|
/**
|
|
* The system prop that allows defining system overrides as well as additional CSS styles.
|
|
*/
|
|
sx?: SxProps<Theme>;
|
|
/**
|
|
* Tooltip title. Zero-length titles string, undefined, null and false are never displayed.
|
|
*/
|
|
title: React.ReactNode;
|
|
/**
|
|
* The component used for the transition.
|
|
* [Follow this guide](https://mui.com/material-ui/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.
|
|
* @deprecated use the `slots.transition` prop instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details.
|
|
*/
|
|
TransitionComponent?: React.JSXElementConstructor<TransitionProps & {
|
|
children: React.ReactElement<unknown, any>;
|
|
}>;
|
|
/**
|
|
* Props applied to the transition element.
|
|
* By default, the element is based on this [`Transition`](https://reactcommunity.org/react-transition-group/transition/) component.
|
|
* @deprecated use the `slotProps.transition` prop instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details.
|
|
* @default {}
|
|
*/
|
|
TransitionProps?: TransitionProps;
|
|
}
|
|
export interface TooltipOwnerState extends TooltipProps {}
|
|
|
|
/**
|
|
*
|
|
* Demos:
|
|
*
|
|
* - [Tooltip](https://mui.com/material-ui/react-tooltip/)
|
|
*
|
|
* API:
|
|
*
|
|
* - [Tooltip API](https://mui.com/material-ui/api/tooltip/)
|
|
*/
|
|
export default function Tooltip(props: TooltipProps): React.JSX.Element; |