@atlaskit/popup 1.10.2 → 1.11.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/popup
 
+## 1.11.1
+
+### Patch Changes
+
+- [#41322](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/41322) [`f54519b315c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/f54519b315c) - This removes the error in console when passing `shouldRenderToParent` prop.
+
+## 1.11.0
+
+### Minor Changes
+
+- [#41251](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/41251) [`b0a2a8d78c6`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b0a2a8d78c6) - [ux] We are testing removing the `focus-trap` package for a smaller sharper implementation of focus management behind a feature flag. If this fix is successful it will be available in a later release.
+
 ## 1.10.2
 
 ### Patch Changes

package/dist/cjs/popper-wrapper.js

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = require("react");
 var _react2 = require("@emotion/react");
@@ -17,6 +18,7 @@ var _tokens = require("@atlaskit/tokens");
 var _repositionOnUpdate = require("./reposition-on-update");
 var _useCloseManager = require("./use-close-manager");
 var _useFocusManager = require("./use-focus-manager");
+var _excluded = ["shouldRenderToParent", "children"];
 var _css;
 /** @jsx jsx */
 var popupStyles = (0, _react2.css)((_css = {
@@ -34,12 +36,14 @@ var popupOverflowStyles = (0, _react2.css)({
   overflow: 'auto'
 });
 var DefaultPopupComponent = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
-  var shouldRenderToParent = props.shouldRenderToParent;
+  var shouldRenderToParent = props.shouldRenderToParent,
+    children = props.children,
+    htmlAttributes = (0, _objectWithoutProperties2.default)(props, _excluded);
   return (0, _react2.jsx)("div", (0, _extends2.default)({
     css: [popupStyles, !shouldRenderToParent && popupOverflowStyles]
-  }, props, {
+  }, htmlAttributes, {
     ref: ref
-  }));
+  }), children);
 });
 function PopperWrapper(_ref) {
   var isOpen = _ref.isOpen,

package/dist/cjs/use-focus-manager.js

@@ -8,34 +8,55 @@ exports.useFocusManager = void 0;
 var _react = require("react");
 var _focusTrap = _interopRequireDefault(require("focus-trap"));
 var _noop = _interopRequireDefault(require("@atlaskit/ds-lib/noop"));
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var useFocusManager = exports.useFocusManager = function useFocusManager(_ref) {
-  var popupRef = _ref.popupRef,
-    initialFocusRef = _ref.initialFocusRef;
+  var initialFocusRef = _ref.initialFocusRef,
+    popupRef = _ref.popupRef;
   (0, _react.useEffect)(function () {
     if (!popupRef) {
       return _noop.default;
     }
-    var trapConfig = {
-      clickOutsideDeactivates: true,
-      escapeDeactivates: true,
-      initialFocus: initialFocusRef || popupRef,
-      fallbackFocus: popupRef,
-      returnFocusOnDeactivate: true
-    };
-    var focusTrap = (0, _focusTrap.default)(popupRef, trapConfig);
+    var previouslyFocusedElement;
+    var focusTrap;
+    if ((0, _platformFeatureFlags.getBooleanFF)('platform.design-system-team.remove-focus-trap-from-popup_3q7sk')) {
+      previouslyFocusedElement = document.activeElement;
+    } else {
+      var trapConfig = {
+        clickOutsideDeactivates: true,
+        escapeDeactivates: true,
+        initialFocus: initialFocusRef || popupRef,
+        fallbackFocus: popupRef,
+        returnFocusOnDeactivate: true
+      };
+      focusTrap = (0, _focusTrap.default)(popupRef, trapConfig);
+    }
     var frameId = null;
 
     // wait for the popup to reposition itself before we focus
     frameId = requestAnimationFrame(function () {
       frameId = null;
-      focusTrap.activate();
+      if ((0, _platformFeatureFlags.getBooleanFF)('platform.design-system-team.remove-focus-trap-from-popup_3q7sk')) {
+        if (initialFocusRef && initialFocusRef.focus) {
+          initialFocusRef.focus();
+        } else {
+          popupRef.focus();
+        }
+      } else {
+        focusTrap.activate();
+      }
     });
     return function () {
       if (frameId != null) {
         cancelAnimationFrame(frameId);
         frameId = null;
       }
-      focusTrap.deactivate();
+      if ((0, _platformFeatureFlags.getBooleanFF)('platform.design-system-team.remove-focus-trap-from-popup_3q7sk')) {
+        if (previouslyFocusedElement && previouslyFocusedElement.focus) {
+          previouslyFocusedElement.focus();
+        }
+      } else {
+        focusTrap.deactivate();
+      }
     };
   }, [popupRef, initialFocusRef]);
 };

package/dist/es2019/popper-wrapper.js

@@ -27,13 +27,15 @@ const popupOverflowStyles = css({
 });
 const DefaultPopupComponent = /*#__PURE__*/forwardRef((props, ref) => {
   const {
-    shouldRenderToParent
+    shouldRenderToParent,
+    children,
+    ...htmlAttributes
   } = props;
   return jsx("div", _extends({
     css: [popupStyles, !shouldRenderToParent && popupOverflowStyles]
-  }, props, {
+  }, htmlAttributes, {
     ref: ref
-  }));
+  }), children);
 });
 function PopperWrapper({
   isOpen,

package/dist/es2019/use-focus-manager.js

@@ -1,35 +1,56 @@
 import { useEffect } from 'react';
 import createFocusTrap from 'focus-trap';
 import noop from '@atlaskit/ds-lib/noop';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 export const useFocusManager = ({
-  popupRef,
-  initialFocusRef
+  initialFocusRef,
+  popupRef
 }) => {
   useEffect(() => {
     if (!popupRef) {
       return noop;
     }
-    const trapConfig = {
-      clickOutsideDeactivates: true,
-      escapeDeactivates: true,
-      initialFocus: initialFocusRef || popupRef,
-      fallbackFocus: popupRef,
-      returnFocusOnDeactivate: true
-    };
-    const focusTrap = createFocusTrap(popupRef, trapConfig);
+    let previouslyFocusedElement;
+    let focusTrap;
+    if (getBooleanFF('platform.design-system-team.remove-focus-trap-from-popup_3q7sk')) {
+      previouslyFocusedElement = document.activeElement;
+    } else {
+      const trapConfig = {
+        clickOutsideDeactivates: true,
+        escapeDeactivates: true,
+        initialFocus: initialFocusRef || popupRef,
+        fallbackFocus: popupRef,
+        returnFocusOnDeactivate: true
+      };
+      focusTrap = createFocusTrap(popupRef, trapConfig);
+    }
     let frameId = null;
 
     // wait for the popup to reposition itself before we focus
     frameId = requestAnimationFrame(() => {
       frameId = null;
-      focusTrap.activate();
+      if (getBooleanFF('platform.design-system-team.remove-focus-trap-from-popup_3q7sk')) {
+        if (initialFocusRef && initialFocusRef.focus) {
+          initialFocusRef.focus();
+        } else {
+          popupRef.focus();
+        }
+      } else {
+        focusTrap.activate();
+      }
     });
     return () => {
       if (frameId != null) {
         cancelAnimationFrame(frameId);
         frameId = null;
       }
-      focusTrap.deactivate();
+      if (getBooleanFF('platform.design-system-team.remove-focus-trap-from-popup_3q7sk')) {
+        if (previouslyFocusedElement && previouslyFocusedElement.focus) {
+          previouslyFocusedElement.focus();
+        }
+      } else {
+        focusTrap.deactivate();
+      }
     };
   }, [popupRef, initialFocusRef]);
 };

package/dist/esm/popper-wrapper.js

@@ -1,6 +1,8 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+var _excluded = ["shouldRenderToParent", "children"];
 var _css;
 /** @jsx jsx */
 import { forwardRef, useMemo, useState } from 'react';
@@ -27,12 +29,14 @@ var popupOverflowStyles = css({
   overflow: 'auto'
 });
 var DefaultPopupComponent = /*#__PURE__*/forwardRef(function (props, ref) {
-  var shouldRenderToParent = props.shouldRenderToParent;
+  var shouldRenderToParent = props.shouldRenderToParent,
+    children = props.children,
+    htmlAttributes = _objectWithoutProperties(props, _excluded);
   return jsx("div", _extends({
     css: [popupStyles, !shouldRenderToParent && popupOverflowStyles]
-  }, props, {
+  }, htmlAttributes, {
     ref: ref
-  }));
+  }), children);
 });
 function PopperWrapper(_ref) {
   var isOpen = _ref.isOpen,

package/dist/esm/use-focus-manager.js

@@ -1,34 +1,55 @@
 import { useEffect } from 'react';
 import createFocusTrap from 'focus-trap';
 import noop from '@atlaskit/ds-lib/noop';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 export var useFocusManager = function useFocusManager(_ref) {
-  var popupRef = _ref.popupRef,
-    initialFocusRef = _ref.initialFocusRef;
+  var initialFocusRef = _ref.initialFocusRef,
+    popupRef = _ref.popupRef;
   useEffect(function () {
     if (!popupRef) {
       return noop;
     }
-    var trapConfig = {
-      clickOutsideDeactivates: true,
-      escapeDeactivates: true,
-      initialFocus: initialFocusRef || popupRef,
-      fallbackFocus: popupRef,
-      returnFocusOnDeactivate: true
-    };
-    var focusTrap = createFocusTrap(popupRef, trapConfig);
+    var previouslyFocusedElement;
+    var focusTrap;
+    if (getBooleanFF('platform.design-system-team.remove-focus-trap-from-popup_3q7sk')) {
+      previouslyFocusedElement = document.activeElement;
+    } else {
+      var trapConfig = {
+        clickOutsideDeactivates: true,
+        escapeDeactivates: true,
+        initialFocus: initialFocusRef || popupRef,
+        fallbackFocus: popupRef,
+        returnFocusOnDeactivate: true
+      };
+      focusTrap = createFocusTrap(popupRef, trapConfig);
+    }
     var frameId = null;
 
     // wait for the popup to reposition itself before we focus
     frameId = requestAnimationFrame(function () {
       frameId = null;
-      focusTrap.activate();
+      if (getBooleanFF('platform.design-system-team.remove-focus-trap-from-popup_3q7sk')) {
+        if (initialFocusRef && initialFocusRef.focus) {
+          initialFocusRef.focus();
+        } else {
+          popupRef.focus();
+        }
+      } else {
+        focusTrap.activate();
+      }
     });
     return function () {
       if (frameId != null) {
         cancelAnimationFrame(frameId);
         frameId = null;
       }
-      focusTrap.deactivate();
+      if (getBooleanFF('platform.design-system-team.remove-focus-trap-from-popup_3q7sk')) {
+        if (previouslyFocusedElement && previouslyFocusedElement.focus) {
+          previouslyFocusedElement.focus();
+        }
+      } else {
+        focusTrap.deactivate();
+      }
     };
   }, [popupRef, initialFocusRef]);
 };

package/dist/types/types.d.ts

@@ -168,8 +168,8 @@ export type CloseManagerHook = Pick<PopupProps, 'isOpen' | 'onClose'> & {
     shouldUseCaptureOnOutsideClick?: boolean;
 };
 export type FocusManagerHook = {
-    popupRef: PopupRef;
     initialFocusRef: HTMLElement | null;
+    popupRef: PopupRef;
 };
 export type RepositionOnUpdateProps = {
     update: PopperChildrenProps['update'];

package/dist/types/use-focus-manager.d.ts

@@ -1,2 +1,2 @@
 import { FocusManagerHook } from './types';
-export declare const useFocusManager: ({ popupRef, initialFocusRef, }: FocusManagerHook) => void;
+export declare const useFocusManager: ({ initialFocusRef, popupRef, }: FocusManagerHook) => void;

package/dist/types-ts4.5/index.d.ts

@@ -0,0 +1,4 @@
+import { Popup } from './popup';
+export type { ContentProps, PopupComponentProps, PopupProps, TriggerProps, } from './types';
+export { Popup };
+export default Popup;

package/dist/types-ts4.5/popper-wrapper.d.ts

@@ -0,0 +1,4 @@
+import { jsx } from '@emotion/react';
+import { PopperWrapperProps } from './types';
+declare function PopperWrapper({ isOpen, id, offset, testId, content, fallbackPlacements, onClose, boundary, rootBoundary, shouldFlip, placement, popupComponent: PopupContainer, autoFocus, triggerRef, shouldUseCaptureOnOutsideClick, shouldRenderToParent, }: PopperWrapperProps): jsx.JSX.Element;
+export default PopperWrapper;

package/dist/types-ts4.5/popup.d.ts

@@ -0,0 +1,5 @@
+/** @jsx jsx */
+import { FC } from 'react';
+import { PopupProps } from './types';
+export declare const Popup: FC<PopupProps>;
+export default Popup;

package/dist/types-ts4.5/reposition-on-update.d.ts

@@ -0,0 +1,3 @@
+import { FC } from 'react';
+import { RepositionOnUpdateProps } from './types';
+export declare const RepositionOnUpdate: FC<RepositionOnUpdateProps>;

package/dist/types-ts4.5/types.d.ts

@@ -0,0 +1,180 @@
+import React, { ComponentType, CSSProperties, Dispatch, ReactNode, Ref, SetStateAction } from 'react';
+import { Placement, PopperChildrenProps } from '@atlaskit/popper';
+export interface TriggerProps {
+    ref: Ref<any>;
+    'aria-controls'?: string;
+    'aria-expanded': boolean;
+    'aria-haspopup': boolean;
+}
+export type PopupRef = HTMLDivElement | null;
+export type TriggerRef = HTMLElement | HTMLButtonElement | null;
+export interface ContentProps {
+    /**
+     * Will reposition the popup if any of the content has changed.
+     * Useful for when positions change and the popup was not aware.
+     */
+    update: PopperChildrenProps['update'];
+    /**
+     * Passed through from the parent popup.
+     */
+    isOpen: boolean;
+    /**
+     * Passed through from the parent popup.
+     */
+    onClose?: BaseProps['onClose'];
+    /**
+     * Escape hatch to set the initial focus for a specific element when the popup is opened.
+     */
+    setInitialFocusRef: Dispatch<SetStateAction<HTMLElement | null>>;
+}
+export interface PopupComponentProps {
+    /**
+     * Children passed passed through by the parent popup.
+     */
+    children: ReactNode;
+    /**
+     * Placement passed through by the parent popup.
+     */
+    'data-placement': Placement;
+    /**
+     * Test id passed through by the parent popup.
+     */
+    'data-testid'?: string;
+    /**
+     * Id passed through by the parent popup.
+     */
+    id?: string;
+    /**
+     * Ref that should be assigned to the root element.
+     */
+    ref: Ref<HTMLDivElement>;
+    /**
+     * Style that should be assigned to the root element.
+     */
+    style: CSSProperties;
+    /**
+     * Tab index passed through by the parent popup.
+     */
+    tabIndex: number | undefined;
+    /**
+     * The root element where the popup should be rendered.
+     * Defaults to `false`.
+     */
+    shouldRenderToParent?: boolean;
+}
+interface BaseProps {
+    /**
+     * Used to either show or hide the popup.
+     * When set to `false` popup will not render anything to the DOM.
+     */
+    isOpen: boolean;
+    /**
+     * Render props for content that is displayed inside the popup.
+     */
+    content: (props: ContentProps) => React.ReactNode;
+    /**
+     * Id that is assigned to the popup container element.
+     */
+    id?: string;
+    /**
+     * Distance the popup should be offset from the reference in the format of [along, away] (units in px).
+     * Defaults to [0, 8] - which means the popup will be 8px away from the edge of the reference specified
+     * by the `placement` prop.
+     */
+    offset?: [
+        number,
+        number
+    ];
+    /**
+     * Placement of where the popup should be displayed relative to the trigger element.
+     * Defaults to `"auto"`.
+     */
+    placement?: Placement;
+    /**
+     * Defines a list of placements to try.
+     * When no space is available on the preferred placement,
+     * the modifier will test the ones provided in the list, and use the first suitable one.
+     * If no fallback placements are suitable, it reverts back to the original placement.
+     */
+    fallbackPlacements?: Placement[];
+    /**
+     * The boundary element that the popup will check for overflow.
+     * Defaults to `"clippingParents"` which are parent scroll containers,
+     * but can be set to any element.
+     */
+    boundary?: 'clippingParents' | HTMLElement;
+    /**
+     * The root boundary that the popup will check for overflow.
+     * Defaults to `"viewport"` but can be set to `"document"`.
+     */
+    rootBoundary?: 'viewport' | 'document';
+    /**
+     * Allows the Popup to be placed on the opposite side of its trigger if it does not fit in the viewport.
+     * Defaults to `true`.
+     */
+    shouldFlip?: boolean;
+    /**
+     * A `testId` prop is provided for specified elements,
+     * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
+     * serving as a hook for automated tests.
+     */
+    testId?: string;
+    /**
+     * Handler that is called when the popup wants to close itself.
+     * Generally this will be either when clicking away from the popup or pressing the escape key.
+     * You'll want to use this to set open state accordingly and then pump it back into the `isOpen` prop.
+     */
+    onClose?(event: Event | React.MouseEvent | React.KeyboardEvent): void;
+    /**
+     * The element that is shown when `isOpen` prop is `true`.
+     * The result of the `content` prop will be placed as children here.
+     * Defaults to an element with an elevation of `e200` with _no padding_.
+     */
+    popupComponent?: ComponentType<PopupComponentProps>;
+    /**
+     * Controls whether the popup takes focus when opening.
+     * This changes the `popupComponent` component tabIndex to `null`.
+     * Defaults to `true`.
+     */
+    autoFocus?: boolean;
+    /**
+     * Controls if the event which handles clicks outside the popup is be bound with
+     *  `capture: true`.
+     */
+    shouldUseCaptureOnOutsideClick?: boolean;
+    /**
+     * The root element where the popup should be rendered.
+     * Defaults to `false`.
+     */
+    shouldRenderToParent?: boolean;
+}
+export interface PopupProps extends BaseProps {
+    /**
+     * Render props used to anchor the popup to your content.
+     * Make this an interactive element,
+     * such as an `@atlaskit/button` component.
+     */
+    trigger: (props: TriggerProps) => React.ReactNode;
+    /**
+     * Z-index that the popup should be displayed in.
+     * This is passed to the portal component.
+     * Defaults to `layers.layer()` from `@atlaskit/theme`.
+     */
+    zIndex?: number;
+}
+export interface PopperWrapperProps extends BaseProps {
+    triggerRef: TriggerRef;
+}
+export type CloseManagerHook = Pick<PopupProps, 'isOpen' | 'onClose'> & {
+    popupRef: PopupRef;
+    triggerRef: TriggerRef;
+    shouldUseCaptureOnOutsideClick?: boolean;
+};
+export type FocusManagerHook = {
+    initialFocusRef: HTMLElement | null;
+    popupRef: PopupRef;
+};
+export type RepositionOnUpdateProps = {
+    update: PopperChildrenProps['update'];
+};
+export {};

package/dist/types-ts4.5/use-close-manager.d.ts

@@ -0,0 +1,2 @@
+import { CloseManagerHook } from './types';
+export declare const useCloseManager: ({ isOpen, onClose, popupRef, triggerRef, shouldUseCaptureOnOutsideClick: capture, }: CloseManagerHook) => void;

package/dist/types-ts4.5/use-focus-manager.d.ts

@@ -0,0 +1,2 @@
+import { FocusManagerHook } from './types';
+export declare const useFocusManager: ({ initialFocusRef, popupRef, }: FocusManagerHook) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/popup",
-  "version": "1.10.2",
+  "version": "1.11.1",
   "description": "A popup displays brief content in an overlay.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -37,10 +37,11 @@
   "dependencies": {
     "@atlaskit/ds-lib": "^2.2.0",
     "@atlaskit/layering": "^0.2.0",
+    "@atlaskit/platform-feature-flags": "*",
     "@atlaskit/popper": "^5.5.0",
     "@atlaskit/portal": "^4.3.0",
     "@atlaskit/theme": "^12.6.0",
-    "@atlaskit/tokens": "^1.25.0",
+    "@atlaskit/tokens": "^1.26.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",
     "bind-event-listener": "^2.1.1",
@@ -94,5 +95,10 @@
     }
   },
   "homepage": "https://atlassian.design/components/popup/",
-  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1",
+  "platform-feature-flags": {
+    "platform.design-system-team.remove-focus-trap-from-popup_3q7sk": {
+      "type": "boolean"
+    }
+  }
 }

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,82 @@
+## API Report File for "@atlaskit/popup"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ComponentType } from 'react';
+import { CSSProperties } from 'react';
+import { Dispatch } from 'react';
+import { FC } from 'react';
+import { Placement } from '@atlaskit/popper';
+import { PopperChildrenProps } from '@atlaskit/popper';
+import { default as React_2 } from 'react';
+import { ReactNode } from 'react';
+import { Ref } from 'react';
+import { SetStateAction } from 'react';
+
+// @public (undocumented)
+interface BaseProps {
+    autoFocus?: boolean;
+    boundary?: 'clippingParents' | HTMLElement;
+    content: (props: ContentProps) => React_2.ReactNode;
+    fallbackPlacements?: Placement[];
+    id?: string;
+    isOpen: boolean;
+    offset?: [number, number];
+    onClose?(event: Event | React_2.KeyboardEvent | React_2.MouseEvent): void;
+    placement?: Placement;
+    popupComponent?: ComponentType<PopupComponentProps>;
+    rootBoundary?: 'document' | 'viewport';
+    shouldFlip?: boolean;
+    shouldRenderToParent?: boolean;
+    shouldUseCaptureOnOutsideClick?: boolean;
+    testId?: string;
+}
+
+// @public (undocumented)
+export interface ContentProps {
+    isOpen: boolean;
+    onClose?: BaseProps['onClose'];
+    setInitialFocusRef: Dispatch<SetStateAction<HTMLElement | null>>;
+    update: PopperChildrenProps['update'];
+}
+
+// @public (undocumented)
+const Popup: FC<PopupProps>;
+export { Popup }
+export default Popup;
+
+// @public (undocumented)
+export interface PopupComponentProps {
+    'data-placement': Placement;
+    'data-testid'?: string;
+    children: ReactNode;
+    id?: string;
+    ref: Ref<HTMLDivElement>;
+    shouldRenderToParent?: boolean;
+    style: CSSProperties;
+    tabIndex: number | undefined;
+}
+
+// @public (undocumented)
+export interface PopupProps extends BaseProps {
+    trigger: (props: TriggerProps) => React_2.ReactNode;
+    zIndex?: number;
+}
+
+// @public (undocumented)
+export interface TriggerProps {
+    // (undocumented)
+    'aria-controls'?: string;
+    // (undocumented)
+    'aria-expanded': boolean;
+    // (undocumented)
+    'aria-haspopup': boolean;
+    // (undocumented)
+    ref: Ref<any>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```