/** * @jsxRuntime classic * @jsx jsx */ import React from 'react'; import type { StrictXCSSProp } from '@atlaskit/css'; export declare const gridRootId = "unsafe-design-system-page-layout-root"; /** * The root component of the navigation system. It wraps the underlying components with the necessary contexts allowing to use certain data and hooks * @param skipLinksLabel - The very first element of the layout is a skip links container that can be accessed by pressing Tab button and holds the links to the other sections of the layout thus improving accessibility. This parameter defines the header text for this container */ export declare function Root({ children, xcss, UNSAFE_dangerouslyHoistSlotSizes, skipLinksLabel, testId, defaultSideNavCollapsed, isSideNavShortcutEnabled, }: { /** * For rendering the layout areas, e.g. TopNav, SideNav, Main. * They should be rendered as immediate children. */ children: React.ReactNode; /** * Bounded style overrides. */ xcss?: StrictXCSSProp<'backgroundColor', never>; /** * **Note: This prop is only supported for legacy purposes in Jira and Confluence, * and is subject to be removed without notice in the future.** * * Whether to dangerously hoist the layout slot sizes to the document root element, * to support some legacy use cases. Do not use this prop for new code. */ UNSAFE_dangerouslyHoistSlotSizes?: boolean; /** * The header text for the skip links container element. */ skipLinksLabel?: string; /** * A unique string that appears as data attribute `data-testid` in the rendered code, serving as a hook for automated tests. */ testId?: string; /** * Whether the side nav should be collapsed by default __on desktop screens__. * * It is always collapsed by default for mobile screens. * * This value is used when the side nav is first mounted, but you should continuously update your * persisted state using the `onCollapse` and `onExpand` callbacks, to ensure it is up to date * when the app is reloaded. * * __Note:__ When provided, the `defaultCollapsed` props on `SideNav` and `SideNavToggleButton` will be ignored. */ defaultSideNavCollapsed?: boolean; /** * Controls whether the side nav toggle shortcut is enabled. This will be used to bind the keyboard event listener, * and to display the keyboard shortcuts in the appropriate tooltips (`SideNavToggleButton`, `SideNavPanelSplitter`). * * The shortcut key is `Ctrl` + `[`. * * The shortcut is not enabled by default. * * The shortcut will also be ignored if there are any open ADS modal dialogs (`@atlaskit/modal-dialog`). * * `SideNav` has another prop `canToggleWithShortcut()` that can be used to run additional checks after the shortcut * is pressed, before the SideNav is toggled. You can use this to conditionally disable the shortcut based on your * your own custom checks, e.g. if there is a legacy dialog open. * * Note: The built-in keyboard shortcut is behind `useIsFhsEnabled`. */ isSideNavShortcutEnabled?: boolean; }): JSX.Element;