-
Notifications
You must be signed in to change notification settings - Fork 102
feat(useMeasure): support custom measurers in order to support border-box and others #1603
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
Open
m-kolomoyets
wants to merge
5
commits into
react-hookz:master
Choose a base branch
from
m-kolomoyets:feat/use-measure-matcher
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
7141216
feat(use-measure): extended useMeasure hook to custom measures define…
m-kolomoyets 13d7c6c
docs(use-measure): added story and extended existing documentation wi…
m-kolomoyets 48e2cd4
fix(yarn.lock): yarn.lock formatting return
m-kolomoyets b9c84a7
fix(default-measure): added defaultMeasures variable to all scenarios
m-kolomoyets 34b5df0
fix(review): added measurers functions to comfy enable different box …
m-kolomoyets File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
import { Canvas, Meta, Story } from '@storybook/addon-docs' | ||
import { Example } from './example.stories' | ||
import { ImportPath } from '../../__docs__/ImportPath' | ||
|
||
<Meta title="Sensor/useMeasure" /> | ||
|
||
# useMeasure | ||
|
||
Uses ResizeObserver to track element dimensions and re-render component when they change. | ||
|
||
- Its ResizeObserver callback uses RAF debouncing, therefore it is pretty performant. | ||
- SSR friendly, returns `undefined` on initial mount. | ||
- Automatically creates ref for you, that you can easily pass to needed element. | ||
- Allows to dynamically enable and disable observation. | ||
- Allows to define the measures by custom `ResizeObserverEntry` matcher | ||
|
||
#### Example | ||
|
||
<Canvas isColumn> | ||
<Story name="Example" story={Example} /> | ||
</Canvas> | ||
|
||
## Reference | ||
|
||
```ts | ||
interface Measures { | ||
width: number; | ||
height: number; | ||
} | ||
|
||
function useMeasure<T extends Element>(enabled = true, observerEntryMatcher?: (entry: ResizeObserverEntry) => Measures | null): [Measures | undefined, React.RefObject<T>]; | ||
``` | ||
|
||
#### Importing | ||
|
||
<ImportPath /> | ||
|
||
#### Arguments | ||
|
||
- **enabled** _`boolean`_ _(default: `true`)_ - Whether resize observer is enabled or not. | ||
- **observerEntryMatcher** _`((entry: ResizeObserverEntry) => Measures | null) | undefined`_ _(default: `undefined`)_ - A custom matcher function to define the measures. | ||
- If returns `null` - default `contentRect` measures are applied | ||
|
||
#### Return | ||
|
||
Array of two elements: | ||
|
||
- **0** _`Measures | undefined`_ - Width and height of the tracked element's `contentRect` | ||
- **1** _`RefObject<T>`_ - Ref object that should be passed to tracked element |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.