@wordpress/components
Version:
UI components for WordPress.
33 lines • 1.07 kB
TypeScript
import type { AnimateProps, GetAnimateOptions } from './types';
/**
* @param options
*
* @return ClassName that applies the animations
*/
export declare function getAnimateClassName(options: GetAnimateOptions): string | undefined;
/**
* Simple interface to introduce animations to components.
*
* This component is deprecated. Write your own CSS animations instead,
* preferably using the [motion tokens](https://wordpress.github.io/gutenberg/?path=/docs/design-system-tokens-introduction--docs)
* available in `@wordpress/theme`.
*
* @deprecated
*
* ```jsx
* import { Animate, Notice } from '@wordpress/components';
*
* const MyAnimatedNotice = () => (
* <Animate type="slide-in" options={ { origin: 'top' } }>
* { ( { className } ) => (
* <Notice className={ className } status="success">
* <p>Animation finished.</p>
* </Notice>
* ) }
* </Animate>
* );
* ```
*/
export declare function Animate({ type, options, children }: AnimateProps): import("react").JSX.Element;
export default Animate;
//# sourceMappingURL=index.d.ts.map