Skip to content
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

Jump to bottom

Split JS and CSS loading of the polyfill #217

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Split JS and CSS loading of the polyfill #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c956c8f
Load JS and CSS polyfill individually
bramus Jan 28, 2024
0dab2e7
Split off JS polyfill loading logic into its own file
bramus Jan 28, 2024
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
66 changes: 12 additions & 54 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,66 +12,24 @@
// See the License for the specific language governing permissions and
// limitations under the License.

import {
ScrollTimeline,
ViewTimeline,
} from "./scroll-timeline-base";
import {
animate,
elementGetAnimations,
documentGetAnimations,
ProxyAnimation
} from "./proxy-animation.js";

import { initCSSPolyfill } from "./scroll-timeline-css"
import { initJSPolyfill } from "./scroll-timeline-js"

function initPolyfill() {
// initCSSPolyfill returns true iff the host browser supports SDA
if (initCSSPolyfill()) {
return;
}

if ([...document.styleSheets].filter((s) => s.href !== null).length) {
console.warn(
'Non-Inline StyleSheets detected: ScrollTimeline polyfill currently only' +
' supports inline styles within style tags'
);
}
const jsPolyfillLoaded = initJSPolyfill();
const cssPolyfillLoaded = initCSSPolyfill();

if (
!Reflect.defineProperty(window, 'ScrollTimeline', { value: ScrollTimeline })
) {
throw Error(
'Error installing ScrollTimeline polyfill: could not attach ScrollTimeline to window'
);
}
if (
!Reflect.defineProperty(window, 'ViewTimeline', { value: ViewTimeline })
) {
throw Error(
'Error installing ViewTimeline polyfill: could not attach ViewTimeline to window'
);
if (jsPolyfillLoaded || jsPolyfillLoaded) {
console.log('ScrollTimeline Polyfill loaded');
}

if (
!Reflect.defineProperty(Element.prototype, 'animate', { value: animate })
) {
throw Error(
"Error installing ScrollTimeline polyfill: could not attach WAAPI's animate to DOM Element"
);
}
if (!Reflect.defineProperty(window, 'Animation', { value: ProxyAnimation })) {
throw Error('Error installing Animation constructor.');
}
if (!Reflect.defineProperty(Element.prototype, "getAnimations", { value: elementGetAnimations })) {
throw Error(
"Error installing ScrollTimeline polyfill: could not attach WAAPI's getAnimations to DOM Element"
);
}
if (!Reflect.defineProperty(document, "getAnimations", { value: documentGetAnimations })) {
throw Error(
"Error installing ScrollTimeline polyfill: could not attach WAAPI's getAnimations to document"
);
if (cssPolyfillLoaded) {
if ([...document.styleSheets].filter((s) => s.href !== null).length) {
console.warn(
'Non-Inline StyleSheets detected: ScrollTimeline polyfill currently only' +
' supports inline styles within style tags'
);
}
}
}

Expand Down
13 changes: 9 additions & 4 deletions src/scroll-timeline-css.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { ScrollTimeline, ViewTimeline, getScrollParent, calculateRange,

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Until we can get rid of the ScrollTimeline, ViewTimeline and ProxyAnimation imports I think the css polyfill will only work if the js polyfill was loaded. E.g. we use whether the returned animation is a ProxyAnimation to determine whether we need to set up a css scroll driven animation: https://github.com/flackr/scroll-timeline/blob/master/src/scroll-timeline-css.js#L157

We're similarly dependent on getAnimations being overridden to return the ProxyAnimation instances.

const parser = new StyleParser();

function initMutationObserver() {
function monitorAndParseStyleSheets() {
const sheetObserver = new MutationObserver((entries) => {
for (const entry of entries) {
for (const addedNode of entry.addedNodes) {
Expand Down Expand Up @@ -59,7 +59,7 @@ function relativePosition(phase, container, target, axis, optionsInset, percent)
return calculateRelativePosition(phaseRange, percent, coverRange);
}

function createScrollTimeline(anim, animationName, target) {
export function createScrollTimeline(anim, animationName, target) {
const animOptions = parser.getAnimationTimelineOptions(animationName, target);

if(!animOptions)
Expand Down Expand Up @@ -135,10 +135,11 @@ function updateKeyframesIfNecessary(anim, options) {
export function initCSSPolyfill() {
// Don't load if browser claims support
if (CSS.supports("animation-timeline: --works")) {
return true;
return false;
}

initMutationObserver();
// Monitor and parse the Style Sheets
monitorAndParseStyleSheets();

// Override CSS.supports() to claim support for the CSS properties from now on
const oldSupports = CSS.supports;
Expand All @@ -163,7 +164,11 @@ export function initCSSPolyfill() {
// invoke the set the timeline procedure on the existing animation.
anim.timeline = result.timeline;
}
} else {
console.info('Not a ScrollTimeline dinges');
}
});
});

return true;
}
69 changes: 69 additions & 0 deletions src/scroll-timeline-js.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the 'License');
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an 'AS IS' BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import {
ScrollTimeline,
ViewTimeline,
} from './scroll-timeline-base';
import {
animate,
elementGetAnimations,
documentGetAnimations,
ProxyAnimation
} from './proxy-animation.js';

export function initJSPolyfill() {
// Don’t load if the browser already has support
if ((typeof window.ScrollTimeline) !== 'undefined') {
return false;
}

if (
!Reflect.defineProperty(window, 'ScrollTimeline', { value: ScrollTimeline })
) {
throw Error(
'Error installing ScrollTimeline polyfill: could not attach ScrollTimeline to window'
);
}
if (
!Reflect.defineProperty(window, 'ViewTimeline', { value: ViewTimeline })
) {
throw Error(
'Error installing ViewTimeline polyfill: could not attach ViewTimeline to window'
);
}

if (
!Reflect.defineProperty(Element.prototype, 'animate', { value: animate })
) {
throw Error(
'Error installing ScrollTimeline polyfill: could not attach WAAPI’s animate to DOM Element'
);
}
if (!Reflect.defineProperty(window, 'Animation', { value: ProxyAnimation })) {
throw Error('Error installing Animation constructor.');
}
if (!Reflect.defineProperty(Element.prototype, 'getAnimations', { value: elementGetAnimations })) {
throw Error(
'Error installing ScrollTimeline polyfill: could not attach WAAPI’s getAnimations to DOM Element'
);
}
if (!Reflect.defineProperty(document, 'getAnimations', { value: documentGetAnimations })) {
throw Error(
'Error installing ScrollTimeline polyfill: could not attach WAAPI’s getAnimations to document'
);
}

return true;
}
Loading