@wordpress/components/src/animate/types.ts

UI components for WordPress.

export type AppearOptions = {
	type: 'appear';
	origin?:
		| 'top'
		| 'top left'
		| 'top right'
		| 'middle'
		| 'middle left'
		| 'middle right'
		| 'bottom'
		| 'bottom left'
		| 'bottom right';
};
type SlideInOptions = { type: 'slide-in'; origin?: 'left' | 'right' };
type LoadingOptions = { type: 'loading'; origin?: never };
type NoAnimationOptions = { type?: never; origin?: never };

export type GetAnimateOptions =
	| AppearOptions
	| SlideInOptions
	| LoadingOptions
	| NoAnimationOptions;

// Create a new type that and distributes the `Pick` operator separately to
// every individual type of a union, thus preserving that same union.
type DistributiveTypeAndOptions< T extends { type?: any } > = T extends any
	? Pick< T, 'type' > & { options?: Omit< T, 'type' > }
	: never;

export type AnimateProps = DistributiveTypeAndOptions< GetAnimateOptions > & {
	children: ( props: { className?: string } ) => JSX.Element;
};