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.

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

Add resize observer #948

Merged
merged 9 commits into from
Dec 12, 2020
54 changes: 54 additions & 0 deletions baselines/dom.generated.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1587,6 +1587,10 @@ interface RequestInit {
window?: any;
}

interface ResizeObserverOptions {
box?: ResizeObserverBoxOptions;
}

interface ResponseInit {
headers?: HeadersInit;
status?: number;
Expand Down Expand Up @@ -12642,6 +12646,51 @@ declare var Request: {
new(input: RequestInfo, init?: RequestInit): Request;
};

interface ResizeObservation {
readonly lastReportedSizes: ReadonlyArray<ResizeObserverSize>;
readonly observedBox: ResizeObserverBoxOptions;
readonly target: Element;
}

declare var ResizeObservation: {
prototype: ResizeObservation;
new(target: Element): ResizeObservation;
};

interface ResizeObserver {
disconnect(): void;
observe(target: Element, options?: ResizeObserverOptions): void;
unobserve(target: Element): void;
}

declare var ResizeObserver: {
prototype: ResizeObserver;
new(callback: ResizeObserverCallback): ResizeObserver;
};

interface ResizeObserverEntry {
readonly borderBoxSize: ReadonlyArray<ResizeObserverSize>;
readonly contentBoxSize: ReadonlyArray<ResizeObserverSize>;
readonly contentRect: DOMRectReadOnly;
readonly devicePixelContentBoxSize: ReadonlyArray<ResizeObserverSize>;
timocov marked this conversation as resolved.
Show resolved Hide resolved
readonly target: Element;
}

declare var ResizeObserverEntry: {
prototype: ResizeObserverEntry;
new(): ResizeObserverEntry;
};

interface ResizeObserverSize {
readonly blockSize: number;
readonly inlineSize: number;
}

declare var ResizeObserverSize: {
prototype: ResizeObserverSize;
new(): ResizeObserverSize;
};

/** This Fetch API interface represents the response to a request. */
interface Response extends Body {
readonly headers: Headers;
Expand Down Expand Up @@ -19281,6 +19330,10 @@ interface ReadableStreamErrorCallback {
(reason: any): void | PromiseLike<void>;
}

interface ResizeObserverCallback {
(entries: ReadonlyArray<ResizeObserverEntry>, observer: ResizeObserver): void;
}

interface TransformStreamDefaultControllerCallback<O> {
(controller: TransformStreamDefaultController<O>): void | PromiseLike<void>;
}
Expand Down Expand Up @@ -20113,6 +20166,7 @@ type RequestDestination = "" | "audio" | "audioworklet" | "document" | "embed" |
type RequestMode = "cors" | "navigate" | "no-cors" | "same-origin";
type RequestRedirect = "error" | "follow" | "manual";
type ResidentKeyRequirement = "discouraged" | "preferred" | "required";
type ResizeObserverBoxOptions = "border-box" | "content-box" | "device-pixel-content-box";
type ResizeQuality = "high" | "low" | "medium" | "pixelated";
type ResponseType = "basic" | "cors" | "default" | "error" | "opaque" | "opaqueredirect";
type ScopedCredentialType = "ScopedCred";
Expand Down
39 changes: 39 additions & 0 deletions inputfiles/idl/Resize Observer.widl
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
enum ResizeObserverBoxOptions {
"border-box", "content-box", "device-pixel-content-box"
};

dictionary ResizeObserverOptions {
ResizeObserverBoxOptions box = "content-box";
};

[Exposed=(Window),
Constructor(ResizeObserverCallback callback)]
interface ResizeObserver {
void observe(Element target, optional ResizeObserverOptions options);
void unobserve(Element target);
void disconnect();
};

callback ResizeObserverCallback = void (FrozenArray<ResizeObserverEntry> entries, ResizeObserver observer);

[Exposed=Window]
interface ResizeObserverEntry {
readonly attribute Element target;
readonly attribute DOMRectReadOnly contentRect;
readonly attribute FrozenArray<ResizeObserverSize> borderBoxSize;
readonly attribute FrozenArray<ResizeObserverSize> contentBoxSize;
readonly attribute FrozenArray<ResizeObserverSize> devicePixelContentBoxSize;
};

interface ResizeObserverSize {
readonly attribute unrestricted double inlineSize;
readonly attribute unrestricted double blockSize;
};

[Constructor(Element target)
]
interface ResizeObservation {
readonly attribute Element target;
readonly attribute ResizeObserverBoxOptions observedBox;
readonly attribute FrozenArray<ResizeObserverSize> lastReportedSizes;
};
4 changes: 4 additions & 0 deletions inputfiles/idlSources.json
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,10 @@
"url": "https://www.w3.org/TR/referrer-policy/",
"title": "Referrer Policy"
},
{
"url": "https://www.w3.org/TR/resize-observer/",
timocov marked this conversation as resolved.
Show resolved Hide resolved
"title": "Resize Observer"
},
{
"url": "https://w3c.github.io/resource-timing/",
"title": "Resource Timing"
Expand Down