@atlaskit/page-layout 1.2.8 → 1.3.1

package/dist/types-ts4.0/components/slots/content.d.ts

@@ -0,0 +1,23 @@
+/** @jsx jsx */
+import { ReactNode } from 'react';
+import { jsx } from '@emotion/react';
+interface ContentProps {
+    /**
+     * 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;
+}
+/**
+ * __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)
+ */
+declare const Content: (props: ContentProps) => jsx.JSX.Element;
+export default Content;

package/dist/types-ts4.0/components/slots/internal/left-sidebar-inner.d.ts

@@ -0,0 +1,10 @@
+/** @jsx jsx */
+import type { ReactNode } from 'react';
+import { jsx } from '@emotion/react';
+declare type LeftSidebarInnerProps = {
+    children: ReactNode;
+    isFixed?: boolean;
+    isFlyoutOpen?: boolean;
+};
+declare const LeftSidebarInner: ({ children, isFixed, isFlyoutOpen, }: LeftSidebarInnerProps) => jsx.JSX.Element;
+export default LeftSidebarInner;

package/dist/types-ts4.0/components/slots/internal/left-sidebar-outer.d.ts

@@ -0,0 +1,13 @@
+/** @jsx jsx */
+import { MouseEventHandler, ReactNode } from 'react';
+declare type LeftSidebarOuterProps = {
+    children: ReactNode;
+    isFixed?: boolean;
+    isFlyoutOpen?: boolean;
+    testId?: string;
+    id?: string;
+    onMouseOver?: MouseEventHandler;
+    onMouseLeave?: MouseEventHandler;
+};
+declare const _default: import("react").ForwardRefExoticComponent<LeftSidebarOuterProps & import("react").RefAttributes<HTMLDivElement>>;
+export default _default;

package/dist/types-ts4.0/components/slots/internal/resizable-children-wrapper.d.ts

@@ -0,0 +1,11 @@
+/** @jsx jsx */
+import type { ReactNode } from 'react';
+import { jsx } from '@emotion/react';
+declare type ResizableChildrenWrapperProps = {
+    children: ReactNode;
+    isFlyoutOpen?: boolean;
+    isLeftSidebarCollapsed?: boolean;
+    hasCollapsedState?: boolean;
+};
+declare const ResizableChildrenWrapper: ({ children, isLeftSidebarCollapsed, hasCollapsedState, isFlyoutOpen, }: ResizableChildrenWrapperProps) => jsx.JSX.Element;
+export default ResizableChildrenWrapper;

package/dist/types-ts4.0/components/slots/internal/slot-focus-ring.d.ts

@@ -0,0 +1,20 @@
+/** @jsx jsx */
+import type { ReactNode } from 'react';
+import { jsx } from '@emotion/react';
+declare type SlotFocusRingProps = {
+    children: (props: {
+        className: string;
+    }) => ReactNode;
+    isSidebar?: boolean;
+};
+/**
+ * We don't use `@atlaskit/focus-ring` here,
+ * because we need inset focus styles and:
+ *
+ * 1. If we set them directly to the layout element,
+ *    then any child element's background will cover the shadow.
+ * 2. We cannot wrap `children` in `FocusRing`,
+ *    because there's no guarantee the passed child takes `className`.
+ */
+declare const SlotFocusRing: ({ children, isSidebar }: SlotFocusRingProps) => jsx.JSX.Element;
+export default SlotFocusRing;

package/dist/types-ts4.0/components/slots/left-panel.d.ts

@@ -0,0 +1,12 @@
+import { jsx } from '@emotion/react';
+import { SlotWidthProps } from '../../common/types';
+/**
+ * __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)
+ */
+declare const LeftPanel: (props: SlotWidthProps) => jsx.JSX.Element;
+export default LeftPanel;

package/dist/types-ts4.0/components/slots/left-sidebar-without-resize.d.ts

@@ -0,0 +1,12 @@
+import { jsx } from '@emotion/react';
+import { SlotWidthProps } from '../../common/types';
+/**
+ * __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)
+ */
+declare const LeftSidebarWithoutResize: (props: SlotWidthProps) => jsx.JSX.Element;
+export default LeftSidebarWithoutResize;

package/dist/types-ts4.0/components/slots/left-sidebar.d.ts

@@ -0,0 +1,12 @@
+import { jsx } from '@emotion/react';
+import { LeftSidebarProps } from '../../common/types';
+/**
+ * __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)
+ */
+declare const LeftSidebar: (props: LeftSidebarProps) => jsx.JSX.Element;
+export default LeftSidebar;

package/dist/types-ts4.0/components/slots/main.d.ts

@@ -0,0 +1,12 @@
+import { jsx } from '@emotion/react';
+import { SlotWidthProps } from '../../common/types';
+/**
+ * __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)
+ */
+declare const Main: (props: SlotWidthProps) => jsx.JSX.Element;
+export default Main;

package/dist/types-ts4.0/components/slots/page-layout.d.ts

@@ -0,0 +1,12 @@
+import { jsx } from '@emotion/react';
+import { PageLayoutProps } from '../../common/types';
+/**
+ * __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)
+ */
+declare const PageLayout: ({ skipLinksLabel, children, testId, onLeftSidebarExpand, onLeftSidebarCollapse, }: PageLayoutProps) => jsx.JSX.Element;
+export default PageLayout;

package/dist/types-ts4.0/components/slots/right-panel.d.ts

@@ -0,0 +1,12 @@
+import { jsx } from '@emotion/react';
+import { SlotWidthProps } from '../../common/types';
+/**
+ * __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)
+ */
+declare const RightPanel: (props: SlotWidthProps) => jsx.JSX.Element;
+export default RightPanel;

package/dist/types-ts4.0/components/slots/right-sidebar.d.ts

@@ -0,0 +1,12 @@
+import { jsx } from '@emotion/react';
+import { SlotWidthProps } from '../../common/types';
+/**
+ * __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)
+ */
+declare const RightSidebar: (props: SlotWidthProps) => jsx.JSX.Element;
+export default RightSidebar;

package/dist/types-ts4.0/components/slots/slot-dimensions.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+interface SlotDimensionsProps {
+    variableName: string;
+    value?: number;
+}
+declare const _default: ({ variableName, value }: SlotDimensionsProps) => JSX.Element;
+export default _default;

package/dist/types-ts4.0/components/slots/top-navigation.d.ts

@@ -0,0 +1,12 @@
+import { jsx } from '@emotion/react';
+import { SlotHeightProps } from '../../common/types';
+/**
+ * __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)
+ */
+declare const TopNavigation: (props: SlotHeightProps) => jsx.JSX.Element;
+export default TopNavigation;

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

@@ -0,0 +1,6 @@
+export type { SkipLinkData } from './types';
+export { default as publishGridState } from './use-page-layout-grid';
+export { SidebarResizeContext, usePageLayoutResize, useLeftSidebarFlyoutLock, } from './sidebar-resize-context';
+export { SidebarResizeController } from './sidebar-resize-controller';
+export { useSkipLinks, useSkipLink } from './skip-link-context';
+export { SkipLinksController } from './skip-link-controller';

package/dist/types-ts4.0/controllers/sidebar-resize-context.d.ts

@@ -0,0 +1,42 @@
+import { KeyboardEvent, MouseEvent } from 'react';
+export declare type LeftSidebarState = {
+    isFlyoutOpen: boolean;
+    isResizing: boolean;
+    isLeftSidebarCollapsed: boolean;
+    leftSidebarWidth: number;
+    lastLeftSidebarWidth: number;
+    flyoutLockCount: number;
+    isFixed: boolean;
+};
+export declare type SidebarResizeContextValue = {
+    isLeftSidebarCollapsed: boolean;
+    expandLeftSidebar: () => void;
+    collapseLeftSidebar: (event?: MouseEvent | KeyboardEvent, collapseWithoutTransition?: boolean) => void;
+    leftSidebarState: LeftSidebarState;
+    setLeftSidebarState: (value: LeftSidebarState | ((prevState: LeftSidebarState) => LeftSidebarState)) => void;
+};
+export declare const SidebarResizeContext: import("react").Context<SidebarResizeContextValue>;
+export declare const usePageLayoutResize: () => {
+    isLeftSidebarCollapsed: boolean;
+    expandLeftSidebar: () => void;
+    collapseLeftSidebar: (event?: MouseEvent<Element, globalThis.MouseEvent> | KeyboardEvent<Element> | undefined, collapseWithoutTransition?: boolean | undefined) => void;
+    leftSidebarState: LeftSidebarState;
+};
+/**
+ * _**WARNING:**_ This hook is intended as a temporary solution and
+ * is likely to be removed in a future version of page-layout.
+ *
+ * ---
+ *
+ * This hook will prevent the left sidebar from automatically collapsing
+ * when it is in a flyout state.
+ *
+ * The intended use case for this hook is to allow popup menus in the
+ * left sidebar to be usable while it is in a flyout state.
+ *
+ * ## Usage
+ * The intended usage is to use this hook within the popup component
+ * you are rendering. This way the left sidebar will be locked for
+ * as long as the popup is open.
+ */
+export declare const useLeftSidebarFlyoutLock: () => void;

package/dist/types-ts4.0/controllers/sidebar-resize-controller.d.ts

@@ -0,0 +1,3 @@
+import { FC } from 'react';
+import { SidebarResizeControllerProps } from '../common/types';
+export declare const SidebarResizeController: FC<SidebarResizeControllerProps>;

package/dist/types-ts4.0/controllers/skip-link-context.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { SkipLinkContextProps } from './types';
+export declare const SkipLinksContext: import("react").Context<SkipLinkContextProps>;
+export declare const useSkipLinks: () => SkipLinkContextProps;
+export declare const useSkipLink: (id?: string | undefined, skipLinkTitle?: string | undefined) => void;

package/dist/types-ts4.0/controllers/skip-link-controller.d.ts

@@ -0,0 +1,2 @@
+import { FC } from 'react';
+export declare const SkipLinksController: FC;

package/dist/types-ts4.0/controllers/types.d.ts

@@ -0,0 +1,22 @@
+export declare type SkipLinkContextProps = {
+    skipLinksData: SkipLinkData[];
+    registerSkipLink: (skipLinkDate: SkipLinkData) => void;
+    unregisterSkipLink: (id: string | undefined) => void;
+};
+export declare type SkipLinkData = {
+    /**
+     * id for the element that will be skipped to
+     */
+    id: string;
+    /**
+     * Text for the link that will appear in the skip link menu
+     */
+    skipLinkTitle: string;
+    /**
+     * Desired position in the skip link menu
+     */
+    listIndex?: number;
+};
+export declare type SkipLinkI18n = {
+    title: string;
+};

package/dist/types-ts4.0/controllers/use-page-layout-grid.d.ts

@@ -0,0 +1,3 @@
+import { Dimensions } from '../common/types';
+declare const publishGridState: (gridState: Dimensions) => void;
+export default publishGridState;

package/dist/types-ts4.0/controllers/use-update-css-vars.d.ts

@@ -0,0 +1,2 @@
+declare function useUpdateCssVar(cssVar: string, value: number | string): void;
+export default useUpdateCssVar;

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

@@ -0,0 +1,4 @@
+export { PageLayout, Main, Content, RightSidebar, LeftSidebar, LeftSidebarWithoutResize, RightPanel, LeftPanel, Banner, TopNavigation, useCustomSkipLink, } from './components';
+export { LEFT_PANEL_WIDTH, RIGHT_PANEL_WIDTH, BANNER_HEIGHT, TOP_NAVIGATION_HEIGHT, LEFT_SIDEBAR_WIDTH, RIGHT_SIDEBAR_WIDTH, } from './common/constants';
+export { usePageLayoutResize, useLeftSidebarFlyoutLock } from './controllers';
+export type { SlotHeightProps, SlotWidthProps, Dimensions, LeftSidebarState, } from './common/types';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/page-layout",
-  "version": "1.2.8",
+  "version": "1.3.1",
   "description": "A collection of components which let you compose an application's page layout.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,13 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "dist/types-ts4.0/*"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.tsx",
   "atlassian": {
@@ -28,10 +35,10 @@
     "@atlaskit/ds-lib": "^2.1.0",
     "@atlaskit/icon": "^21.10.0",
     "@atlaskit/motion": "^1.2.0",
-    "@atlaskit/theme": "^12.1.0",
+    "@atlaskit/theme": "^12.2.0",
     "@atlaskit/tokens": "^0.10.0",
     "@babel/runtime": "^7.0.0",
-    "@emotion/core": "^10.0.9",
+    "@emotion/react": "^11.7.1",
     "bind-event-listener": "^2.1.1",
     "raf-schd": "^4.0.3"
   },
@@ -44,29 +51,29 @@
     "@atlaskit/atlassian-notifications": "^0.3.0",
     "@atlaskit/button": "^16.3.0",
     "@atlaskit/docs": "*",
-    "@atlaskit/drawer": "^7.1.0",
+    "@atlaskit/drawer": "^7.2.0",
     "@atlaskit/icon": "*",
-    "@atlaskit/logo": "^13.8.0",
+    "@atlaskit/logo": "^13.9.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.0.0",
+    "@atlaskit/section-message": "^6.2.0",
     "@atlaskit/side-navigation": "^1.2.0",
     "@atlaskit/ssr": "*",
     "@atlaskit/tooltip": "*",
     "@atlaskit/visual-regression": "*",
     "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
-    "@testing-library/dom": "^7.7.3",
-    "@testing-library/react": "^8.0.1",
-    "@testing-library/react-hooks": "^1.0.4",
+    "@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": "4.3.5"
+    "typescript": "4.5.5"
   },
   "keywords": [
     "atlaskit",