Skip to content

Migrate to Overlay2 #7292

Open
Open
@ggdouglas

Description

@ggdouglas

Transition from the deprecated Overlay to the standardized Overlay2.

Note: Overlay has been deprecated since @blueprintjs/core v5.9.0

Tasks:

  • Replace deprecated Overlay components with Overlay2.
  • Remove legacy tests, documentation, and examples related to Overlay.
  • Update exported modules to use Overlay2.
  • Remove useLegacyOverlayStack
    /**
    * 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 function useLegacyOverlayStack(): UseOverlayStackReturnValue {

References

https://blueprintjs.com/docs/#core/components/overlay

This component is deprecated since @blueprintjs/core v5.9.0 in favor of the new Overlay2 component which is compatible with React 18 strict mode. You should migrate to the new API which will become the standard in a future major version of Blueprint.

https://blueprintjs.com/docs/#core/components/overlay2

OverlaysProvider and Overlay2, when used together, are a replacement for Overlay. You are encouraged to use these new APIs, as they will become the standard in a future major version of Blueprint. See the full migration guide on the wiki.

Overlay2 migration guide

export const OVERLAY2_REQUIRES_OVERLAY_PROVDER =
ns +
` <Overlay2> was used outside of a <OverlaysProvider> context. This will no longer be supported in ` +
`Blueprint v6. See https://github.com/palantir/blueprint/wiki/Overlay2-migration`;

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions