Skip to content

856: add note for AnimationsProvider in enable-animations docs #857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gitdallas merged 1 commit into from
Sep 24, 2025
Merged

856: add note for AnimationsProvider in enable-animations docs #857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ...es/eslint-plugin-pf-codemods/src/rules/v6/enableAnimations/enable-animations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This rule adds the `hasAnimations` prop to PatternFly components that support animations. This is an optional enhancement that enables smoother transitions and animations in your UI components.

**Noteworthy Alternative:** PatternFly now provides an `AnimationsProvider` context provider that can be used to enable animations globally across your application. The `hasAnimations` prop is still preferred for developers who want to enable animations manually on specific components without using the context provider.

**⚠️ Important:** Enabling animations may change the DOM structure of some components. This could affect CSS selectors, testing queries, or other code that relies on the specific DOM structure. Review your code after enabling animations to ensure compatibility.

The following components will have `hasAnimations` added:
Expand Down
2 changes: 2 additions & 0 deletions packages/pf-codemods/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1219,6 +1219,8 @@ import { EmptyStateHeader, EmptyStateIcon } from "@patternfly/react-core";

This rule adds the `hasAnimations` prop to PatternFly components that support animations. This is an optional enhancement that enables smoother transitions and animations in your UI components.

**Noteworthy Alternative:** PatternFly now provides an `AnimationsProvider` context provider that can be used to enable animations globally across your application. The `hasAnimations` prop is still preferred for developers who want to enable animations manually on specific components without using the context provider.

**⚠️ Important:** Enabling animations may change the DOM structure of some components. This could affect CSS selectors, testing queries, or other code that relies on the specific DOM structure. Review your code after enabling animations to ensure compatibility.

The following components will have `hasAnimations` added:
Expand Down
Loading