UNPKG

770 BTypeScriptView Raw
1import { TransitionContextValue } from './TransitionContext';
2/**
3 * Allows child elements to be transitioned in and out.
4 *
5 * Demos:
6 *
7 * - [Transitions](https://mui.com/base-ui/react-transitions/#hooks)
8 *
9 * API:
10 *
11 * - [useTransitionTrigger API](https://mui.com/base-ui/react-transitions/hooks-api/#use-transition-trigger)
12 */
13export declare function useTransitionTrigger(requestEnter: boolean): UseTransitionTriggerReturnValue;
14export type UseTransitionTriggerReturnValue = {
15 /**
16 * The value of a `TransitionContext` to be placed around children that will be transitioned.
17 */
18 contextValue: TransitionContextValue;
19 /**
20 * `true`, if the transitioned element has exited completely (or not entered yet).
21 */
22 hasExited: boolean;
23};