Skip to content

feat: add clientWidth/clientHeight for createElementSize #804

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: add clientWidth/clientHeight for createElementSize #804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 13 additions & 4 deletions packages/resize-observer/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ export type ResizeHandler<T extends Element = Element> = (
) => void;

export type Size = { width: number; height: number };
export type NullableSize = { width: number; height: number } | { width: null; height: null };
type SizeWithClient = Size & { clientWidth: number; clientHeight: number };
export type NullableSize =
| SizeWithClient
| { width: null; height: null; clientWidth: null; clientHeight: null };

/**
* Instantiate a new ResizeObserver that automatically get's disposed on cleanup.
Expand Down Expand Up @@ -139,7 +142,12 @@ export function createWindowSize(): Readonly<Size> {
export const useWindowSize: typeof createWindowSize =
/*#__PURE__*/ createHydratableSingletonRoot(createWindowSize);

const ELEMENT_SIZE_FALLBACK = { width: null, height: null } as const satisfies NullableSize;
const ELEMENT_SIZE_FALLBACK = {
width: null,
height: null,
clientWidth: null,
clientHeight: null,
} as const satisfies NullableSize;

/**
* @param target html element
Expand All @@ -150,7 +158,8 @@ export function getElementSize(target: Element | false | undefined | null): Null
return { ...ELEMENT_SIZE_FALLBACK };
}
const { width, height } = target.getBoundingClientRect();
return { width, height };
const { clientWidth, clientHeight } = target;
return { width, height, clientWidth, clientHeight };
}

/**
Expand All @@ -163,7 +172,7 @@ export function getElementSize(target: Element | false | undefined | null): Null
* console.log(size.width, size.height)
* })
*/
export function createElementSize(target: Element): Readonly<Size>;
export function createElementSize(target: Element): SizeWithClient;
export function createElementSize(
target: Accessor<Element | false | undefined | null>,
): Readonly<NullableSize>;
Expand Down
14 changes: 12 additions & 2 deletions packages/resize-observer/test/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,18 @@ describe("getWindowSize", () => {

describe("getElementSize", () => {
test("returns window size", () => {
expect(getElementSize(document.createElement("div"))).toEqual({ width: 0, height: 0 });
expect(getElementSize(undefined)).toEqual({ width: null, height: null });
expect(getElementSize(document.createElement("div"))).toEqual({
width: 0,
height: 0,
clientWidth: 0,
clientHeight: 0,
});
expect(getElementSize(undefined)).toEqual({
width: null,
height: null,
clientWidth: null,
clientHeight: null,
});
});
});

Expand Down