@atlaskit/page-layout 3.3.3 → 3.4.0

package/package.json

@@ -1,124 +1,124 @@
 {
-  "name": "@atlaskit/page-layout",
-  "version": "3.3.3",
-  "description": "A collection of components which let you compose an application's page layout.",
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/"
-  },
-  "repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
-  "author": "Atlassian Pty Ltd",
-  "license": "Apache-2.0",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "module:es2019": "dist/es2019/index.js",
-  "types": "dist/types/index.d.ts",
-  "typesVersions": {
-    ">=4.5 <4.9": {
-      "*": [
-        "dist/types-ts4.5/*",
-        "dist/types-ts4.5/index.d.ts"
-      ]
-    }
-  },
-  "sideEffects": false,
-  "atlaskit:src": "src/index.tsx",
-  "af:exports": {
-    ".": "./src/index.tsx"
-  },
-  "atlassian": {
-    "team": "Design System Team",
-    "releaseModel": "continuous",
-    "productPushConsumption": [
-      "jira"
-    ],
-    "website": {
-      "name": "Page layout",
-      "category": "Components"
-    },
-    "runReact18": true
-  },
-  "homepage": "https://atlassian.design/components/page-layout/",
-  "dependencies": {
-    "@atlaskit/ds-lib": "^2.3.0",
-    "@atlaskit/icon": "^22.3.0",
-    "@atlaskit/link": "^0.4.0",
-    "@atlaskit/motion": "^1.6.0",
-    "@atlaskit/platform-feature-flags": "^0.2.0",
-    "@atlaskit/primitives": "^7.0.0",
-    "@atlaskit/theme": "^12.9.0",
-    "@atlaskit/tokens": "^1.49.0",
-    "@babel/runtime": "^7.0.0",
-    "@emotion/react": "^11.7.1",
-    "bind-event-listener": "^3.0.0",
-    "raf-schd": "^4.0.3"
-  },
-  "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0 || ~18.2.0",
-    "react-dom": "^16.8.0"
-  },
-  "devDependencies": {
-    "@af/accessibility-testing": "*",
-    "@af/integration-testing": "*",
-    "@atlaskit/atlassian-navigation": "^4.0.0",
-    "@atlaskit/atlassian-notifications": "^0.4.0",
-    "@atlaskit/drawer": "^7.11.0",
-    "@atlaskit/logo": "^14.0.0",
-    "@atlaskit/menu": "^2.4.0",
-    "@atlaskit/notification-indicator": "^9.2.0",
-    "@atlaskit/notification-log-client": "^6.1.0",
-    "@atlaskit/popup": "^1.17.0",
-    "@atlaskit/side-navigation": "^3.2.0",
-    "@atlaskit/ssr": "*",
-    "@atlaskit/toggle": "^13.1.0",
-    "@atlaskit/tooltip": "^18.4.0",
-    "@atlaskit/visual-regression": "*",
-    "@testing-library/dom": "^8.17.1",
-    "@testing-library/react": "^12.1.5",
-    "@testing-library/react-hooks": "^8.0.1",
-    "@types/raf-schd": "^4.0.1",
-    "jest-emotion": "^10.0.32",
-    "raf-stub": "^2.0.1",
-    "storybook-addon-performance": "^0.16.0",
-    "typescript": "~5.4.2"
-  },
-  "keywords": [
-    "atlaskit",
-    "react",
-    "ui"
-  ],
-  "techstack": {
-    "@atlassian/frontend": {
-      "import-structure": "atlassian-conventions"
-    },
-    "@repo/internal": {
-      "dom-events": "use-bind-event-listener",
-      "design-system": "v1",
-      "ui-components": [
-        "lite-mode"
-      ],
-      "analytics": [
-        "analytics-next"
-      ],
-      "design-tokens": [
-        "color",
-        "spacing"
-      ],
-      "theming": [
-        "react-context"
-      ],
-      "deprecation": "no-deprecated-imports",
-      "styling": [
-        "emotion",
-        "static"
-      ]
-    }
-  },
-  "platform-feature-flags": {
-    "platform.design-system-team.page-layout-resize-button-fix_u0qxv": {
-      "type": "boolean"
-    },
-    "platform.atlassian.griffin-navigation-redesign": {
-      "type": "boolean"
-    }
-  }
-}
+	"name": "@atlaskit/page-layout",
+	"version": "3.4.0",
+	"description": "A collection of components which let you compose an application's page layout.",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
+	"author": "Atlassian Pty Ltd",
+	"license": "Apache-2.0",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"module:es2019": "dist/es2019/index.js",
+	"types": "dist/types/index.d.ts",
+	"typesVersions": {
+		">=4.5 <4.9": {
+			"*": [
+				"dist/types-ts4.5/*",
+				"dist/types-ts4.5/index.d.ts"
+			]
+		}
+	},
+	"sideEffects": false,
+	"atlaskit:src": "src/index.tsx",
+	"af:exports": {
+		".": "./src/index.tsx"
+	},
+	"atlassian": {
+		"team": "Design System Team",
+		"releaseModel": "continuous",
+		"productPushConsumption": [
+			"jira"
+		],
+		"website": {
+			"name": "Page layout",
+			"category": "Components"
+		},
+		"runReact18": true
+	},
+	"homepage": "https://atlassian.design/components/page-layout/",
+	"dependencies": {
+		"@atlaskit/ds-lib": "^2.3.0",
+		"@atlaskit/icon": "^22.4.0",
+		"@atlaskit/link": "^0.5.0",
+		"@atlaskit/motion": "^1.7.0",
+		"@atlaskit/platform-feature-flags": "^0.2.0",
+		"@atlaskit/primitives": "^7.4.0",
+		"@atlaskit/theme": "^12.10.0",
+		"@atlaskit/tokens": "^1.51.0",
+		"@babel/runtime": "^7.0.0",
+		"@emotion/react": "^11.7.1",
+		"bind-event-listener": "^3.0.0",
+		"raf-schd": "^4.0.3"
+	},
+	"peerDependencies": {
+		"react": "^16.8.0 || ^17.0.0 || ~18.2.0",
+		"react-dom": "^16.8.0"
+	},
+	"devDependencies": {
+		"@af/accessibility-testing": "*",
+		"@af/integration-testing": "*",
+		"@atlaskit/atlassian-navigation": "^4.1.0",
+		"@atlaskit/atlassian-notifications": "^0.4.0",
+		"@atlaskit/drawer": "^7.11.0",
+		"@atlaskit/logo": "^14.1.0",
+		"@atlaskit/menu": "^2.5.0",
+		"@atlaskit/notification-indicator": "^9.2.0",
+		"@atlaskit/notification-log-client": "^6.1.0",
+		"@atlaskit/popup": "^1.19.0",
+		"@atlaskit/side-navigation": "^3.3.0",
+		"@atlaskit/ssr": "*",
+		"@atlaskit/toggle": "^13.2.0",
+		"@atlaskit/tooltip": "^18.5.0",
+		"@atlaskit/visual-regression": "*",
+		"@testing-library/dom": "^8.17.1",
+		"@testing-library/react": "^12.1.5",
+		"@testing-library/react-hooks": "^8.0.1",
+		"@types/raf-schd": "^4.0.1",
+		"jest-emotion": "^10.0.32",
+		"raf-stub": "^2.0.1",
+		"storybook-addon-performance": "^0.16.0",
+		"typescript": "~5.4.2"
+	},
+	"keywords": [
+		"atlaskit",
+		"react",
+		"ui"
+	],
+	"techstack": {
+		"@atlassian/frontend": {
+			"import-structure": "atlassian-conventions"
+		},
+		"@repo/internal": {
+			"dom-events": "use-bind-event-listener",
+			"design-system": "v1",
+			"ui-components": [
+				"lite-mode"
+			],
+			"analytics": [
+				"analytics-next"
+			],
+			"design-tokens": [
+				"color",
+				"spacing"
+			],
+			"theming": [
+				"react-context"
+			],
+			"deprecation": "no-deprecated-imports",
+			"styling": [
+				"emotion",
+				"static"
+			]
+		}
+	},
+	"platform-feature-flags": {
+		"platform.design-system-team.page-layout-resize-button-fix_u0qxv": {
+			"type": "boolean"
+		},
+		"platform.atlassian.griffin-navigation-redesign": {
+			"type": "boolean"
+		}
+	}
+}

