mirror of
https://github.com/streamich/react-use.git
synced 2025-12-08 18:02:14 +00:00
125c7e96a1
* feat: useScrollbarWidth hook; * chore: bump @xobotyi/scrollbar-width to 1.5.0 and add it to dependencies. * fix: remove @xobotyi/scrollbar-width from dev-deps.
26 lines
637 B
Markdown
26 lines
637 B
Markdown
# `useScrollbarWidth`
|
|
|
|
Hook that will return current browser's scrollbar width.
|
|
In case hook been called before DOM ready, it will return `undefined` and will cause re-render on first available RAF.
|
|
> **_NOTE:_** it does not work (return 0) for mobile devices, because their scrollbar width can not be determined.
|
|
|
|
## Usage
|
|
|
|
```jsx
|
|
const Demo = () => {
|
|
const sbw = useScrollbarWidth();
|
|
|
|
return (
|
|
<div>
|
|
{sbw === undefined ? `DOM is not ready yet, SBW detection delayed` : `Browser's scrollbar width is ${sbw}px`}
|
|
</div>
|
|
);
|
|
};
|
|
```
|
|
|
|
## Reference
|
|
|
|
```typescript
|
|
const sbw: number | undefined = useScrollbarWidth();
|
|
```
|