Skip to content

Commit 4ff02dc

Browse files
armanbilgearmanbilge
authored
Merge pull request #694 from chrisshafer/cs/add-resize-observer
Add Façade Types to Support ResizeObserver
2 parents a6bc7c7 + a0b2346 commit 4ff02dc

10 files changed

+213
-19
lines changed

‎api-reports/2_12.txt

+35-6
Original file line numberDiff line numberDiff line change
@@ -1237,14 +1237,28 @@ DOMList[SO] def iterator: Iterator[T]
12371237
DOMList[SO] def length: Int
12381238
DOMList[SO] def next(): T
12391239
DOMParser[JC] def parseFromString(string: String, mimeType: MIMEType): Document
1240-
DOMRect[JC] var bottom: Double
1241-
DOMRect[JC] var height: Double
1242-
DOMRect[JC] var left: Double
1243-
DOMRect[JC] var right: Double
1244-
DOMRect[JC] var top: Double
1245-
DOMRect[JC] var width: Double
1240+
DOMRect[JC] def bottom: Double
1241+
DOMRect[JC] def height: Double
1242+
DOMRect[JC] def height_ = (height: Double): Unit
1243+
DOMRect[JC] def left: Double
1244+
DOMRect[JC] def right: Double
1245+
DOMRect[JC] def top: Double
1246+
DOMRect[JC] def width: Double
1247+
DOMRect[JC] def width_ = (width: Double): Unit
1248+
DOMRect[JC] def x: Double
1249+
DOMRect[JC] def x_ = (x: Double): Unit
1250+
DOMRect[JC] def y: Double
1251+
DOMRect[JC] def y_ = (y: Double): Unit
12461252
DOMRectList[JC] @JSBracketAccess def apply(index: Int): T
12471253
DOMRectList[JC] def length: Int
1254+
DOMRectReadOnly[JT] def bottom: Double
1255+
DOMRectReadOnly[JT] def height: Double
1256+
DOMRectReadOnly[JT] def left: Double
1257+
DOMRectReadOnly[JT] def right: Double
1258+
DOMRectReadOnly[JT] def top: Double
1259+
DOMRectReadOnly[JT] def width: Double
1260+
DOMRectReadOnly[JT] def x: Double
1261+
DOMRectReadOnly[JT] def y: Double
12481262
DOMSettableTokenList[JT] def add(token: String): Unit
12491263
DOMSettableTokenList[JT] @JSBracketAccess def apply(index: Int): T
12501264
DOMSettableTokenList[JT] def contains(token: String): Boolean
@@ -15948,6 +15962,21 @@ RequestType[SO] val script: RequestType
1594815962
RequestType[SO] val style: RequestType
1594915963
RequestType[SO] val track: RequestType
1595015964
RequestType[SO] val video: RequestType
15965+
ResizeObserver[JC] def disconnect(): Unit
15966+
ResizeObserver[JC] def observe(target: Element): Unit
15967+
ResizeObserver[JC] def observe(target: Element, options: ResizeObserverOptions): Unit
15968+
ResizeObserver[JC] def unobserve(target: Element): Unit
15969+
ResizeObserverBoxOption[JT]
15970+
ResizeObserverBoxOption[SO] val `border-box`: ResizeObserverBoxOption
15971+
ResizeObserverBoxOption[SO] val `content-box`: ResizeObserverBoxOption
15972+
ResizeObserverBoxOption[SO] val `device-pixel-content-box`: ResizeObserverBoxOption
15973+
ResizeObserverEntry[JT] def borderBoxSize: js.Array[ResizeObserverSize]
15974+
ResizeObserverEntry[JT] def contentBoxSize: js.Array[ResizeObserverSize]
15975+
ResizeObserverEntry[JT] def contentRect: DOMRectReadOnly
15976+
ResizeObserverEntry[JT] def target: Element
15977+
ResizeObserverOptions[JT] var box: js.UndefOr[ResizeObserverBoxOption]
15978+
ResizeObserverSize[JT] def blockSize: Double
15979+
ResizeObserverSize[JT] def inlineSize: Double
1595115980
Response[JC] def arrayBuffer(): js.Promise[ArrayBuffer]
1595215981
Response[JC] def blob(): js.Promise[Blob]
1595315982
Response[JC] val body: ReadableStream[Uint8Array]

‎api-reports/2_13.txt

