dom/webidl/IntersectionObserver.webidl
author Tobias Schneider <schneider@jancona.com>
Fri, 28 Oct 2016 10:24:00 -0400
changeset 320201 72e781308ebf6a06c65a4400c28c4ad813bd1081
parent 319614 c55a20f1422bc61b290cbbc2f1630b08d437875c
permissions -rw-r--r--
Bug 1243846 - Implement Intersection Observer API. r=mrbkap, r=mstange

/* -*- 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://wicg.github.io/IntersectionObserver/
 */

[ProbablyShortLivingObject]
interface IntersectionObserverEntry {
  [Constant]
  readonly attribute DOMHighResTimeStamp time;
  [Constant]
  readonly attribute DOMRectReadOnly? rootBounds;
  [Constant]
  readonly attribute DOMRectReadOnly boundingClientRect;
  [Constant]
  readonly attribute DOMRectReadOnly intersectionRect;
  [Constant]
  readonly attribute double intersectionRatio;
  [Constant]
  readonly attribute Element target;
};

[Constructor(IntersectionCallback intersectionCallback,
             optional IntersectionObserverInit options)]
interface IntersectionObserver {
  [Constant]
  readonly attribute Element? root;
  [Constant]
  readonly attribute DOMString rootMargin;
  [Constant,Cached]
  readonly attribute sequence<double> thresholds;
  void observe(Element target);
  void unobserve(Element target);
  void disconnect();
  sequence<IntersectionObserverEntry> takeRecords();

  [ChromeOnly]
  readonly attribute IntersectionCallback intersectionCallback;
};

callback IntersectionCallback =
  void (sequence<IntersectionObserverEntry> entries, IntersectionObserver observer);

dictionary IntersectionObserverEntryInit {
  required DOMHighResTimeStamp time;
  required DOMRectInit rootBounds;
  required DOMRectInit boundingClientRect;
  required DOMRectInit intersectionRect;
  required Element target;
};

dictionary IntersectionObserverInit {
  Element?  root = null;
  DOMString rootMargin = "0px";
  (double or sequence<double>) threshold = 0;
};