@patternfly/react-core/dist/esm/helpers/AnimationsProvider/AnimationsProvider.js

This library provides a set of common React components for use with the PatternFly reference implementation.

import { jsx as _jsx } from "react/jsx-runtime";
import { createContext, useContext } from 'react';
/** Context to provide animations configuration to child components */
const AnimationsContext = createContext({
    hasAnimations: false
});
/**
 * AnimationsProvider is an application-level provider that provides uniform
 * animation configuration for all PatternFly React components via the React context API.
 *
 * **Usage**: Place this provider at the root of your application to enable global
 * animation control without requiring manual prop drilling throughout your component tree.
 *
 * **Benefits**:
 * - Centralized animation control for the entire application
 * - Respects user accessibility preferences (reduced motion)
 * - Components can still override the global setting when needed
 * - Works with all PatternFly components that support animations
 *
 * @example
 * ```tsx
 * // App.tsx - Place at your application root
 * import { AnimationsProvider } from '@patternfly/react-core';
 *
 * const App = () => (
 *   <AnimationsProvider config={{ hasAnimations: true }}>
 *     <MyApplication />
 *   </AnimationsProvider>
 * );
 * ```
 */
export const AnimationsProvider = ({ config, children }) => (_jsx(AnimationsContext.Provider, { value: config, children: children }));
/**
 * Hook to access the animations configuration from the nearest AnimationsProvider.
 *
 * This hook allows components to check if animations are enabled and override
 * their local hasAnimations prop accordingly.
 *
 * @returns The animations configuration object
 *
 * @example
 * ```tsx
 * const MyComponent = ({ hasAnimations: hasAnimationsProp, ...props }) => {
 *   const { hasAnimations: contextHasAnimations } = useAnimationsConfig();
 *   const hasAnimations = hasAnimationsProp ?? contextHasAnimations;
 *
 *   return <div className={hasAnimations ? 'with-animations' : ''} {...props} />;
 * };
 * ```
 */
export const useAnimationsConfig = () => {
    const context = useContext(AnimationsContext);
    if (context === undefined) {
        // Return default config if no provider is found
        return { hasAnimations: false };
    }
    return context;
};
/**
 * Utility hook that combines local hasAnimations prop with context configuration.
 * The local prop takes precedence when explicitly set, otherwise falls back to context.
 *
 * @param hasAnimationsProp - The hasAnimations prop passed directly to the component
 * @returns The resolved hasAnimations value
 *
 * @example
 * ```tsx
 * const MyComponent = ({ hasAnimations: hasAnimationsProp, ...props }) => {
 *   const hasAnimations = useHasAnimations(hasAnimationsProp);
 *
 *   return <div className={hasAnimations ? 'animated' : 'static'} {...props} />;
 * };
 * ```
 */
export const useHasAnimations = (hasAnimationsProp) => {
    var _a;
    const { hasAnimations: contextHasAnimations } = useAnimationsConfig();
    // Local prop takes precedence when explicitly set (including false)
    // If local prop is undefined, fall back to context
    return (_a = hasAnimationsProp !== null && hasAnimationsProp !== void 0 ? hasAnimationsProp : contextHasAnimations) !== null && _a !== void 0 ? _a : false;
};
AnimationsProvider.displayName = 'AnimationsProvider';
//# sourceMappingURL=AnimationsProvider.js.map