@atlaskit/popup 1.6.1 → 1.6.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/popup
 
+## 1.6.2
+
+### Patch Changes
+
+- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
+
 ## 1.6.1
 
 ### Patch Changes

package/dist/cjs/version.json

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

package/dist/es2019/version.json

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

package/dist/esm/version.json

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

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, }: 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,169 @@
+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;
+}
+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 type CloseManagerHook = Pick<PopupProps, 'isOpen' | 'onClose'> & {
+    popupRef: PopupRef;
+    triggerRef: TriggerRef;
+    shouldUseCaptureOnOutsideClick?: boolean;
+};
+export type FocusManagerHook = {
+    popupRef: PopupRef;
+    initialFocusRef: HTMLElement | null;
+};
+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: ({ popupRef, initialFocusRef, }: FocusManagerHook) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/popup",
-  "version": "1.6.1",
+  "version": "1.6.2",
   "description": "A popup displays brief content in an overlay.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -53,7 +53,7 @@
     "@atlaskit/button": "^16.7.0",
     "@atlaskit/docs": "*",
     "@atlaskit/icon": "^21.12.0",
-    "@atlaskit/menu": "^1.6.0",
+    "@atlaskit/menu": "^1.7.0",
     "@atlaskit/radio": "^5.5.0",
     "@atlaskit/section-message": "^6.4.0",
     "@atlaskit/select": "^16.2.0",