@atlaskit/drawer 7.5.1 → 7.5.2

package/CHANGELOG.md

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

package/dist/cjs/components/index.js

@@ -27,7 +27,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } } /* eslint-disable @repo/internal/dom-events/no-unsafe-event-listeners */
 var packageName = "@atlaskit/drawer";
-var packageVersion = "7.5.1";
+var packageVersion = "7.5.2";
 var createAndFireEventOnAtlaskit = (0, _analyticsNext.createAndFireEvent)('atlaskit');
 var createAndFireOnClick = function createAndFireOnClick(createAnalyticsEvent, trigger) {
   return createAndFireEventOnAtlaskit({

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/drawer",
-	"version": "7.5.1",
+	"version": "7.5.2",
 	"sideEffects": false
 }

package/dist/es2019/components/index.js

@@ -8,7 +8,7 @@ import { defaultFocusLockSettings } from '../constants';
 import Blanket from './blanket';
 import DrawerPrimitive from './primitives';
 const packageName = "@atlaskit/drawer";
-const packageVersion = "7.5.1";
+const packageVersion = "7.5.2";
 const createAndFireEventOnAtlaskit = createAndFireEvent('atlaskit');
 const createAndFireOnClick = (createAnalyticsEvent, trigger) => createAndFireEventOnAtlaskit({
   action: 'dismissed',

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/drawer",
-	"version": "7.5.1",
+	"version": "7.5.2",
 	"sideEffects": false
 }

package/dist/esm/components/index.js

@@ -18,7 +18,7 @@ import { defaultFocusLockSettings } from '../constants';
 import Blanket from './blanket';
 import DrawerPrimitive from './primitives';
 var packageName = "@atlaskit/drawer";
-var packageVersion = "7.5.1";
+var packageVersion = "7.5.2";
 var createAndFireEventOnAtlaskit = createAndFireEvent('atlaskit');
 var createAndFireOnClick = function createAndFireOnClick(createAnalyticsEvent, trigger) {
   return createAndFireEventOnAtlaskit({

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/drawer",
-	"version": "7.5.1",
+	"version": "7.5.2",
 	"sideEffects": false
 }

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

@@ -0,0 +1,13 @@
+/** @jsx jsx */
+import React from 'react';
+import { jsx } from '@emotion/react';
+type BlanketProps = {
+    isOpen: boolean;
+    onBlanketClicked: (event: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;
+    testId?: string;
+};
+/**
+ * A wrapper around `@atlaskit/blanket` that adds a fade in/out transition.
+ */
+declare const Blanket: ({ isOpen, onBlanketClicked, testId }: BlanketProps) => jsx.JSX.Element;
+export default Blanket;

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

@@ -0,0 +1,31 @@
+import React, { Component } from 'react';
+import { DrawerProps, DrawerWidth } from './types';
+export declare class DrawerBase extends Component<DrawerProps, {
+    renderPortal: boolean;
+}> {
+    static defaultProps: {
+        autoFocusFirstElem?: boolean | (() => HTMLElement | null) | undefined;
+        isFocusLockEnabled?: boolean | undefined;
+        shouldReturnFocus?: boolean | undefined;
+        width: DrawerWidth;
+    };
+    state: {
+        renderPortal: boolean;
+    };
+    body: HTMLBodyElement | null | undefined;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    componentDidUpdate(prevProps: DrawerProps): void;
+    private handleBlanketClick;
+    private handleBackButtonClick;
+    private handleClose;
+    handleKeyDown: (event: KeyboardEvent) => void;
+    render(): JSX.Element | null;
+}
+declare const _default: React.ForwardRefExoticComponent<Pick<Pick<Omit<DrawerProps, keyof import("@atlaskit/analytics-next").WithAnalyticsEventsProps>, "children" | "onKeyDown" | "onClose" | "testId" | "icon" | "onOpenComplete" | "onCloseComplete" | "shouldUnmountOnExit" | "overrides" | "isOpen" | "zIndex"> & Partial<Pick<Omit<DrawerProps, keyof import("@atlaskit/analytics-next").WithAnalyticsEventsProps>, "width" | keyof import("./types").FocusLockSettings>> & Partial<Pick<{
+    autoFocusFirstElem?: boolean | (() => HTMLElement | null) | undefined;
+    isFocusLockEnabled?: boolean | undefined;
+    shouldReturnFocus?: boolean | undefined;
+    width: DrawerWidth;
+}, never>> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "width" | "children" | "onKeyDown" | "key" | "onClose" | "testId" | "icon" | "onOpenComplete" | "onCloseComplete" | "shouldUnmountOnExit" | "overrides" | "isOpen" | "analyticsContext" | "zIndex" | keyof import("./types").FocusLockSettings> & React.RefAttributes<any>>;
+export default _default;

package/dist/types-ts4.5/components/primitives/content.d.ts

@@ -0,0 +1,8 @@
+/** @jsx jsx */
+import { CSSObject, jsx } from '@emotion/react';
+import { ContentProps } from '../types';
+declare const _default: {
+    component: ({ cssFn, ...props }: ContentProps) => jsx.JSX.Element;
+    cssFn: () => CSSObject;
+};
+export default _default;

package/dist/types-ts4.5/components/primitives/drawer-wrapper.d.ts

@@ -0,0 +1,26 @@
+/** @jsx jsx */
+import { ReactElement, Ref } from 'react';
+import { DrawerPrimitiveProps, Widths } from '../types';
+export declare const wrapperWidth: Widths;
+interface FocusLockRefTargetProps extends Pick<DrawerPrimitiveProps, 'width' | 'testId'> {
+    /**
+     * This must have two children explicitly as we target the second child as the Content.
+     */
+    children: [
+        ReactElement,
+        ReactElement
+    ];
+    /**
+     * A ref pointing to our drawer wrapper, passed to `onCloseComplete` and `onOpenComplete` callbacks.
+     */
+    drawerRef: Ref<HTMLDivElement>;
+    /**
+     * The className coming from the SlideIn render callback.
+     */
+    className?: string;
+}
+/**
+ * A wrapper that controls the styling of the drawer with a few hacks with refs to get our Touch±Scroll locks working.
+ */
+declare const DrawerWrapper: import("react").ForwardRefExoticComponent<FocusLockRefTargetProps & import("react").RefAttributes<HTMLElement>>;
+export default DrawerWrapper;

package/dist/types-ts4.5/components/primitives/focus-lock.d.ts

@@ -0,0 +1,11 @@
+import { Component } from 'react';
+import { FocusLockProps } from '../types';
+export default class FocusLock extends Component<FocusLockProps> {
+    static defaultProps: {
+        autoFocusFirstElem?: boolean | (() => HTMLElement | null) | undefined;
+        isFocusLockEnabled?: boolean | undefined;
+        shouldReturnFocus?: boolean | undefined;
+    };
+    componentDidMount(): void;
+    render(): JSX.Element;
+}

package/dist/types-ts4.5/components/primitives/hooks/use-prevent-programmatic-scroll.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Prevents programmatic scrolling of the viewport with `scrollIntoView`.
+ * Should be used in conjunction with a scroll lock to prevent a user from scrolling.
+ *
+ * ⚠️ This is copied from `packages/design-system/modal-dialog/src/internal/hooks/use-prevent-programmatic-scroll.tsx`
+ *
+ * @returns scroll top offset of the viewport
+ */
+export default function usePreventProgrammaticScroll(): number;

package/dist/types-ts4.5/components/primitives/icon-button.d.ts

@@ -0,0 +1,9 @@
+/** @jsx jsx */
+import { FC, MouseEventHandler, ReactNode } from 'react';
+interface IconButtonProps {
+    testId?: string;
+    onClick?: MouseEventHandler<HTMLButtonElement>;
+    children: ReactNode;
+}
+declare const IconButton: FC<IconButtonProps>;
+export default IconButton;

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

@@ -0,0 +1,5 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+import { DrawerPrimitiveProps } from '../types';
+declare const DrawerPrimitive: ({ children, icon: Icon, onClose, onCloseComplete, onOpenComplete, overrides, testId, in: isOpen, shouldReturnFocus, autoFocusFirstElem, isFocusLockEnabled, width, }: DrawerPrimitiveProps) => jsx.JSX.Element;
+export default DrawerPrimitive;

package/dist/types-ts4.5/components/primitives/sidebar.d.ts

@@ -0,0 +1,9 @@
+/** @jsx jsx */
+import { FC } from 'react';
+import { CSSObject } from '@emotion/react';
+import { SidebarProps } from '../types';
+declare const _default: {
+    component: FC<SidebarProps>;
+    cssFn: () => CSSObject;
+};
+export default _default;

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

@@ -0,0 +1,147 @@
+import { ComponentType, ReactElement, ReactNode, SyntheticEvent } from 'react';
+import { CSSObject } from '@emotion/react';
+import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
+export type Widths = {
+    extended: {
+        width: string;
+    };
+    full: {
+        width: string;
+    };
+    medium: {
+        width: number;
+    };
+    narrow: {
+        width: number;
+    };
+    wide: {
+        width: number;
+    };
+};
+export type DrawerWidth = 'extended' | 'full' | 'medium' | 'narrow' | 'wide';
+export interface BaseProps {
+    /**
+     * A unique hook to be used for testing.
+     */
+    testId?: string;
+    /**
+     * The content of the drawer.
+     */
+    children?: ReactNode;
+    /**
+     * Icon to be rendered in your drawer as a component, if available.
+     */
+    icon?: ComponentType<any>;
+    /**
+     * Available drawer sizes.
+     */
+    width?: DrawerWidth;
+    /**
+     * A callback function that will be called when the drawer has finished its opening transition.
+     */
+    onOpenComplete?: (node: HTMLElement | null) => void;
+    /**
+     * A callback function that will be called when the drawer has finished its close transition.
+     */
+    onCloseComplete?: (node: HTMLElement | null) => void;
+    /**
+     * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release.
+     * Boolean that controls if drawer should be retained/discarded
+     */
+    shouldUnmountOnExit?: boolean;
+    /**
+     * Override drawer components.
+     */
+    overrides?: OverridesType;
+}
+export type DefaultsType = {
+    Sidebar: {
+        component: React.ComponentType<SidebarProps>;
+        cssFn: (defaultStyles: CSSObject) => CSSObject;
+    };
+    Content: {
+        component: React.ComponentType<ContentProps>;
+        cssFn: (defaultStyles: CSSObject) => CSSObject;
+    };
+};
+export type OverridesType = {
+    Sidebar?: {
+        component?: React.ComponentType<SidebarProps>;
+        /**
+         * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-2673 for more information.
+         */
+        cssFn?: (defaultStyles: CSSObject) => CSSObject;
+    };
+    Content?: {
+        component?: React.ComponentType<ContentProps>;
+        /**
+         * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-2673 for more information.
+         */
+        cssFn?: (defaultStyles: CSSObject) => CSSObject;
+    };
+};
+export type DrawerPrimitiveDefaults = Pick<DefaultsType, 'Sidebar' | 'Content'>;
+export type DrawerPrimitiveOverrides = Pick<OverridesType, 'Sidebar' | 'Content'>;
+export interface SidebarProps extends React.HTMLProps<HTMLDivElement> {
+    /**
+     * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-2673 for more information.
+     */
+    cssFn: (defaultStyles: CSSObject) => CSSObject;
+}
+export type SidebarCSSProps = Omit<SidebarProps, 'cssFn'>;
+export interface ContentProps extends React.HTMLProps<HTMLDivElement> {
+    /**
+     * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-2673 for more information.
+     */
+    cssFn: (defaultStyles: CSSObject) => CSSObject;
+}
+export type ContentCSSProps = Omit<ContentProps, 'cssFn'>;
+export interface DrawerPrimitiveProps extends BaseProps, FocusLockSettings {
+    in: boolean;
+    onClose: (event: SyntheticEvent<HTMLElement>) => void;
+}
+export type DrawerProps = BaseProps & FocusLockSettings & WithAnalyticsEventsProps & {
+    /**
+     * Callback function called while the drawer is displayed and `keydown` event is triggered.
+     */
+    onKeyDown?: (event: SyntheticEvent) => void;
+    /**
+     * Callback function called when the drawer is closed.
+     */
+    onClose?: (event: SyntheticEvent<HTMLElement>, analyticsEvent: any) => void;
+    /**
+     * Controls if the drawer is open or closed.
+     */
+    isOpen: boolean;
+    /**
+     * Z-index that the popup should be displayed in.
+     * This is passed to the portal component.
+     * Defaults to `unset`.
+     */
+    zIndex?: number;
+};
+export interface FocusLockSettings {
+    /**
+     * Controls whether to focus the first tabbable element inside the focus lock.
+     */
+    autoFocusFirstElem?: boolean | (() => HTMLElement | null);
+    /**
+     * Whether the focus lock is active or not.
+     */
+    isFocusLockEnabled?: boolean;
+    /**
+     * Whether to return the focus to the previous active element on closing the drawer.
+     */
+    shouldReturnFocus?: boolean;
+}
+export interface FocusLockProps extends FocusLockSettings {
+    /**
+     * Content inside the focus lock.
+     * Must strictly be a ReactElement and it *must* be implemented to take a `ref` passed from `react-scrolllock` to enable Touch Scrolling.
+     */
+    children?: ReactElement;
+}
+/**
+ * Type of keyboard event that triggers which key will should close the drawer.
+ */
+export type CloseTrigger = 'backButton' | 'blanket' | 'escKey';

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

@@ -0,0 +1,7 @@
+type OverridesFunc<X extends Record<string, any>, Y extends Record<string, any>> = (key: string) => Record<string, any>;
+export type ExtenderType = <D extends Record<string, any>, O extends Record<string, any>>(d: D, o?: O) => OverridesFunc<D, O>;
+/**
+ * @deprecated Please avoid using this function as we intend to remote it in a future release. See DSP-2673 for more information.
+ */
+export declare const createExtender: ExtenderType;
+export {};

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

@@ -0,0 +1,7 @@
+import type { DrawerWidth, FocusLockSettings } from './components/types';
+export declare const transitionDuration = "0.22s";
+export declare const transitionDurationMs = 220;
+export declare const transitionTimingFunction: import("@atlaskit/motion/curves").AnimationCurve;
+export declare const widths: DrawerWidth[];
+export declare const animationTimingFunction: () => import("@atlaskit/motion/curves").AnimationCurve;
+export declare const defaultFocusLockSettings: FocusLockSettings;

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

@@ -0,0 +1,2 @@
+export { default } from './components';
+export type { BaseProps, CloseTrigger, ContentCSSProps, ContentProps, DefaultsType, DrawerPrimitiveDefaults, DrawerPrimitiveOverrides, DrawerPrimitiveProps, DrawerProps, DrawerWidth, FocusLockProps, OverridesType, SidebarCSSProps, SidebarProps, Widths, } from './components/types';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/drawer",
-  "version": "7.5.1",
+  "version": "7.5.2",
   "description": "A drawer is a panel that slides in from the left side of the screen.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -58,9 +58,9 @@
     "@atlaskit/checkbox": "^12.6.0",
     "@atlaskit/code": "^14.6.0",
     "@atlaskit/docs": "*",
-    "@atlaskit/dropdown-menu": "^11.8.0",
+    "@atlaskit/dropdown-menu": "^11.9.0",
     "@atlaskit/ds-lib": "^2.2.0",
-    "@atlaskit/menu": "^1.6.0",
+    "@atlaskit/menu": "^1.7.0",
     "@atlaskit/modal-dialog": "^12.5.0",
     "@atlaskit/section-message": "^6.4.0",
     "@atlaskit/ssr": "*",