+35-6
Original file line numberDiff line numberDiff line change
@@ -1237,14 +1237,28 @@ DOMList[SO] def iterator: Iterator[T]
12371237
DOMList[SO] def length: Int
12381238
DOMList[SO] def next(): T
12391239
DOMParser[JC] def parseFromString(string: String, mimeType: MIMEType): Document
1240-
DOMRect[JC] var bottom: Double
1241-
DOMRect[JC] var height: Double
1242-
DOMRect[JC] var left: Double
1243-
DOMRect[JC] var right: Double
1244-
DOMRect[JC] var top: Double
1245-
DOMRect[JC] var width: Double
1240+
DOMRect[JC] def bottom: Double
1241+
DOMRect[JC] def height: Double
1242+
DOMRect[JC] def height_ = (height: Double): Unit
1243+
DOMRect[JC] def left: Double
1244+
DOMRect[JC] def right: Double
1245+
DOMRect[JC] def top: Double
1246+
DOMRect[JC] def width: Double
1247+
DOMRect[JC] def width_ = (width: Double): Unit
1248+
DOMRect[JC] def x: Double
1249+
DOMRect[JC] def x_ = (x: Double): Unit
1250+
DOMRect[JC] def y: Double
1251+
DOMRect[JC] def y_ = (y: Double): Unit
12461252
DOMRectList[JC] @JSBracketAccess def apply(index: Int): T
12471253
DOMRectList[JC] def length: Int
1254+
DOMRectReadOnly[JT] def bottom: Double
1255+
DOMRectReadOnly[JT] def height: Double
1256+
DOMRectReadOnly[JT] def left: Double
1257+
DOMRectReadOnly[JT] def right: Double
1258+
DOMRectReadOnly[JT] def top: Double
1259+
DOMRectReadOnly[JT] def width: Double
1260+
DOMRectReadOnly[JT] def x: Double
1261+
DOMRectReadOnly[JT] def y: Double
12481262
DOMSettableTokenList[JT] def add(token: String): Unit
12491263
DOMSettableTokenList[JT] @JSBracketAccess def apply(index: Int): T
12501264
DOMSettableTokenList[JT] def contains(token: String): Boolean
@@ -15948,6 +15962,21 @@ RequestType[SO] val script: RequestType
1594815962
RequestType[SO] val style: RequestType
1594915963
RequestType[SO] val track: RequestType
1595015964
RequestType[SO] val video: RequestType
15965+
ResizeObserver[JC] def disconnect(): Unit
15966+
ResizeObserver[JC] def observe(target: Element): Unit
15967+
ResizeObserver[JC] def observe(target: Element, options: ResizeObserverOptions): Unit
15968+
ResizeObserver[JC] def unobserve(target: Element): Unit
15969+
ResizeObserverBoxOption[JT]
15970+
ResizeObserverBoxOption[SO] val `border-box`: ResizeObserverBoxOption
15971+
ResizeObserverBoxOption[SO] val `content-box`: ResizeObserverBoxOption
15972+
ResizeObserverBoxOption[SO] val `device-pixel-content-box`: ResizeObserverBoxOption
15973+
ResizeObserverEntry[JT] def borderBoxSize: js.Array[ResizeObserverSize]
15974+
ResizeObserverEntry[JT] def contentBoxSize: js.Array[ResizeObserverSize]
15975+
ResizeObserverEntry[JT] def contentRect: DOMRectReadOnly
15976+
ResizeObserverEntry[JT] def target: Element
15977+
ResizeObserverOptions[JT] var box: js.UndefOr[ResizeObserverBoxOption]
15978+
ResizeObserverSize[JT] def blockSize: Double
15979+
ResizeObserverSize[JT] def inlineSize: Double
1595115980
Response[JC] def arrayBuffer(): js.Promise[ArrayBuffer]
1595215981
Response[JC] def blob(): js.Promise[Blob]
1595315982
Response[JC] val body: ReadableStream[Uint8Array]

‎dom/src/main/scala-2/org/scalajs/dom/ResizeObserverBoxOption.scala

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
5+
/** ResizeObserverOptions [[https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver/observe]] */
6+
@js.native
7+
sealed trait ResizeObserverBoxOption extends js.Any
8+
9+
object ResizeObserverBoxOption {
10+
val `content-box`: ResizeObserverBoxOption = "content-box".asInstanceOf[ResizeObserverBoxOption]
11+
val `border-box`: ResizeObserverBoxOption = "border-box".asInstanceOf[ResizeObserverBoxOption]
12+
val `device-pixel-content-box`: ResizeObserverBoxOption = "device-pixel-content-box".asInstanceOf[ResizeObserverBoxOption]
13+
}

‎dom/src/main/scala-3/org/scalajs/dom/ResizeObserverBoxOption.scala

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
5+
/** ResizeObserverOptions [[https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver/observe]] */
6+
opaque type ResizeObserverBoxOption <: String = String
7+
8+
object ResizeObserverBoxOption {
9+
val `content-box`: ResizeObserverBoxOption = "content-box"
10+
val `border-box`: ResizeObserverBoxOption = "border-box"
11+
val `device-pixel-content-box`: ResizeObserverBoxOption = "device-pixel-content-box"
12+
}

‎dom/src/main/scala/org/scalajs/dom/DOMRect.scala

+6-7
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,12 @@ package org.scalajs.dom
99
import scala.scalajs.js
1010
import scala.scalajs.js.annotation._
1111

