@atlaskit/drawer 7.1.3 → 7.1.6

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/drawer
 
+## 7.1.6
+
+### Patch Changes
+
+- [`ac9343c3ed4`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ac9343c3ed4) - Replaces usage of deprecated design tokens. No visual or functional changes
+- Updated dependencies
+
+## 7.1.5
+
+### Patch Changes
+
+- Updated dependencies
+
+## 7.1.4
+
+### Patch Changes
+
+- [`e9210b8a098`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e9210b8a098) - Updates Drawer with deprecated status for `cssFn`/`overrides APIs.
+
 ## 7.1.3
 
 ### Patch Changes

package/README.md

@@ -0,0 +1,13 @@
+# Drawer
+
+A drawer is a panel that slides in from the left side of the screen.
+
+## Installation
+
+```sh
+yarn add @atlaskit/drawer
+```
+
+## Usage
+
+[View documentation](https://atlassian.design/components/drawer).

package/dist/cjs/components/index.js

@@ -52,7 +52,7 @@ function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflec
 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; } }
 
 var packageName = "@atlaskit/drawer";
-var packageVersion = "7.1.3";
+var packageVersion = "7.1.6";
 
 var OnlyChild = function OnlyChild(_ref) {
   var children = _ref.children;

package/dist/cjs/components/utils.js

@@ -5,6 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.createExtender = void 0;
 
+/**
+ * @deprecated Please avoid using this function as we intend to remote it in a future release. See DSP-2673 for more information.
+ */
 var createExtender = function createExtender(defaults) {
   var overrides = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : Object.create(Object.prototype);
 

package/dist/cjs/version.json

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

package/dist/es2019/components/index.js

@@ -10,7 +10,7 @@ import FocusLock from './focus-lock';
 import DrawerPrimitive from './primitives';
 import { Fade } from './transitions';
 const packageName = "@atlaskit/drawer";
-const packageVersion = "7.1.3";
+const packageVersion = "7.1.6";
 
 const OnlyChild = ({
   children

package/dist/es2019/components/utils.js

@@ -1,3 +1,6 @@
+/**
+ * @deprecated Please avoid using this function as we intend to remote it in a future release. See DSP-2673 for more information.
+ */
 export const createExtender = function createExtender(defaults,
 /** We're defaulting to an Object.create call here to circumvent
  *  the fact that {} can't be reconciled

package/dist/es2019/version.json

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

package/dist/esm/components/index.js

@@ -21,7 +21,7 @@ import FocusLock from './focus-lock';
 import DrawerPrimitive from './primitives';
 import { Fade } from './transitions';
 var packageName = "@atlaskit/drawer";
-var packageVersion = "7.1.3";
+var packageVersion = "7.1.6";
 
 var OnlyChild = function OnlyChild(_ref) {
   var children = _ref.children;

package/dist/esm/components/utils.js

@@ -1,3 +1,6 @@
+/**
+ * @deprecated Please avoid using this function as we intend to remote it in a future release. See DSP-2673 for more information.
+ */
 export var createExtender = function createExtender(defaults) {
   var overrides = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : Object.create(Object.prototype);
 

package/dist/esm/version.json

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

package/dist/types/components/types.d.ts

@@ -10,25 +10,21 @@ export declare type Widths = {
 };
 export declare type DrawerWidth = 'extended' | 'full' | 'medium' | 'narrow' | 'wide';
 export interface BaseProps {
-    /** A unique hook to be used for testing */
+    /** A unique hook to be used for testing. */
     testId?: string;
-    /** The content of the drawer */
+    /** The content of the drawer. */
     children?: ReactNode;
-    /** Icon to be rendered in your drawer as a component, if available */
+    /** Icon to be rendered in your drawer as a component, if available. */
     icon?: ComponentType<any>;
-    /** Available drawer sizes */
+    /** Available drawer sizes. */
     width?: DrawerWidth;
-    /** A callback function that will be called when the drawer has finished its opening transition. */
+    /** Callback function called when the drawer has finished its opening transition. */
     onOpenComplete?: (node: HTMLElement) => void;
-    /** A callback function that will be called when the drawer has finished its close transition. */
+    /** Callback function called when the drawer has finished its close transition. */
     onCloseComplete?: (node: HTMLElement) => void;
-    /** Boolean that controls if drawer should be retained/discarded */
+    /** Controls if drawer state should be retained/discarded on close. */
     shouldUnmountOnExit?: boolean;
-    /**
-     * A prop for adding targeted customisations to the Drawer component
-     * For a detailed explanation of how to use this prop,
-     * please see the overrides section of the @atlaskit/drawer documentation.
-     */
+    /** Override drawer components. */
     overrides?: OverridesType;
 }
 export declare type DefaultsType = {
@@ -44,20 +40,32 @@ export declare type DefaultsType = {
 export declare 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 declare type DrawerPrimitiveDefaults = Pick<DefaultsType, 'Sidebar' | 'Content'>;
 export declare 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 declare 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 declare type ContentCSSProps = Omit<ContentProps, 'cssFn'>;
@@ -66,36 +74,22 @@ export interface DrawerPrimitiveProps extends BaseProps {
     onClose: (event: SyntheticEvent<HTMLElement>) => void;
 }
 export declare type DrawerProps = BaseProps & FocusLockProps & WithAnalyticsEventsProps & {
-    /**
-      Callback function that will be called when the drawer is displayed and `keydown` event is triggered.
-    */
+    /** Callback function called while the drawer is displayed and `keydown` event is triggered. */
     onKeyDown?: (event: SyntheticEvent) => void;
-    /**
-    Callback function to be called when the drawer will be closed.
-  */
+    /** Callback function called when the drawer is closed. */
     onClose?: (event: SyntheticEvent<HTMLElement>, analyticsEvent: any) => void;
-    /** Controls if the drawer is open or close */
+    /** Controls if the drawer is open or closed. */
     isOpen: boolean;
 };
 export interface FocusLockProps {
-    /**
-      Boolean indicating whether to focus on the first tabbable element inside the focus lock.
-    */
+    /** Controls whether to focus the first tabbable element inside the focus lock. */
     autoFocusFirstElem?: boolean | (() => HTMLElement | null);
-    /**
-      Content inside the focus lock.
-    */
+    /** Content inside the focus lock. */
     children?: ReactNode;
-    /**
-      Whether the focus lock is active or not.
-    */
+    /**  Whether the focus lock is active or not. */
     isFocusLockEnabled?: boolean;
-    /**
-      Whether to return the focus to the previous active element on closing the drawer
-    */
+    /** Whether to return the focus to the previous active element on closing the drawer. */
     shouldReturnFocus?: boolean;
 }
-/**
-  Type of keyboard event that triggers which key will should close the drawer.
-*/
+/** Type of keyboard event that triggers which key will should close the drawer. */
 export declare type CloseTrigger = 'backButton' | 'blanket' | 'escKey';

package/dist/types/components/utils.d.ts

@@ -1,4 +1,7 @@
 declare type OverridesFunc<X extends Record<string, any>, Y extends Record<string, any>> = (key: string) => Record<string, any>;
 export declare 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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atlaskit/drawer",
-  "version": "7.1.3",
-  "description": "React component the renders a Drawer from the left of the screen",
+  "version": "7.1.6",
+  "description": "A drawer is a panel that slides in from the left side of the screen.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
@@ -14,6 +14,7 @@
   "types": "dist/types/index.d.ts",
   "sideEffects": false,
   "atlaskit:src": "src/index.ts",
+  "homepage": "https://atlassian.design/components/drawer",
   "atlassian": {
     "team": "Design System Team",
     "deprecatedAutoEntryPoints": true,
@@ -28,7 +29,7 @@
     "@atlaskit/icon": "^21.10.0",
     "@atlaskit/portal": "^4.0.0",
     "@atlaskit/theme": "^12.1.0",
-    "@atlaskit/tokens": "^0.6.0",
+    "@atlaskit/tokens": "^0.8.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/core": "^10.0.9",
     "exenv": "^1.2.2",
@@ -40,12 +41,15 @@
     "react": "^16.8.0"
   },
   "devDependencies": {
-    "@atlaskit/button": "^16.0.0",
+    "@atlaskit/button": "^16.2.0",
+    "@atlaskit/checkbox": "^12.3.9",
+    "@atlaskit/code": "^14.3.3",
     "@atlaskit/docs": "*",
-    "@atlaskit/dropdown-menu": "^11.0.0",
-    "@atlaskit/menu": "^1.2.0",
+    "@atlaskit/dropdown-menu": "^11.1.0",
+    "@atlaskit/menu": "^1.3.0",
     "@atlaskit/section-message": "^6.0.0",
     "@atlaskit/ssr": "*",
+    "@atlaskit/textarea": "^4.3.1",
     "@atlaskit/visual-regression": "*",
     "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",