@atlaskit/page-layout 1.2.4 → 1.2.7

package/report.api.md

@@ -0,0 +1,219 @@
+## API Report File for "@atlaskit/page-layout"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+/// <reference types="react" />
+
+import { ButtonHTMLAttributes } from 'react';
+import { ElementType } from '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;
+
+export declare const BANNER_HEIGHT: string;
+
+export declare const Content: (props: ContentProps) => JSX.Element;
+
+declare 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;
+}
+
+declare type DimensionNames =
+  | 'leftPanelWidth'
+  | 'bannerHeight'
+  | 'topNavigationHeight'
+  | 'leftSidebarWidth'
+  | 'leftSidebarFlyoutWidth'
+  | 'rightSidebarWidth'
+  | 'rightPanelWidth';
+
+export declare type Dimensions = Partial<Record<DimensionNames, number>>;
+
+export declare const LEFT_PANEL_WIDTH: string;
+
+export declare const LEFT_SIDEBAR_WIDTH: string;
+
+export declare const LeftPanel: (props: SlotWidthProps) => JSX.Element;
+
+export declare const LeftSidebar: (props: LeftSidebarProps) => 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). */
+  overrides?: {
+    ResizeButton?: {
+      render?: (
+        Component: ElementType<ResizeButtonProps>,
+        props: ResizeButtonProps,
+      ) => ReactElement;
+    };
+  };
+  /** 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. */
+  resizeButtonLabel?: string;
+  /** Called when left-sidebar is collapsed. */
+  onCollapse?: () => void;
+  /** Called when left-sidebar is expanded. */
+  onExpand?: () => void;
+  /** Called when left-sidebar resize starts using mouse or touch. */
+  onResizeStart?: (leftSidebarState: LeftSidebarState) => void;
+  /** 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. */
+  onFlyoutCollapse?: () => void;
+  /** 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 */
+  collapsedState?: 'collapsed' | 'expanded';
+  /** Controls the width when LeftSidebar mounts, this will override the setting in localStorage */
+  width?: number;
+}
+
+export declare type LeftSidebarState = {
+  isFlyoutOpen: boolean;
+  isResizing: boolean;
+  isLeftSidebarCollapsed: boolean;
+  leftSidebarWidth: number;
+  lastLeftSidebarWidth: number;
+  flyoutLockCount: number;
+  isFixed: boolean;
+};
+
+export declare const LeftSidebarWithoutResize: (
+  props: SlotWidthProps,
+) => JSX.Element;
+
+export declare const Main: (props: SlotWidthProps) => JSX.Element;
+
+export declare const PageLayout: ({
+  skipLinksLabel,
+  children,
+  testId,
+  onLeftSidebarExpand,
+  onLeftSidebarCollapse,
+}: PageLayoutProps) => JSX.Element;
+
+declare interface PageLayoutProps extends SidebarResizeControllerProps {
+  /** 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;
+}
+
+declare type ResizeButtonProps = ButtonHTMLAttributes<HTMLButtonElement> & {
+  isLeftSidebarCollapsed: boolean;
+  label: string;
+  testId?: string;
+};
+
+export declare const RIGHT_PANEL_WIDTH: string;
+
+export declare const RIGHT_SIDEBAR_WIDTH: string;
+
+export declare const RightPanel: (props: SlotWidthProps) => JSX.Element;
+
+export declare const RightSidebar: (props: SlotWidthProps) => JSX.Element;
+
+declare type SidebarResizeControllerProps = {
+  /** Called when left-sidebar expanded. */
+  onLeftSidebarExpand?: (leftSidebarState: LeftSidebarState) => void;
+  /** Called when left-sidebar collapsed. */
+  onLeftSidebarCollapse?: (leftSidebarState: LeftSidebarState) => void;
+};
+
+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 interface SlotHeightProps extends SlotProps {
+  /** It save height in local storage. */
+  shouldPersistHeight?: boolean;
+  /** Height! */
+  height?: number;
+}
+
+declare interface SlotProps {
+  /** 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! */
+  children: ReactNode;
+  id?: string;
+  skipLinkTitle?: string;
+}
+
+export declare interface SlotWidthProps extends SlotProps {
+  /** It save width in local storage. */
+  shouldPersistWidth?: boolean;
+  /** Width! */
+  width?: number;
+}
+
+export declare const TOP_NAVIGATION_HEIGHT: string;
+
+export declare const TopNavigation: (props: SlotHeightProps) => JSX.Element;
+
+export declare const useCustomSkipLink: (
+  id: SkipLinkData['id'],
+  skipLinkTitle: SkipLinkData['skipLinkTitle'],
+  listIndex?: SkipLinkData['listIndex'],
+) => void;
+
+/**
+ * **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;
+
+export declare const usePageLayoutResize: () => {
+  isLeftSidebarCollapsed: boolean;
+  expandLeftSidebar: () => void;
+  collapseLeftSidebar: (
+    event?:
+      | MouseEvent_2<Element, globalThis.MouseEvent>
+      | KeyboardEvent_2<Element>
+      | undefined,
+    collapseWithoutTransition?: boolean | undefined,
+  ) => void;
+  leftSidebarState: LeftSidebarState;
+};
+
+export {};
+```