[useAnchorPositioning] Add OffsetFunction for sideOffset and alignOffset
#1223
Conversation
This file contains 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
atomiks
added
component: select
Netlify deploy preview |
atomiks
commented
Dec 24, 2024
Comment on lines
125
to
128
| // Keep these reactive if they're not functions | ||
| const sideOffsetDep = typeof sideOffset !== 'function' ? sideOffset : 0; | ||
| const alignOffsetDep = typeof alignOffset !== 'function' ? alignOffset : 0; | ||
|
|
There was a problem hiding this comment.
Positioning reactivity is lost when they specify a function. We can't tell if they're going to React.useCallback or not - usually the function gets inlined like:
<Popover.Positioner sideOffset={(sizes) => sizes.anchor.height / 2}>So it can't be specified as a dependency as it's always changing. This means if they update the math inside the function, the position won't update live on fast refresh (but it will whenever the anchoring updates at some point)
atomiks
commented
Dec 24, 2024
Comment on lines
+21
to
+23
| "type": "number | (data) => number", | ||
| "default": "0", | ||
| "description": "Distance between the anchor and the popup." | ||
| "description": "Distance between the anchor and the popup in pixels.\nAlso accepts a function that returns a number to read the dimensions of the anchor and popup,\nalong with its side and alignment.\n\n- `data.anchor`: the dimensions of the anchor element with properties `width` and `height`.\n- `data.popup`: the dimensions of the popup element with properties `width` and `height`.\n- `data.side`: which side of the anchor element the popup is aligned against.\n- `data.align`: how the popup is aligned relative to the specified side." |
atomiks
commented
Dec 24, 2024
| side: getLogicalSide(sideParam, getSide(currentPlacement), isRtl), | ||
| align: getAlignment(currentPlacement) || 'center', | ||
| anchor: { width: rects.reference.width, height: rects.reference.height }, | ||
| popup: { width: rects.floating.width, height: rects.floating.height }, |
There was a problem hiding this comment.
Technically this is the Positioner element, not Popup, but in practically every case they should be the same since it's a presentational wrapper
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #1195