package/report.api.md

@@ -2,7 +2,8 @@
 
 ## API Report File for "@atlaskit/page-layout"
 
-> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated using
+> [API Extractor](https://api-extractor.com/).
 > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
 ### Table of contents
@@ -34,19 +35,19 @@ export const Content: (props: ContentProps) => jsx.JSX.Element;
 
 // @public (undocumented)
 interface ContentProps {
-  children: ReactNode;
-  testId?: string;
+	children: ReactNode;
+	testId?: string;
 }
 
 // @public (undocumented)
 type DimensionNames =
-  | 'bannerHeight'
-  | 'leftPanelWidth'
-  | 'leftSidebarFlyoutWidth'
-  | 'leftSidebarWidth'
-  | 'rightPanelWidth'
-  | 'rightSidebarWidth'
-  | 'topNavigationHeight';
+	| 'bannerHeight'
+	| 'leftPanelWidth'
+	| 'leftSidebarFlyoutWidth'
+	| 'leftSidebarWidth'
+	| 'rightPanelWidth'
+	| 'rightSidebarWidth'
+	| 'topNavigationHeight';
 
 // @public (undocumented)
 export type Dimensions = Partial<Record<DimensionNames, number>>;
@@ -65,68 +66,66 @@ export const LeftSidebar: (props: LeftSidebarProps) => jsx.JSX.Element;
 
 // @public (undocumented)
 interface LeftSidebarProps extends SlotWidthProps {
-  collapsedState?: 'collapsed' | 'expanded';
-  onCollapse?: () => void;
-  onExpand?: () => void;
-  onFlyoutCollapse?: () => void;
-  onFlyoutExpand?: () => void;
-  onResizeEnd?: (leftSidebarState: LeftSidebarState) => void;
-  onResizeStart?: (leftSidebarState: LeftSidebarState) => void;
-  overrides?: {
-    ResizeButton?: {
-      render?: (
-        Component: ElementType<ResizeButtonProps>,
-        props: ResizeButtonProps,
-      ) => ReactElement;
-    };
-  };
-  resizeButtonLabel?: string;
-  resizeGrabAreaLabel?: string;
-  testId?: string;
-  valueTextLabel?: string;
-  width?: number;
+	collapsedState?: 'collapsed' | 'expanded';
+	onCollapse?: () => void;
+	onExpand?: () => void;
+	onFlyoutCollapse?: () => void;
+	onFlyoutExpand?: () => void;
+	onResizeEnd?: (leftSidebarState: LeftSidebarState) => void;
+	onResizeStart?: (leftSidebarState: LeftSidebarState) => void;
+	overrides?: {
+		ResizeButton?: {
+			render?: (
+				Component: ElementType<ResizeButtonProps>,
+				props: ResizeButtonProps,
+			) => ReactElement;
+		};
+	};
+	resizeButtonLabel?: string;
+	resizeGrabAreaLabel?: string;
+	testId?: string;
+	valueTextLabel?: string;
+	width?: number;
 }
 
 // @public (undocumented)
 export type LeftSidebarState = {
-  isFlyoutOpen: boolean;
-  isResizing: boolean;
-  isLeftSidebarCollapsed: boolean;
-  leftSidebarWidth: number;
-  lastLeftSidebarWidth: number;
-  flyoutLockCount: number;
-  isFixed: boolean;
+	isFlyoutOpen: boolean;
+	isResizing: boolean;
+	isLeftSidebarCollapsed: boolean;
+	leftSidebarWidth: number;
+	lastLeftSidebarWidth: number;
+	flyoutLockCount: number;
+	isFixed: boolean;
 };
 
 // @public
-export const LeftSidebarWithoutResize: (
-  props: SlotWidthProps,
-) => jsx.JSX.Element;
+export const LeftSidebarWithoutResize: (props: SlotWidthProps) => jsx.JSX.Element;
 
 // @public
 export const Main: (props: SlotWidthProps) => jsx.JSX.Element;
 
 // @public
 export const PageLayout: ({
-  skipLinksLabel,
-  children,
-  testId,
-  onLeftSidebarExpand,
-  onLeftSidebarCollapse,
+	skipLinksLabel,
+	children,
+	testId,
+	onLeftSidebarExpand,
+	onLeftSidebarCollapse,
 }: PageLayoutProps) => jsx.JSX.Element;
 
 // @public (undocumented)
 interface PageLayoutProps extends SidebarResizeControllerProps {
-  // (undocumented)
-  skipLinksLabel?: string;
-  testId?: string;
+	// (undocumented)
+	skipLinksLabel?: string;
+	testId?: string;
 }
 
 // @public (undocumented)
 type ResizeButtonProps = ButtonHTMLAttributes<HTMLButtonElement> & {
-  isLeftSidebarCollapsed: boolean;
-  label: string;
-  testId?: string;
+	isLeftSidebarCollapsed: boolean;
+	label: string;
+	testId?: string;
 };
 
 // @public (undocumented)
@@ -143,39 +142,39 @@ export const RightSidebar: (props: SlotWidthProps) => jsx.JSX.Element;
 
 // @public (undocumented)
 type SidebarResizeControllerProps = {
-  children: ReactNode;
-  onLeftSidebarExpand?: (leftSidebarState: LeftSidebarState) => void;
-  onLeftSidebarCollapse?: (leftSidebarState: LeftSidebarState) => void;
+	children: ReactNode;
+	onLeftSidebarExpand?: (leftSidebarState: LeftSidebarState) => void;
+	onLeftSidebarCollapse?: (leftSidebarState: LeftSidebarState) => void;
 };
 
 // @public (undocumented)
 type SkipLinkData = {
-  id: string;
-  skipLinkTitle: string;
-  listIndex?: number;
+	id: string;
+	skipLinkTitle: string;
+	listIndex?: number;
 };
 
 // @public (undocumented)
 export interface SlotHeightProps extends SlotProps {
-  height?: number;
-  shouldPersistHeight?: boolean;
+	height?: number;
+	shouldPersistHeight?: boolean;
 }
 
 // @public (undocumented)
 interface SlotProps {
-  children: ReactNode;
-  // (undocumented)
-  id?: string;
-  isFixed?: boolean;
-  // (undocumented)
-  skipLinkTitle?: string;
-  testId?: string;
+	children: ReactNode;
+	// (undocumented)
+	id?: string;
+	isFixed?: boolean;
+	// (undocumented)
+	skipLinkTitle?: string;
+	testId?: string;
 }
 
 // @public (undocumented)
 export interface SlotWidthProps extends SlotProps {
-  shouldPersistWidth?: boolean;
-  width?: number;
+	shouldPersistWidth?: boolean;
+	width?: number;
 }
 
 // @public (undocumented)
@@ -186,9 +185,9 @@ export const TopNavigation: (props: SlotHeightProps) => jsx.JSX.Element;
 
 // @public (undocumented)
 export const useCustomSkipLink: (
-  id: SkipLinkData['id'],
-  skipLinkTitle: SkipLinkData['skipLinkTitle'],
-  listIndex?: SkipLinkData['listIndex'],
+	id: SkipLinkData['id'],
+	skipLinkTitle: SkipLinkData['skipLinkTitle'],
+	listIndex?: SkipLinkData['listIndex'],
 ) => void;
 
 // @public
@@ -196,17 +195,17 @@ export const useLeftSidebarFlyoutLock: () => void;
 
 // @public (undocumented)
 export const usePageLayoutResize: () => {
-  isLeftSidebarCollapsed: boolean;
-  expandLeftSidebar: () => void;
-  collapseLeftSidebar: (
-    event?: KeyboardEvent_2 | MouseEvent_2,
-    collapseWithoutTransition?: boolean,
-  ) => void;
-  toggleLeftSidebar: (
-    event?: KeyboardEvent_2 | MouseEvent_2,
-    collapseWithoutTransition?: boolean,
-  ) => void;
-  leftSidebarState: LeftSidebarState;
+	isLeftSidebarCollapsed: boolean;
+	expandLeftSidebar: () => void;
+	collapseLeftSidebar: (
+		event?: KeyboardEvent_2 | MouseEvent_2,
+		collapseWithoutTransition?: boolean,
+	) => void;
+	toggleLeftSidebar: (
+		event?: KeyboardEvent_2 | MouseEvent_2,
+		collapseWithoutTransition?: boolean,
+	) => void;
+	leftSidebarState: LeftSidebarState;
 };
 
 // (No @packageDocumentation comment for this package)
@@ -220,8 +219,8 @@ export const usePageLayoutResize: () => {
 
 ```json
 {
-  "react": "^16.8.0",
-  "react-dom": "^16.8.0"
+	"react": "^16.8.0",
+	"react-dom": "^16.8.0"
 }
 ```