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

Use ResizeObserver if supported #22

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,23 @@ function useDimensions({
}, []);

useLayoutEffect(() => {
if (node) {
const measure = () =>
window.requestAnimationFrame(() =>
setDimensions(getDimensionObject(node))
);
measure();

if (liveMeasure) {
if (!node) {
return
}

const measure = () =>
window.requestAnimationFrame(() =>
setDimensions(getDimensionObject(node))
);
measure();

if (liveMeasure) {
if ('ResizeObserver' in window) {
const resizeObserver = new ResizeObserver(measure)
resizeObserver.observe(node)

return resizeObserver.disconnect
} else {
window.addEventListener("resize", measure);
window.addEventListener("scroll", measure);

Expand Down
47 changes: 47 additions & 0 deletions src/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,50 @@ export type UseDimensionsHook = [
export interface UseDimensionsArgs {
liveMeasure?: boolean;
}

export interface IResizeObserver {
/**
* Adds target to the list of observed elements.
*/
observe: (target: Element) => void

/**
* Removes target from the list of observed elements.
*/
unobserve: (target: Element) => void

/**
* Clears both the observationTargets and activeTargets lists.
*/
disconnect: () => void
new (callback: ResizeObserverCallback): this
}

/**
* This callback delivers ResizeObserver's notifications. It is invoked by a
* broadcast active observations algorithm.
*/
type ResizeObserverCallback = (
entries: readonly IResizeObserverEntry[],
observer: IResizeObserver
) => void

interface IResizeObserverEntry {
/**
* The Element whose size has changed.
*/
readonly target: Element

/**
* Element's content rect when ResizeObserverCallback is invoked.
*/
readonly contentRect: DOMRectReadOnly
/**
* @param target The Element whose size has changed.
*/
new (target: Element): this
}

declare global {
const ResizeObserver: IResizeObserver
}