[core] feat: OverlaysProvider #6674
Merged
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
WIP continue fixing Overlay2 testsBuild artifact links for this commit: documentation | landing | table | demoThis is an automated comment from the deploy-preview CircleCI job. |
adidahiya
commented
Jan 24, 2024
| renderPageActions={this.renderPageActions} | ||
| renderViewSourceLinkText={this.renderViewSourceLinkText} | ||
| /> | ||
| <OverlaysProvider> |
There was a problem hiding this comment.
TODO in a future PR: expose a <BlueprintProvider> which does all 3
fix Overlay2 testsBuild artifact links for this commit: documentation | landing | table | demoThis is an automated comment from the deploy-preview CircleCI job. |
Fix core:iso test:Build artifact links for this commit: documentation | landing | table | demoThis is an automated comment from the deploy-preview CircleCI job. |
adidahiya
commented
Jan 25, 2024
5 tasks
Overlay2 backcompatBuild artifact links for this commit: documentation | landing | table | demoThis is an automated comment from the deploy-preview CircleCI job. |
address self-review, attempt to fix testBuild artifact links for this commit: documentation | landing | table | demoThis is an automated comment from the deploy-preview CircleCI job. |
Fix testsBuild artifact links for this commit: documentation | landing | table | demoThis is an automated comment from the deploy-preview CircleCI job. |
|
need to add the OverlaysProvider and useOverlayStack docs to the navigation sidebar: |
adidahiya
commented
Jan 25, 2024
| @@ -73,6 +75,7 @@ | |||
| "@blueprintjs/node-build-scripts": "workspace:^", | |||
| "@blueprintjs/test-commons": "workspace:^", | |||
| "@testing-library/react": "^12.1.5", | |||
| "@types/use-sync-external-store": "0.0.6", | |||
There was a problem hiding this comment.
note that this does not need to be in "dependencies" because it's not exposed in the generated types:
// useLegacyOverlayStack.d.ts
import React from "react";
import { type OverlayStackAction } from "../../context/overlays/overlaysProvider";
import type { UseOverlayStackReturnValue } from "./useOverlayStack";
/**
* Public only for testing.
*/
export declare const dispatch: React.Dispatch<OverlayStackAction>;
/**
* Legacy implementation of a global overlay stack which maintains state in a global variable.
* This is used for backwards-compatibility with overlay-based components in Blueprint v5.
* It will be removed in Blueprint v6 once `<OverlaysProvider>` is required.
*
* @see https://github.com/palantir/blueprint/wiki/Overlay2-migration
*/
export declare function useLegacyOverlayStack(): UseOverlayStackReturnValue;
revert stopPropagationEvents removalBuild artifact links for this commit: documentation | landing | table | demoThis is an automated comment from the deploy-preview CircleCI job. |
This was referenced Jan 26, 2024
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.
Follow-up to #6656
Checklist
<Dialog>,<Drawer>,<Popover>,<Omnibar>Changes proposed in this pull request:
<OverlaysProvider>component anduseOverlayStack()hook to manage global overlay stack statereact-uidlibrary to generate ids for Overlay2 instances<OverlayProvider>by utilizinguseSyncExternalStore()(requires shimming in React 16) to reference overlay state in a global variableuseOverlayStack()with and without the suggested provider contextReviewers should focus on:
No regressions in overlay-based components