Skip to content

Commit 73a5fec

Browse files
istarkovistarkov
committed
Ranges support
1 parent 9b9b4f7 commit 73a5fec

File tree

7 files changed

+564
-52
lines changed

7 files changed

+564
-52
lines changed

‎packages/sdk-components-animation/LICENSE-scroll-timeline‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎packages/sdk-components-animation/src/scroll.stories.tsx‎

Lines changed: 39 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { parseCssValue } from "@webstudio-is/css-data";
22
import { Scroll } from "./scroll";
33

4-
const DEBUG = true;
4+
const DEBUG = false;
55

66
export default {
77
title: "Components/Animate",
@@ -14,44 +14,46 @@ const Story = {
1414

1515
render() {
1616
return (
17-
<Scroll
18-
debug={DEBUG}
19-
action={{
20-
type: "scroll",
21-
animations: [
22-
{
23-
timing: {
24-
fill: "backwards",
25-
},
26-
keyframes: [
27-
{
28-
offset: 0,
29-
styles: {
30-
transform: parseCssValue(
31-
"transform",
32-
"translate(0, 100px)"
33-
),
34-
},
17+
<div>
18+
<Scroll
19+
debug={DEBUG}
20+
action={{
21+
type: "scroll",
22+
animations: [
23+
{
24+
timing: {
25+
fill: "backwards",
26+
rangeStart: ["start", { type: "unit", value: 0, unit: "%" }],
27+
rangeEnd: ["start", { type: "unit", value: 200, unit: "px" }],
3528
},
36-
],
37-
},
38-
],
39-
}}
40-
>
41-
<div
42-
style={{ height: "200px", width: "200px", backgroundColor: "red" }}
43-
></div>
44-
<div
45-
style={{
46-
height: "100px",
47-
width: "100px",
48-
backgroundColor: "yellow",
49-
position: "fixed",
50-
left: 0,
51-
top: 0,
29+
keyframes: [
30+
{
31+
offset: 0,
32+
styles: {
33+
transform: parseCssValue(
34+
"transform",
35+
"translate(0, 100px)"
36+
),
37+
},
38+
},
39+
],
40+
},
41+
],
5242
}}
53-
></div>
54-
</Scroll>
43+
>
44+
<div
45+
style={{
46+
height: "100px",
47+
width: "100px",
48+
backgroundColor: "yellow",
49+
position: "fixed",
50+
left: 0,
51+
top: 0,
52+
}}
53+
></div>
54+
</Scroll>
55+
<div style={{ height: "200vh" }}></div>
56+
</div>
5557
);
5658
},
5759
};

‎packages/sdk-components-animation/src/scroll.tsx‎

Lines changed: 59 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,85 @@ import { ClientOnly } from "./shared/client-only";
44
import { PolyfillLoader } from "./shared/scroll-polyfill";
55
import { DebugDelayLoader } from "./shared/debug-delay-loader";
66
import { escapeCssSpecifier } from "./shared/css-utils";
7-
import type { AnimationAction } from "./shared/animation-types";
7+
import type {
8+
AnimationAction,
9+
ScrollRangeValue,
10+
} from "./shared/animation-types";
811
import { findKeyframeStylesWithZeroOffset } from "./shared/keyframes";
912
import { hyphenateProperty, toValue } from "@webstudio-is/css-engine";
13+
import { getSourceElement } from "./shared/scroll";
1014

1115
const componentAttributeId = `data-ws-animate-id`;
1216

1317
const createSelector = (id: string) => `[${componentAttributeId}="${id}"] > *`;
1418

19+
const cartesian = <A, B>(a: A[], b: B[]) =>
20+
a.flatMap((x) => b.map((y) => [x, y] as const));
21+
22+
// See also WAAPI has bug https://issues.chromium.org/issues/40929569#comment9
23+
// so we are using calc even it it's not needed in some cases
24+
const getScrollRangeValue = ([name, value]: ScrollRangeValue) => {
25+
if (name === "start") {
26+
return `calc(0% + ${toValue(value)})`;
27+
}
28+
return `calc(100% - ${toValue(value)})`;
29+
};
30+
1531
const Animate = ({ id, action }: { id: string; action: AnimationAction }) => {
1632
useLayoutEffect(() => {
1733
const selector = createSelector(id);
1834
const elements = document.querySelectorAll(selector);
35+
1936
if (elements.length === 0) {
2037
return;
2138
}
22-
const disposables = Array.from(elements)
23-
.map((elt) => {
24-
return () => {};
2539

26-
if (elt instanceof HTMLElement) {
27-
const animation = elt.animate(
40+
const elementsAnimations = cartesian(
41+
Array.from(elements),
42+
action.animations
43+
);
44+
45+
const disposables = elementsAnimations
46+
.map(([element, animation]) => {
47+
if (element instanceof HTMLElement) {
48+
const source = getSourceElement(action.source ?? "root", element);
49+
50+
if (source === undefined) {
51+
return;
52+
}
53+
54+
const timeline = new ScrollTimeline({
55+
source,
56+
axis: action.axis ?? "block",
57+
});
58+
59+
const keyframeEffectOptoins: EffectTiming = {
60+
easing: animation.timing.easing,
61+
fill: animation.timing.fill,
62+
};
63+
64+
const rangeStart = animation.timing.rangeStart
65+
? getScrollRangeValue(animation.timing.rangeStart)
66+
: undefined;
67+
68+
const rangeEnd = animation.timing.rangeEnd
69+
? getScrollRangeValue(animation.timing.rangeEnd)
70+
: undefined;
71+
72+
const nativeAnimation = element.animate(
2873
[{ offset: 0, transform: "translate(0, 100px)" }],
2974
{
30-
fill: "backwards",
31-
duration: 400,
32-
easing: "linear",
75+
...keyframeEffectOptoins,
76+
// Scroll dependent options
77+
timeline,
78+
// @ts-expect-error missing in types
79+
rangeStart,
80+
rangeEnd,
3381
}
3482
);
3583

3684
return () => {
37-
animation.cancel();
85+
nativeAnimation.cancel();
3886
};
3987
}
4088
})
@@ -122,7 +170,7 @@ export const Scroll = ({ debug = false, children, action }: ScrollProps) => {
122170
<PolyfillLoader />
123171
{debug && <DebugDelayLoader />}
124172
</ErrorBoundary>
125-
<Animate id={id} />
173+
<Animate id={id} action={action} />
126174
</Suspense>
127175
</ClientOnly>
128176
<div {...{ [componentAttributeId]: id }} style={{ display: "contents" }}>

0 commit comments

Comments
 (0)