[core] deprecate Portal stopPropagationEvents (#6632)

palantir · Jan 8, 2024 · efb0a70 · efb0a70 · adidahiya · Jan 8, 2024
1 parent aaf1fa9
commit efb0a70
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/packages/core/src/components/overlay/overlay.tsx b/packages/core/src/components/overlay/overlay.tsx
@@ -109,8 +109,10 @@ export interface OverlayableProps extends OverlayLifecycleProps {
      * A list of DOM events which should be stopped from propagating through the Portal.
      * This prop is ignored if `usePortal` is `false`.
      *
+     * @deprecated this prop's implementation no longer works in React v17+
      * @see https://legacy.reactjs.org/docs/portals.html#event-bubbling-through-portals
      * @see https://github.com/palantir/blueprint/issues/6124
+     * @see https://github.com/palantir/blueprint/issues/6580
      */
     portalStopPropagationEvents?: Array<keyof HTMLElementEventMap>;
 
@@ -313,6 +315,7 @@ export class Overlay extends AbstractPureComponent<OverlayProps, OverlayState> {
                 <Portal
                     className={this.props.portalClassName}
                     container={this.props.portalContainer}
+                    // eslint-disable-next-line deprecation/deprecation
                     stopPropagationEvents={this.props.portalStopPropagationEvents}
                 >
                     {transitionGroup}

diff --git a/packages/core/src/components/popover/popover.tsx b/packages/core/src/components/popover/popover.tsx
@@ -518,6 +518,7 @@ export class Popover<
                 usePortal={usePortal}
                 portalClassName={this.props.portalClassName}
                 portalContainer={this.props.portalContainer}
+                // eslint-disable-next-line deprecation/deprecation
                 portalStopPropagationEvents={this.props.portalStopPropagationEvents}
                 shouldReturnFocusOnClose={shouldReturnFocusOnClose}
             >

diff --git a/packages/core/src/components/portal/portal.tsx b/packages/core/src/components/portal/portal.tsx
@@ -41,8 +41,10 @@ export interface PortalProps extends Props {
     /**
      * A list of DOM events which should be stopped from propagating through this portal element.
      *
+     * @deprecated this prop's implementation no longer works in React v17+
      * @see https://legacy.reactjs.org/docs/portals.html#event-bubbling-through-portals
      * @see https://github.com/palantir/blueprint/issues/6124
+     * @see https://github.com/palantir/blueprint/issues/6580
      */
     stopPropagationEvents?: Array<keyof HTMLElementEventMap>;
 }
@@ -75,6 +77,7 @@ const PORTAL_LEGACY_CONTEXT_TYPES: ValidationMap<PortalLegacyContext> = {
  * @see https://blueprintjs.com/docs/#core/components/portal
  */
 export function Portal(
+    // eslint-disable-next-line deprecation/deprecation
     { className, stopPropagationEvents, container, onChildrenMount, children }: PortalProps,
     legacyContext: PortalLegacyContext = {},
 ) {