[popover2] feat: add position prop for improved backcompat #4603
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
adidahiya
commented
Mar 23, 2021
| @@ -116,8 +116,7 @@ export class Popover extends AbstractPureComponent2<IPopoverProps, IPopoverState | |||
| minimal: false, | |||
| modifiers: {}, | |||
| openOnTargetFocus: true, | |||
| // N.B. we don't set a default for `placement` here because that would override | |||
| // the deprecated `position` prop | |||
| // N.B. we don't set a default for `placement` here because that would override the `position` prop | |||
| position: "auto", | |||
There was a problem hiding this comment.
this will cause errors when placement is specified, which should be valid. we should configure this default inline during the render phase, not here as a static default prop
packages/popover2/src/popover2.tsx
Outdated
| @@ -122,7 +123,8 @@ export class Popover2<T> extends AbstractPureComponent2<IPopover2Props<T>, IPopo | |||
| interactionKind: Popover2InteractionKind.CLICK, | |||
| minimal: false, | |||
| openOnTargetFocus: true, | |||
| placement: "auto", | |||
| // N.B. we don't set a default for `placement` here because that would override the `position` prop | |||
| position: "auto", | |||
There was a problem hiding this comment.
same problem here. it can be seen producing an error in Popover2Example
address self-review commentsPreviews: documentation | landing | table |
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.
Checklist
Changes proposed in this pull request:
Improve Popover2's backwards compatibility with Popover. Originally I planned to move towards popper.js semantics in Popover2 with the upgrade to v2, where "placement" replaces "position". In practice, this distinction doesn't seem very meaningful and just makes the upgrade harder. Also there is some value in abstracting away low-level library positioning implementation details at the Blueprint API level here. So, this PR has these changes:
positionprop for<Popover>positionprop to set the popper.js placement using an API familiar from Blueprint v3Reviewers should focus on:
No regressions
Screenshot