12+
/** A DOMRect describes the size and position of a rectangle. */
1213
@js.native
1314
@JSGlobal
14-
class DOMRect extends js.Object {
15-
var left: Double = js.native
16-
var width: Double = js.native
17-
var right: Double = js.native
18-
var top: Double = js.native
19-
var bottom: Double = js.native
20-
var height: Double = js.native
15+
class DOMRect extends DOMRectReadOnly {
16+
def width_=(width: Double): Unit = js.native
17+
def height_=(height: Double): Unit = js.native
18+
def x_=(x: Double): Unit = js.native
19+
def y_=(y: Double): Unit = js.native
2120
}

‎dom/src/main/scala/org/scalajs/dom/DOMRectReadOnly.scala

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
5+
@js.native
6+
trait DOMRectReadOnly extends js.Object {
7+
8+
/** The x coordinate of the DOMRect's origin. */
9+
def x: Double = js.native
10+
11+
/** The y coordinate of the DOMRect's origin. */
12+
def y: Double = js.native
13+
14+
/** The width of the DOMRect. */
15+
def width: Double = js.native
16+
17+
/** The height of the DOMRect. */
18+
def height: Double = js.native
19+
20+
/** Returns the top coordinate value of the DOMRect (usually the same as y.) */
21+
def top: Double = js.native
22+
23+
/** Returns the right coordinate value of the DOMRect (usually the same as x + width). */
24+
def right: Double = js.native
25+
26+
/** Returns the bottom coordinate value of the DOMRect (usually the same as y + height) */
27+
def bottom: Double = js.native
28+
29+
/** Returns the left coordinate value of the DOMRect (usually the same as x) */
30+
def left: Double = js.native
31+
}

‎dom/src/main/scala/org/scalajs/dom/ResizeObserver.scala

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
import scala.scalajs.js.annotation.JSGlobal
5+
6+
/** The ResizeObserver constructor creates a new ResizeObserver object, which can be used to report changes to the
7+
* content or border box of an Element or the bounding box of an SVGElement
8+
*
9+
* @param callback
10+
* The function called whenever an observed resize occurs.
11+
*/
12+
@js.native
13+
@JSGlobal
14+
class ResizeObserver(callback: js.Function2[js.Array[ResizeObserverEntry], ResizeObserver, _]) extends js.Object {
15+
16+
/** Starts observing the specified Element or SVGElement. */
17+
def observe(target: Element): Unit = js.native
18+
def observe(target: Element, options: ResizeObserverOptions): Unit = js.native
19+
20+
/** Unobserves all observed Element or SVGElement targets. */
21+
def disconnect(): Unit = js.native
22+
23+
/** Ends the observing of a specified Element or SVGElement. */
24+
def unobserve(target: Element): Unit = js.native
25+
}

‎dom/src/main/scala/org/scalajs/dom/ResizeObserverEntry.scala

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
5+
/** The ResizeObserverEntry interface represents the object passedto the ResizeObserver() constructor's callback
6+
* function, which allows you to access the new dimensions of the Element or SVGElement being observed.
7+
*/
8+
@js.native
9+
trait ResizeObserverEntry extends js.Object {
10+
11+
/** A reference to the Element or SVGElement being observed */
12+
def target: Element = js.native
13+
14+
/** An array containing objects with the new border box size of the observed element. The array is necessary to
15+
* support elements that have multiple fragments, which occur in multi-column scenarios.
16+
*/
17+
def borderBoxSize: js.Array[ResizeObserverSize] = js.native
18+
19+
/** An array containing objects with the new content box size of the observed element. The array is necessary to
20+
* support elements that have multiple fragments, which occur in multi-column scenarios.
21+
*/
22+
def contentBoxSize: js.Array[ResizeObserverSize] = js.native
23+
24+
/** A [[DOMRectReadOnly]] object containing the new size of the observed element when the callback is run. Note that
25+
* this is better supported than the above two properties, but it is left over from an earlier implementation of the
26+
* Resize Observer API, is still included in the spec for web compat reasons, and may be deprecated in future
27+
* versions.
28+
*/
29+
def contentRect: DOMRectReadOnly = js.native
30+
}

‎dom/src/main/scala/org/scalajs/dom/ResizeObserverOptions.scala

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
5+
trait ResizeObserverOptions extends js.Object {
6+
var box: js.UndefOr[ResizeObserverBoxOption] = js.undefined
7+
}

‎dom/src/main/scala/org/scalajs/dom/ResizeObserverSize.scala

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
5+
@js.native
6+
trait ResizeObserverSize extends js.Object {
7+
8+
/** The length of the observed element's border box in the block dimension. For boxes with a horizontal writing-mode,
9+
* this is the vertical dimension, or height; if the writing-mode is vertical, this is the horizontal dimension, or
10+
* width.
11+
*/
12+
def blockSize: Double = js.native
13+
14+
/** The length of the observed element's border box in the inline dimension. For boxes with a horizontal writing-mode,
15+
* this is the horizontal dimension, or width; if the writing-mode is vertical, this is the vertical dimension, or
16+
* height.
17+
*/
18+
def inlineSize: Double = js.native
19+
}

0 commit comments

Comments
 (0)