@atlaskit/popup 1.5.1 → 1.5.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/popup
 
+## 1.5.2
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 1.5.1
 
 ### Patch Changes

package/codemods/__tests__/1.0.0-lite-mode.tsx

@@ -54,8 +54,7 @@ function check({
 
 describe('Convert boundaries props', () => {
   check({
-    it:
-      'should turn `boundariesElement="scrollParents"` to `boundary="clippingParents"`',
+    it: 'should turn `boundariesElement="scrollParents"` to `boundary="clippingParents"`',
     original: `
       import Popup from '@atlaskit/popup';
 
@@ -95,8 +94,7 @@ describe('Convert boundaries props', () => {
   });
 
   check({
-    it:
-      'should turn `boundariesElement="window"` into `rootBoundary="document"`',
+    it: 'should turn `boundariesElement="window"` into `rootBoundary="document"`',
     original: `
       import Popup from '@atlaskit/popup';
 
@@ -136,8 +134,7 @@ describe('Convert boundaries props', () => {
   });
 
   check({
-    it:
-      'should turn `boundariesElement="viewport"` into `rootBoundary="viewport"`',
+    it: 'should turn `boundariesElement="viewport"` into `rootBoundary="viewport"`',
     original: `
       import Popup from '@atlaskit/popup';
 

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/popup",
-	"version": "1.5.1",
+	"version": "1.5.2",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/popup",
-	"version": "1.5.1",
+	"version": "1.5.2",
 	"sideEffects": false
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/popup",
-	"version": "1.5.1",
+	"version": "1.5.2",
 	"sideEffects": false
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/popup",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "description": "A popup displays brief content in an overlay.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,14 +12,6 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
-  "typesVersions": {
-    ">=4.0 <4.5": {
-      "*": [
-        "dist/types-ts4.0/*",
-        "dist/types-ts4.0/index.d.ts"
-      ]
-    }
-  },
   "sideEffects": false,
   "atlaskit:src": "src/index.tsx",
   "af:exports": {
@@ -40,7 +32,7 @@
     "@atlaskit/popper": "^5.0.0",
     "@atlaskit/portal": "^4.0.0",
     "@atlaskit/theme": "^12.2.0",
-    "@atlaskit/tokens": "^0.10.0",
+    "@atlaskit/tokens": "^0.11.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",
     "bind-event-listener": "^2.1.1",
@@ -51,10 +43,10 @@
     "react-dom": "^16.8.0"
   },
   "devDependencies": {
-    "@atlaskit/button": "^16.3.0",
+    "@atlaskit/button": "^16.4.0",
     "@atlaskit/docs": "*",
     "@atlaskit/icon": "^21.11.0",
-    "@atlaskit/menu": "^1.3.0",
+    "@atlaskit/menu": "^1.4.0",
     "@atlaskit/radio": "^5.4.0",
     "@atlaskit/section-message": "^6.3.0",
     "@atlaskit/select": "^15.7.0",

package/report.api.md

@@ -1,6 +1,10 @@
-## API Report File for "@atlaskit/popup".
+## API Report File for "@atlaskit/popup"
 
-> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+<!--
+	Generated API Report version: 2.0
+-->
 
 [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
@@ -16,160 +20,65 @@ import { ReactNode } from 'react';
 import { Ref } from 'react';
 import { SetStateAction } from 'react';
 
-declare 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.
-   */
+// @public (undocumented)
+interface BaseProps {
+  autoFocus?: boolean;
+  boundary?: 'clippingParents' | HTMLElement;
   content: (props: ContentProps) => React_2.ReactNode;
-  /**
-   * Id that is assigned to the popup container element.
-   */
+  fallbackPlacements?: Placement[];
   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.
-   */
+  isOpen: boolean;
   offset?: [number, number];
-  /**
-   * Placement of where the popup should be displayed relative to the trigger element.
-   * Defaults to `"auto"`.
-   */
+  onClose?(event: Event | React_2.MouseEvent | React_2.KeyboardEvent): void;
   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 useful one.
-   */
-  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"`.
-   */
+  popupComponent?: ComponentType<PopupComponentProps>;
   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_2.MouseEvent | React_2.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;
+  testId?: string;
 }
 
-export declare 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.
-   */
+// @public (undocumented)
+export interface ContentProps {
   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>>;
+  update: PopperChildrenProps['update'];
 }
 
-declare const Popup: FC<PopupProps>;
+// @public (undocumented)
+const Popup: FC<PopupProps>;
 export { Popup };
 export default Popup;
 
-export declare interface PopupComponentProps {
-  /**
-   * Children passed passed through by the parent popup.
-   */
-  children: ReactNode;
-  /**
-   * Placement passed through by the parent popup.
-   */
+// @public (undocumented)
+export interface PopupComponentProps {
   'data-placement': Placement;
-  /**
-   * Test id passed through by the parent popup.
-   */
   'data-testid'?: string;
-  /**
-   * Id passed through by the parent popup.
-   */
+  children: ReactNode;
   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;
 }
 
-export declare 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.
-   */
+// @public (undocumented)
+export interface PopupProps extends BaseProps {
   trigger: (props: TriggerProps) => React_2.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 declare interface TriggerProps {
-  ref: Ref<any>;
+// @public (undocumented)
+export interface TriggerProps {
+  // (undocumented)
   'aria-controls'?: string;
+  // (undocumented)
   'aria-expanded': boolean;
+  // (undocumented)
   'aria-haspopup': boolean;
+  // (undocumented)
+  ref: Ref<any>;
 }
 
-export {};
+// (No @packageDocumentation comment for this package)
 ```

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

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

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

@@ -1,4 +0,0 @@
-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, }: PopperWrapperProps): jsx.JSX.Element;
-export default PopperWrapper;

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

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

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

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

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

@@ -1,169 +0,0 @@
-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 declare type PopupRef = HTMLDivElement | null;
-export declare 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;
-}
-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 useful one.
-     */
-    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;
-}
-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 declare type CloseManagerHook = Pick<PopupProps, 'isOpen' | 'onClose'> & {
-    popupRef: PopupRef;
-    triggerRef: TriggerRef;
-    shouldUseCaptureOnOutsideClick?: boolean;
-};
-export declare type FocusManagerHook = {
-    popupRef: PopupRef;
-    initialFocusRef: HTMLElement | null;
-};
-export declare type RepositionOnUpdateProps = {
-    update: PopperChildrenProps['update'];
-};
-export {};

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

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

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

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