summaryrefslogtreecommitdiffstats
path: root/dom/webidl/Animation.webidl
diff options
context:
space:
mode:
Diffstat (limited to 'dom/webidl/Animation.webidl')
-rw-r--r--dom/webidl/Animation.webidl70
1 files changed, 70 insertions, 0 deletions
diff --git a/dom/webidl/Animation.webidl b/dom/webidl/Animation.webidl
new file mode 100644
index 0000000000..ae4403380c
--- /dev/null
+++ b/dom/webidl/Animation.webidl
@@ -0,0 +1,70 @@
+/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * The origin of this IDL file is
+ * https://drafts.csswg.org/web-animations/#animation
+ *
+ * Copyright © 2015 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C
+ * liability, trademark and document use rules apply.
+ */
+
+enum AnimationPlayState { "idle", "running", "paused", "finished" };
+
+enum AnimationReplaceState { "active", "removed", "persisted" };
+
+[Exposed=Window]
+interface Animation : EventTarget {
+ [Throws]
+ constructor(optional AnimationEffect? effect = null,
+ optional AnimationTimeline? timeline);
+
+ attribute DOMString id;
+ [Func="Document::IsWebAnimationsEnabled", Pure]
+ attribute AnimationEffect? effect;
+ // Bug 1676794. Drop BinaryName once we support ScrollTimeline interface.
+ [Func="Document::AreWebAnimationsTimelinesEnabled",
+ BinaryName="timelineFromJS"]
+ attribute AnimationTimeline? timeline;
+
+ [BinaryName="startTimeAsDouble"]
+ attribute double? startTime;
+ [SetterThrows, BinaryName="currentTimeAsDouble"]
+ attribute double? currentTime;
+
+ attribute double playbackRate;
+ [BinaryName="playStateFromJS"]
+ readonly attribute AnimationPlayState playState;
+ [BinaryName="pendingFromJS"]
+ readonly attribute boolean pending;
+ [Pref="dom.animations-api.autoremove.enabled"]
+ readonly attribute AnimationReplaceState replaceState;
+ [Func="Document::IsWebAnimationsEnabled", Throws]
+ readonly attribute Promise<Animation> ready;
+ [Func="Document::IsWebAnimationsEnabled", Throws]
+ readonly attribute Promise<Animation> finished;
+ attribute EventHandler onfinish;
+ attribute EventHandler oncancel;
+ [Pref="dom.animations-api.autoremove.enabled"]
+ attribute EventHandler onremove;
+ undefined cancel();
+ [Throws]
+ undefined finish();
+ [Throws, BinaryName="playFromJS"]
+ undefined play();
+ [Throws, BinaryName="pauseFromJS"]
+ undefined pause();
+ undefined updatePlaybackRate (double playbackRate);
+ [Throws]
+ undefined reverse();
+ [Pref="dom.animations-api.autoremove.enabled"]
+ undefined persist();
+ [CEReactions, Pref="dom.animations-api.autoremove.enabled", Throws]
+ undefined commitStyles();
+};
+
+// Non-standard extensions
+partial interface Animation {
+ [ChromeOnly] readonly attribute boolean isRunningOnCompositor;
+};