react-hookz / web

React hooks done right, for browser and SSR.
https://react-hookz.github.io/web/
MIT License
1.92k stars 92 forks source link

`useMeasure` hook elements box-sizing option #1548

Open m-kolomoyets opened 6 months ago

m-kolomoyets commented 6 months ago

New Features

Current implementation of the useMeasure hook calculates the element bounds based on content-box model. It is a little unexpected behaviour when the project and all the layout is based on border-box model. Thus, current hook ignores paddings calculating element's width and height.

What is the new or updated feature that you are suggesting?

Suggesting adding the additional hook input parameter which has to define whether calculate content-box or border-box of the element.

Example of code calculating the border-box based content size:

//...
const [observerHandler] = useRafCallback<UseResizeObserverCallback>((entry) => {
    setMeasures({
        height: entry.borderBoxSize[0].blockSize,
        width: entry.borderBoxSize[0].inlineSize,
     });
});
// ...

And extend this logic into current calculation:

const [observerHandler] = useRafCallback<UseResizeObserverCallback>((entry) => {
    // For example:
    if (boxSizing === 'border-box') {
         setMeasures({
            height: entry.borderBoxSize[0].blockSize,
            width: entry.borderBoxSize[0].inlineSize,
         });
     } else {
         setMeasures({ width: entry.contentRect.width, height: entry.contentRect.height });
    }
});

Why should this feature be included?

Mostly border-box model is used, and content-box calculations are unexpected behaviour as expected to calculate the box-sizing model needed. Makes sense to add optional parameter to override the initial box-sizing model of the calculation to prevent unexpected miscalculations and debugging.

xobotyi commented 5 days ago

IMO it should be done the other way. user must be able to provide matcher - function that matches captured ResizeObserverEntry to our height\width