Skip to content
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

Document getAnchorRect prop for Popover component. #17709

Merged
merged 3 commits into from
Apr 9, 2020
Merged

Document getAnchorRect prop for Popover component. #17709

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
50f1775
Document getAnchorRect prop for Popover component.
desaiuditd Oct 2, 2019
546db6a
Merge branch 'master' into add/documentation-for-getanchorrect-prop-f…
desaiuditd Dec 4, 2019
5b92ace
Merge branch 'master' into add/documentation-for-getanchorrect-prop-f…
desaiuditd Apr 5, 2020
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
13 changes: 12 additions & 1 deletion packages/components/src/popover/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,22 @@ Opt-in prop to show popovers fullscreen on mobile, pass `false` in this prop to

### anchorRect

A custom `DOMRect` object at which to position the popover.
A custom `DOMRect` object at which to position the popover. `anchorRect` is used when the position (custom `DOMRect` object) of the popover needs to be fixed at one location all the time.

- Type: `DOMRect`
- Required: No

### getAnchorRect

A callback function which is used to override the anchor value computation algorithm. `anchorRect` will take precedence over this prop, if both are passed together.

If you need the `DOMRect` object i.e., the position of popover to be calculated on every time, the popover re-renders, then use `getAnchorRect`.

`getAnchorRect` callback function receives a reference to the popover anchor element as a function parameter and it should return a `DOMRect` objcet.

- Type: `Function`
- Required: No

## Methods

### refresh
Expand Down