Repository navigation
Add support for chronological and pagination transitions #2336
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.
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
Open
b1ink0
wants to merge
18
commits into
WordPress:trunk
Choose a base branch
from
b1ink0:enhancement/add-chronological-pagination-transition-support
base: trunk
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
08e7cae
Add support for chronological and pagination transitions
b1ink0 f518306
Add options to settings for chronological and pagination transitions
b1ink0 e1d07ae
Merge branch 'trunk' into enhancement/add-chronological-pagination-tr…
b1ink0 0bcdbc1
Merge branch 'trunk' into enhancement/add-chronological-pagination-tr…
b1ink0 431e777
Merge branch 'trunk' into enhancement/add-chronological-pagination-tr…
b1ink0 d3b4785
Wrap animation stylesheet in media query for reduced motion preference
b1ink0 f2ce961
Merge branch 'trunk' into enhancement/add-chronological-pagination-tr…
westonruter 5c43cc2
Apply some static analysis improvements
westonruter b6dfded
Export pagination_base from PHP
westonruter 772328e
Merge branch 'trunk' into enhancement/add-chronological-pagination-tr…
b1ink0 5a22f93
Merge branch 'trunk' into enhancement/add-chronological-pagination-tr…
b1ink0 9f38a99
Fix theme support validation
b1ink0 c8ba51b
Add support for animation duration in additional transition animation
b1ink0 b11ae36
Update types and add checks for animation config
b1ink0 8bc1d86
Add separate checkbox for enabling chronological pagination transition
b1ink0 9741eb3
Merge branch 'trunk' into enhancement/add-chronological-pagination-tr…
b1ink0 3490e2d
Merge branch 'trunk' into enhancement/add-chronological-pagination-tr…
b1ink0 161d576
Decouple chronological and pagination animation settings from the def…
b1ink0 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -66,18 +66,22 @@ function plvt_sanitize_view_transitions_theme_support(): void { | |
| $args = $_wp_theme_features['view-transitions']; | ||
|
|
||
| $defaults = array( | ||
| 'post-selector' => '.wp-block-post.post, article.post, body.single main', | ||
| 'global-transition-names' => array( | ||
| 'post-selector' => '.wp-block-post.post, article.post, body.single main', | ||
| 'global-transition-names' => array( | ||
| 'header' => 'header', | ||
| 'main' => 'main', | ||
| ), | ||
| 'post-transition-names' => array( | ||
| 'post-transition-names' => array( | ||
| '.wp-block-post-title, .entry-title' => 'post-title', | ||
| '.wp-post-image' => 'post-thumbnail', | ||
| '.wp-block-post-content, .entry-content' => 'post-content', | ||
| ), | ||
| 'default-animation' => 'fade', | ||
| 'default-animation-duration' => 400, | ||
| 'default-animation' => 'fade', | ||
| 'default-animation-duration' => 400, | ||
| 'chronological-forwards-animation' => false, | ||
| 'chronological-backwards-animation' => false, | ||
| 'pagination-forwards-animation' => false, | ||
| 'pagination-backwards-animation' => false, | ||
| ); | ||
|
|
||
| // If no specific `$args` were provided, simply use the defaults. | ||
|
|
@@ -102,8 +106,21 @@ function plvt_sanitize_view_transitions_theme_support(): void { | |
| if ( ! is_array( $args['post-transition-names'] ) ) { | ||
| $args['post-transition-names'] = array(); | ||
| } | ||
| } | ||
|
|
||
| // If specific transition animations match the default animations, they are irrelevant. | ||
| if ( $args['chronological-forwards-animation'] === $args['default-animation'] ) { | ||
| $args['chronological-forwards-animation'] = false; | ||
| } | ||
| if ( $args['chronological-backwards-animation'] === $args['default-animation'] ) { | ||
| $args['chronological-backwards-animation'] = false; | ||
| } | ||
| if ( $args['pagination-forwards-animation'] === $args['default-animation'] ) { | ||
| $args['pagination-forwards-animation'] = false; | ||
| } | ||
| if ( $args['pagination-backwards-animation'] === $args['default-animation'] ) { | ||
| $args['pagination-backwards-animation'] = false; | ||
| } | ||
| } | ||
| // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited | ||
| $_wp_theme_features['view-transitions'] = $args; | ||
| } | ||
|
|
@@ -324,7 +341,11 @@ function plvt_load_view_transitions(): void { | |
| */ | ||
| if ( | ||
| ( ! is_array( $theme_support['global-transition-names'] ) || count( $theme_support['global-transition-names'] ) === 0 ) && | ||
| ( ! is_array( $theme_support['post-transition-names'] ) || count( $theme_support['post-transition-names'] ) === 0 ) | ||
| ( ! is_array( $theme_support['post-transition-names'] ) || count( $theme_support['post-transition-names'] ) === 0 ) && | ||
| ! (bool) $theme_support['chronological-forwards-animation'] && | ||
| ! (bool) $theme_support['chronological-backwards-animation'] && | ||
| ! (bool) $theme_support['pagination-forwards-animation'] && | ||
| ! (bool) $theme_support['pagination-backwards-animation'] | ||
| ) { | ||
| return; | ||
| } | ||
|
|
@@ -336,6 +357,34 @@ function plvt_load_view_transitions(): void { | |
| ), | ||
| ); | ||
|
|
||
| $additional_transition_types = array( | ||
| 'chronological-forwards', | ||
| 'chronological-backwards', | ||
| 'pagination-forwards', | ||
| 'pagination-backwards', | ||
| ); | ||
|
|
||
|
Comment on lines
+381
to
+387
|
||
| foreach ( $additional_transition_types as $transition_type ) { | ||
| if ( isset( $theme_support[ $transition_type . '-animation' ] ) ) { | ||
| $additional_animation_args = isset( $theme_support[ $transition_type . '-animation-args' ] ) ? (array) $theme_support[ $transition_type . '-animation-args' ] : array(); | ||
| $additional_animation_stylesheet = $animation_registry->get_animation_stylesheet( $theme_support[ $transition_type . '-animation' ], $additional_animation_args ); | ||
| if ( '' !== $additional_animation_stylesheet ) { | ||
| wp_add_inline_style( | ||
| 'plvt-view-transitions', | ||
| plvt_scope_animation_stylesheet_to_transition_type( $additional_animation_stylesheet, $transition_type ) | ||
|
b1ink0 marked this conversation as resolved.
Outdated
|
||
| ); | ||
|
b1ink0 marked this conversation as resolved.
Outdated
|
||
| } | ||
|
|
||
| $animations_js_config[ $transition_type ] = array( | ||
| 'useGlobalTransitionNames' => $animation_registry->use_animation_global_transition_names( $theme_support[ $transition_type . '-animation' ], $additional_animation_args ), | ||
| 'usePostTransitionNames' => $animation_registry->use_animation_post_transition_names( $theme_support[ $transition_type . '-animation' ], $additional_animation_args ), | ||
| 'targetName' => isset( $additional_animation_args['target-name'] ) ? $additional_animation_args['target-name'] : '*', // Special argument. | ||
| ); | ||
| } else { | ||
| $animations_js_config[ $transition_type ] = false; | ||
| } | ||
| } | ||
|
b1ink0 marked this conversation as resolved.
|
||
|
|
||
| $config = array( | ||
| 'postSelector' => $theme_support['post-selector'], | ||
| 'globalTransitionNames' => $theme_support['global-transition-names'], | ||
|
|
@@ -389,3 +438,63 @@ function plvt_inject_animation_duration( string $css, int $animation_duration ): | |
|
|
||
| return $css; | ||
| } | ||
|
|
||
| /** | ||
| * Scopes the given view transition animation CSS to apply only to a specific transition type. | ||
| * | ||
| * @since n.e.x.t | ||
|
westonruter marked this conversation as resolved.
|
||
| * @access private | ||
| * | ||
| * @param string $css Animation stylesheet as inline CSS. | ||
| * @param string $transition_type Transition type to scope the CSS to. | ||
| * @return string Scoped animation stylesheet. | ||
| */ | ||
| function plvt_scope_animation_stylesheet_to_transition_type( string $css, string $transition_type ): string { | ||
| $indent = static function ( string $input, $indent_tabs = 1 ): string { | ||
| return implode( | ||
| "\n", | ||
| array_map( | ||
| static function ( string $line ) use ( $indent_tabs ): string { | ||
| return str_repeat( "\t", $indent_tabs ) . $line; | ||
| }, | ||
| explode( "\n", $input ) | ||
| ) | ||
| ); | ||
| }; | ||
|
|
||
| // This is very fragile, but it works well enough for now. TODO: Find a better solution to scope the CSS selectors. | ||
| if ( (bool) preg_match_all( '/(\s*)([^{}]+)\{[^{}]*?\}/m', $css, $matches ) ) { | ||
| // Wrap all `::view-transition-*` selectors to scope them to the transition type. | ||
| $view_transition_rule_pattern = '/::view-transition-/'; | ||
|
|
||
| foreach ( $matches[0] as $index => $match ) { | ||
| $rule = $match; | ||
| $rule_name = $matches[2][ $index ]; | ||
| if ( (bool) preg_match( $view_transition_rule_pattern, $rule_name ) ) { | ||
| $rule_whitespace = $matches[1][ $index ]; | ||
| $prefixed_rule_name = preg_replace( $view_transition_rule_pattern, '&\0', $rule_name ); | ||
| if ( null === $prefixed_rule_name ) { | ||
| continue; | ||
| } | ||
|
|
||
| $rule = str_replace( $rule_name, $prefixed_rule_name, $rule ); | ||
|
|
||
| if ( str_contains( $rule, "\n" ) ) { // Non-minified. | ||
| $rule = $rule_whitespace . | ||
| "html:active-view-transition-type({$transition_type}) {\n" . | ||
| $indent( substr( $rule, strlen( $rule_whitespace ) ), 1 ) . | ||
| "\n}"; | ||
| } else { // Minified. | ||
| $rule = $rule_whitespace . | ||
| "html:active-view-transition-type({$transition_type}){" . | ||
| substr( $rule, strlen( $rule_whitespace ) ) . | ||
| '}'; | ||
| } | ||
|
|
||
| // Replace the original rule with the wrapped/scoped one. | ||
| $css = str_replace( $match, $rule, $css ); | ||
| } | ||
| } | ||
| } | ||
| return $css; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When the special
*-chronological-paginationoption is selected,$args['default-animation']remains set to that value, but it is not a registered animation slug/alias in the animation registry. As a result, the default transition falls back to the browser default (fade) instead of the intended slide/swipe/wipe. Map$args['default-animation']to a real registry alias/slug (e.g. the base animation or a concrete direction) when enabling these special options.