@atlaskit/page-layout 1.3.1 → 1.3.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/page-layout
 
+## 1.3.2
+
+### Patch Changes
+
+- [`522a27e6119`](https://bitbucket.org/atlassian/atlassian-frontend/commits/522a27e6119) - Remove `isOpen` prop from @atlaskit/banner, it is now open by default.
+- Updated dependencies
+
 ## 1.3.1
 
 ### Patch Changes

package/dist/cjs/components/index.js

@@ -8,7 +8,7 @@ Object.defineProperty(exports, "__esModule", {
 Object.defineProperty(exports, "Banner", {
   enumerable: true,
   get: function get() {
-    return _banner.default;
+    return _bannerSlot.default;
   }
 });
 Object.defineProperty(exports, "Content", {
@@ -92,7 +92,7 @@ var _leftSidebar = _interopRequireDefault(require("./slots/left-sidebar"));
 
 var _leftSidebarWithoutResize = _interopRequireDefault(require("./slots/left-sidebar-without-resize"));
 
-var _banner = _interopRequireDefault(require("./slots/banner"));
+var _bannerSlot = _interopRequireDefault(require("./slots/banner-slot"));
 
 var _topNavigation = _interopRequireDefault(require("./slots/top-navigation"));
 

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/page-layout",
-	"version": "1.3.1",
+	"version": "1.3.2",
 	"sideEffects": false
 }

package/dist/es2019/components/index.js

@@ -5,7 +5,7 @@ export { default as LeftPanel } from './slots/left-panel';
 export { default as RightSidebar } from './slots/right-sidebar';
 export { default as LeftSidebar } from './slots/left-sidebar';
 export { default as LeftSidebarWithoutResize } from './slots/left-sidebar-without-resize';
-export { default as Banner } from './slots/banner';
+export { default as Banner } from './slots/banner-slot';
 export { default as TopNavigation } from './slots/top-navigation';
 export { default as Content } from './slots/content';
 export { default as ResizeControl } from './resize-control';

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/page-layout",
-	"version": "1.3.1",
+	"version": "1.3.2",
 	"sideEffects": false
 }

package/dist/esm/components/index.js

@@ -5,7 +5,7 @@ export { default as LeftPanel } from './slots/left-panel';
 export { default as RightSidebar } from './slots/right-sidebar';
 export { default as LeftSidebar } from './slots/left-sidebar';
 export { default as LeftSidebarWithoutResize } from './slots/left-sidebar-without-resize';
-export { default as Banner } from './slots/banner';
+export { default as Banner } from './slots/banner-slot';
 export { default as TopNavigation } from './slots/top-navigation';
 export { default as Content } from './slots/content';
 export { default as ResizeControl } from './resize-control';

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/page-layout",
-	"version": "1.3.1",
+	"version": "1.3.2",
 	"sideEffects": false
 }

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

@@ -5,7 +5,7 @@ export { default as LeftPanel } from './slots/left-panel';
 export { default as RightSidebar } from './slots/right-sidebar';
 export { default as LeftSidebar } from './slots/left-sidebar';
 export { default as LeftSidebarWithoutResize } from './slots/left-sidebar-without-resize';
-export { default as Banner } from './slots/banner';
+export { default as Banner } from './slots/banner-slot';
 export { default as TopNavigation } from './slots/top-navigation';
 export { default as Content } from './slots/content';
 export { default as ResizeControl } from './resize-control';

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

@@ -5,7 +5,7 @@ export { default as LeftPanel } from './slots/left-panel';
 export { default as RightSidebar } from './slots/right-sidebar';
 export { default as LeftSidebar } from './slots/left-sidebar';
 export { default as LeftSidebarWithoutResize } from './slots/left-sidebar-without-resize';
-export { default as Banner } from './slots/banner';
+export { default as Banner } from './slots/banner-slot';
 export { default as TopNavigation } from './slots/top-navigation';
 export { default as Content } from './slots/content';
 export { default as ResizeControl } from './resize-control';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/page-layout",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "A collection of components which let you compose an application's page layout.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -33,7 +33,7 @@
   "homepage": "https://atlassian.design/components/page-layout/",
   "dependencies": {
     "@atlaskit/ds-lib": "^2.1.0",
-    "@atlaskit/icon": "^21.10.0",
+    "@atlaskit/icon": "^21.11.0",
     "@atlaskit/motion": "^1.2.0",
     "@atlaskit/theme": "^12.2.0",
     "@atlaskit/tokens": "^0.10.0",
@@ -51,16 +51,16 @@
     "@atlaskit/atlassian-notifications": "^0.3.0",
     "@atlaskit/button": "^16.3.0",
     "@atlaskit/docs": "*",
-    "@atlaskit/drawer": "^7.2.0",
+    "@atlaskit/drawer": "^7.3.0",
     "@atlaskit/icon": "*",
-    "@atlaskit/logo": "^13.9.0",
+    "@atlaskit/logo": "^13.10.0",
     "@atlaskit/menu": "^1.3.0",
     "@atlaskit/notification-indicator": "^9.0.0",
     "@atlaskit/notification-log-client": "^6.0.0",
-    "@atlaskit/onboarding": "^10.5.0",
-    "@atlaskit/popup": "^1.4.0",
-    "@atlaskit/section-message": "^6.2.0",
-    "@atlaskit/side-navigation": "^1.2.0",
+    "@atlaskit/onboarding": "^10.6.0",
+    "@atlaskit/popup": "^1.5.0",
+    "@atlaskit/section-message": "^6.3.0",
+    "@atlaskit/side-navigation": "^1.3.0",
     "@atlaskit/ssr": "*",
     "@atlaskit/tooltip": "*",
     "@atlaskit/visual-regression": "*",

package/report.api.md

@@ -1,29 +1,48 @@
-## API Report File for "@atlaskit/page-layout"
+## API Report File for "@atlaskit/page-layout".
 
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
 
-```ts
-/// <reference types="react" />
+[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
+```ts
 import { ButtonHTMLAttributes } from 'react';
 import { ElementType } from 'react';
+import { jsx } from '@emotion/react';
 import { KeyboardEvent as KeyboardEvent_2 } from 'react';
 import { MouseEvent as MouseEvent_2 } from 'react';
 import { ReactElement } from 'react';
 import { ReactNode } from 'react';
 
-export declare const Banner: (props: SlotHeightProps) => JSX.Element;
+/**
+ * __Banner__
+ *
+ * Provides a slot for a Banner within the PageLayout.
+ *
+ * - [Examples](https://atlassian.design/components/page-layout/examples)
+ * - [Code](https://atlassian.design/components/page-layout/code)
+ */
+export declare const Banner: (props: SlotHeightProps) => jsx.JSX.Element;
 
 export declare const BANNER_HEIGHT: string;
 
-export declare const Content: (props: ContentProps) => JSX.Element;
+/**
+ * __Content__
+ *
+ * Provides a slot for your application content within the PageLayout.
+ *
+ * - [Examples](https://atlassian.design/components/page-layout/examples)
+ * - [Code](https://atlassian.design/components/page-layout/code)
+ */
+export declare const Content: (props: ContentProps) => jsx.JSX.Element;
 
 declare interface ContentProps {
-  /** React children! */
+  /**
+   * React children
+   */
   children: ReactNode;
   /**
    * 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;
 }
 
@@ -42,16 +61,34 @@ export declare const LEFT_PANEL_WIDTH: string;
 
 export declare const LEFT_SIDEBAR_WIDTH: string;
 
-export declare const LeftPanel: (props: SlotWidthProps) => JSX.Element;
+/**
+ * __Left panel__
+ *
+ * Provides a slot for a left panel within the PageLayout.
+ *
+ * - [Examples](https://atlassian.design/components/page-layout/examples)
+ * - [Code](https://atlassian.design/components/page-layout/code)
+ */
+export declare const LeftPanel: (props: SlotWidthProps) => jsx.JSX.Element;
 
-export declare const LeftSidebar: (props: LeftSidebarProps) => JSX.Element;
+/**
+ * __Left sidebar__
+ *
+ * Provides a slot for a left sidebar within the PageLayout.
+ *
+ * - [Examples](https://atlassian.design/components/page-layout/examples)
+ * - [Code](https://atlassian.design/components/page-layout/code)
+ */
+export declare const LeftSidebar: (props: LeftSidebarProps) => jsx.JSX.Element;
 
 declare interface LeftSidebarProps extends SlotWidthProps {
   /**
    * 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;
-  /** You can override prop(s) for the mentioned component(s). */
+  /**
+   * You can override prop(s) for the mentioned component(s).
+   */
   overrides?: {
     ResizeButton?: {
       render?: (
@@ -60,25 +97,45 @@ declare interface LeftSidebarProps extends SlotWidthProps {
       ) => ReactElement;
     };
   };
-  /** Display label for grab area. This will be announced to the screenreaders when the grab area receives focus */
+  /**
+   * Display label for grab area. This will be announced to the screenreaders when the grab area receives focus
+   */
   resizeGrabAreaLabel?: string;
-  /** Display label for resize button. */
+  /**
+   * Display label for resize button.
+   */
   resizeButtonLabel?: string;
-  /** Called when left-sidebar is collapsed. */
+  /**
+   * Called when left-sidebar is collapsed.
+   */
   onCollapse?: () => void;
-  /** Called when left-sidebar is expanded. */
+  /**
+   * Called when left-sidebar is expanded.
+   */
   onExpand?: () => void;
-  /** Called when left-sidebar resize starts using mouse or touch. */
+  /**
+   * Called when left-sidebar resize starts using mouse or touch.
+   */
   onResizeStart?: (leftSidebarState: LeftSidebarState) => void;
-  /** Called when left-sidebar resize ends using mouse or touch. */
+  /**
+   * Called when left-sidebar resize ends using mouse or touch.
+   */
   onResizeEnd?: (leftSidebarState: LeftSidebarState) => void;
-  /** Called when left-sidebar is collapsed and mouse leaves the area. */
+  /**
+   * Called when left-sidebar is collapsed and mouse leaves the area.
+   */
   onFlyoutCollapse?: () => void;
-  /** Called after flyout delay when left-sidebar is collapsed and mouse enters the area. */
+  /**
+   * Called after flyout delay when left-sidebar is collapsed and mouse enters the area.
+   */
   onFlyoutExpand?: () => void;
-  /** Controls whether the LeftSidebar mounts in a collapsed state, this will override the setting in localStorage */
+  /**
+   * Controls whether the LeftSidebar mounts in a collapsed state, this will override the setting in localStorage
+   */
   collapsedState?: 'collapsed' | 'expanded';
-  /** Controls the width when LeftSidebar mounts, this will override the setting in localStorage */
+  /**
+   * Controls the width when LeftSidebar mounts, this will override the setting in localStorage
+   */
   width?: number;
 }
 
@@ -92,27 +149,53 @@ export declare type LeftSidebarState = {
   isFixed: boolean;
 };
 
+/**
+ * __Left sidebar without resize__
+ *
+ * Provides a slot for a left sidebar without resize within the PageLayout.
+ *
+ * - [Examples](https://atlassian.design/components/page-layout/examples)
+ * - [Code](https://atlassian.design/components/page-layout/code)
+ */
 export declare const LeftSidebarWithoutResize: (
   props: SlotWidthProps,
-) => JSX.Element;
+) => jsx.JSX.Element;
 
-export declare const Main: (props: SlotWidthProps) => JSX.Element;
+/**
+ * __Main__
+ *
+ * Provides a slot for main content within the PageLayout.
+ *
+ * - [Examples](https://atlassian.design/components/page-layout/examples)
+ * - [Code](https://atlassian.design/components/page-layout/code)
+ */
+export declare const Main: (props: SlotWidthProps) => jsx.JSX.Element;
 
+/**
+ * __Page layout__
+ *
+ * A collection of components which let you compose an application's page layout.
+ *
+ * - [Examples](https://atlassian.design/components/page-layout/examples)
+ * - [Code](https://atlassian.design/components/page-layout/code)
+ */
 export declare const PageLayout: ({
   skipLinksLabel,
   children,
   testId,
   onLeftSidebarExpand,
   onLeftSidebarCollapse,
-}: PageLayoutProps) => JSX.Element;
+}: PageLayoutProps) => jsx.JSX.Element;
 
 declare interface PageLayoutProps extends SidebarResizeControllerProps {
-  /** React children! */
+  /**
+   * React children!
+   */
   children: ReactNode;
   skipLinksLabel?: string;
   /**
    * 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;
 }
 
@@ -126,56 +209,102 @@ export declare const RIGHT_PANEL_WIDTH: string;
 
 export declare const RIGHT_SIDEBAR_WIDTH: string;
 
-export declare const RightPanel: (props: SlotWidthProps) => JSX.Element;
+/**
+ * __Right panel__
+ *
+ * Provides a slot for a right panel within the PageLayout.
+ *
+ * - [Examples](https://atlassian.design/components/page-layout/examples)
+ * - [Code](https://atlassian.design/components/page-layout/code)
+ */
+export declare const RightPanel: (props: SlotWidthProps) => jsx.JSX.Element;
 
-export declare const RightSidebar: (props: SlotWidthProps) => JSX.Element;
+/**
+ * __Right sidebar__
+ *
+ * Provides a slot for a right sidebar within the PageLayout.
+ *
+ * - [Examples](https://atlassian.design/components/page-layout/examples)
+ * - [Code](https://atlassian.design/components/page-layout/code)
+ */
+export declare const RightSidebar: (props: SlotWidthProps) => jsx.JSX.Element;
 
 declare type SidebarResizeControllerProps = {
-  /** Called when left-sidebar expanded. */
+  /**
+   * Called when left-sidebar expanded.
+   */
   onLeftSidebarExpand?: (leftSidebarState: LeftSidebarState) => void;
-  /** Called when left-sidebar collapsed. */
+  /**
+   * Called when left-sidebar collapsed.
+   */
   onLeftSidebarCollapse?: (leftSidebarState: LeftSidebarState) => void;
 };
 
 declare type SkipLinkData = {
-  /** id for the element that will be skipped to */
+  /**
+   * id for the element that will be skipped to
+   */
   id: string;
-  /** Text for the link that will appear in the skip link menu */
+  /**
+   * Text for the link that will appear in the skip link menu
+   */
   skipLinkTitle: string;
-  /** Desired position in the skip link menu */
+  /**
+   * Desired position in the skip link menu
+   */
   listIndex?: number;
 };
 
 export declare interface SlotHeightProps extends SlotProps {
-  /** It save height in local storage. */
+  /**
+   * It save height in local storage.
+   */
   shouldPersistHeight?: boolean;
-  /** Height! */
+  /**
+   * Height!
+   */
   height?: number;
 }
 
 declare interface SlotProps {
-  /** Sets positon to fixed. */
+  /**
+   * Sets positon to fixed.
+   */
   isFixed?: 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;
-  /** React Children! */
+  /**
+   * React Children!
+   */
   children: ReactNode;
   id?: string;
   skipLinkTitle?: string;
 }
 
 export declare interface SlotWidthProps extends SlotProps {
-  /** It save width in local storage. */
+  /**
+   * It save width in local storage.
+   */
   shouldPersistWidth?: boolean;
-  /** Width! */
+  /**
+   * Width!
+   */
   width?: number;
 }
 
 export declare const TOP_NAVIGATION_HEIGHT: string;
 
-export declare const TopNavigation: (props: SlotHeightProps) => JSX.Element;
+/**
+ * __Top navigation__
+ *
+ * Provides a slot for top navigation within the PageLayout.
+ *
+ * - [Examples](https://atlassian.design/components/page-layout/examples)
+ * - [Code](https://atlassian.design/components/page-layout/code)
+ */
+export declare const TopNavigation: (props: SlotHeightProps) => jsx.JSX.Element;
 
 export declare const useCustomSkipLink: (
   id: SkipLinkData['id'],
@@ -184,7 +313,7 @@ export declare const useCustomSkipLink: (
 ) => void;
 
 /**
- * **WARNING:** This hook is intended as a temporary solution and
+ * _**WARNING:**_ This hook is intended as a temporary solution and
  * is likely to be removed in a future version of page-layout.
  *
  * ---