@atlaskit/drawer 10.1.4 → 11.0.0

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

@@ -1,172 +0,0 @@
-import { type ComponentType, type ReactElement, type ReactNode, type RefObject, type SyntheticEvent } from 'react';
-import { type CSSObject } from '@emotion/react';
-import { type Direction } from '@atlaskit/motion';
-export type Widths = {
-    extended: {
-        width: string;
-    };
-    full: {
-        width: string;
-    };
-    medium: {
-        width: number;
-    };
-    narrow: {
-        width: number;
-    };
-    wide: {
-        width: number;
-    };
-};
-export type DrawerWidth = 'extended' | 'full' | 'medium' | 'narrow' | 'wide';
-export interface BaseProps {
-    /**
-     * 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;
-    /**
-     * The content of the drawer.
-     */
-    children?: ReactNode;
-    /**
-     * Use this to render an icon for the drawer close/back control, if it's available.
-     */
-    icon?: ComponentType<any>;
-    /**
-     * This is the accessible name for the close/back control of the drawer. The default is "Close drawer".
-     */
-    closeLabel?: string;
-    /**
-     * When the content is scrollable, this is the accessible name for the the drawer region. The default is "Scrollable content".
-     */
-    scrollContentLabel?: ContentProps['scrollContentLabel'];
-    /**
-     * Sets the width of the drawer.
-     */
-    width?: DrawerWidth;
-    /**
-     * Sets the direction the draw enters from. The default is "left".
-     */
-    enterFrom?: Direction;
-    /**
-     * A callback function that will be called when the drawer has finished its opening transition.
-     */
-    onOpenComplete?: (node: HTMLElement | null) => void;
-    /**
-     * A callback function that will be called when the drawer has finished its close transition.
-     */
-    onCloseComplete?: (node: HTMLElement | null) => void;
-    /**
-     * Avoid overrides whenever possible. The `overrides` prop allows granular customisation of the drawer. Both the sidebar and content components can be overridden.
-     */
-    overrides?: OverridesType;
-}
-export interface DrawerLabel {
-    /**
-     * This is an `aria-label` attribute. It sets an accessible name for the drawer wrapper, for people who use assistive technology.
-     * Usage of either this, or the `titleId` attribute is strongly recommended.
-     */
-    label?: string;
-    /**
-     * This is an ID referenced by the drawer wrapper's `aria-labelledby` attribute. This ID should be assigned to the drawer `title` element.
-     * Usage of either this, or the `label` attribute is strongly recommended.
-     */
-    titleId?: string;
-}
-export type DefaultsType = {
-    Sidebar: {
-        component: React.ComponentType<SidebarProps>;
-        cssFn: (defaultStyles: CSSObject) => CSSObject;
-    };
-    Content: {
-        component: React.ComponentType<ContentProps>;
-        cssFn: (defaultStyles: CSSObject) => CSSObject;
-    };
-};
-export type OverridesType = {
-    Sidebar?: {
-        component?: React.ComponentType<SidebarProps>;
-        /**
-         * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-2673 for more information.
-         */
-        cssFn?: (defaultStyles: CSSObject) => CSSObject;
-    };
-    Content?: {
-        component?: React.ComponentType<ContentProps>;
-        /**
-         * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-2673 for more information.
-         */
-        cssFn?: (defaultStyles: CSSObject) => CSSObject;
-    };
-};
-export type DrawerPrimitiveDefaults = Pick<DefaultsType, 'Sidebar' | 'Content'>;
-export type DrawerPrimitiveOverrides = Pick<OverridesType, 'Sidebar' | 'Content'>;
-export interface SidebarProps extends React.HTMLProps<HTMLDivElement> {
-    /**
-     * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-2673 for more information.
-     */
-    cssFn: (defaultStyles: CSSObject) => CSSObject;
-}
-export type SidebarCSSProps = Omit<SidebarProps, 'cssFn'>;
-export interface ContentProps extends React.HTMLProps<HTMLDivElement> {
-    /**
-     * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-2673 for more information.
-     */
-    cssFn: (defaultStyles: CSSObject) => CSSObject;
-    /**
-     * When the content is scrollable, this is the accessible name for the the drawer region. The default is "Scrollable content".
-     */
-    scrollContentLabel?: string;
-}
-export type ContentCSSProps = Omit<ContentProps, 'cssFn'>;
-export interface DrawerPrimitiveProps extends BaseProps, FocusLockSettings, DrawerLabel {
-    in: boolean;
-    onClose: (event: SyntheticEvent<HTMLElement>) => void;
-}
-export type DrawerProps = BaseProps & FocusLockSettings & DrawerLabel & {
-    /**
-     * Callback function called while the drawer is displayed and `keydown` event is triggered.
-     */
-    onKeyDown?: (event: SyntheticEvent) => void;
-    /**
-     * Callback function called when the drawer is closed.
-     */
-    onClose?: (event: SyntheticEvent<HTMLElement>, analyticsEvent?: any) => void;
-    /**
-     * Controls if the drawer is open or closed.
-     */
-    isOpen: boolean;
-    /**
-     * Z-index that the popup should be displayed in.
-     * This is passed to the portal component.
-     * Defaults to `unset`.
-     */
-    zIndex?: number | 'unset';
-};
-export interface FocusLockSettings {
-    /**
-     * Controls whether to focus the first tabbable element inside the focus lock. Set to `true` by default.
-     */
-    autoFocusFirstElem?: boolean | (() => HTMLElement | null);
-    /**
-     * Enable this to keep focus inside the component until it’s closed. This is strongly recommended, as it prevents people who use assistive technology from accidentally navigating out of the drawer using the tab key.
-     */
-    isFocusLockEnabled?: boolean;
-    /**
-     * ReturnFocus controls what happens when the user exits focus lock mode.
-     * If true, focus returns to the trigger element . If false, focus remains where it was when the FocusLock was deactivated.
-     * If ref is passed, focus returns to that specific ref element.
-     */
-    shouldReturnFocus?: boolean | RefObject<HTMLElement>;
-}
-export interface FocusLockProps extends FocusLockSettings {
-    /**
-     * Content inside the focus lock.
-     * Must strictly be a ReactElement and it *must* be implemented to take a `ref` passed from `react-scrollock` to enable Touch Scrolling.
-     */
-    children?: ReactElement;
-}
-/**
- * Type of keyboard event that triggers which key will should close the drawer.
- */
-export type CloseTrigger = 'backButton' | 'blanket' | 'escKey';

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

@@ -1,7 +0,0 @@
-type OverridesFunc<X extends Record<string, any>, Y extends Record<string, any>> = (key: string) => Record<string, any>;
-type ExtenderType = <D extends Record<string, any>, O extends Record<string, any>>(d: D, o?: O) => OverridesFunc<D, O>;
-/**
- * @deprecated Please avoid using this function as we intend to remote it in a future release. See DSP-2673 for more information.
- */
-export declare const createExtender: ExtenderType;
-export {};

package/dist/types/entry-points/compiled.d.ts

@@ -1,5 +0,0 @@
-export { Drawer } from '../compiled/drawer';
-export { DrawerContent } from '../compiled/drawer-panel/drawer-content';
-export { DrawerSidebar } from '../compiled/drawer-panel/drawer-sidebar';
-export { DrawerCloseButton } from '../compiled/drawer-panel/drawer-close-button';
-export type { BaseProps, CloseTrigger, DrawerContentProps, DrawerPanelProps, DrawerProps, DrawerWidth, FocusLockProps, DrawerSidebarProps, } from '../compiled/types';

package/dist/types-ts4.5/components/blanket.d.ts

@@ -1,16 +0,0 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-import React from 'react';
-import { jsx } from '@emotion/react';
-type BlanketProps = {
-    isOpen: boolean;
-    onBlanketClicked: (event: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;
-    testId?: string;
-};
-/**
- * A wrapper around `@atlaskit/blanket` that adds a fade in/out transition.
- */
-declare const Blanket: ({ isOpen, onBlanketClicked, testId }: BlanketProps) => jsx.JSX.Element;
-export default Blanket;

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

@@ -1,13 +0,0 @@
-import React from 'react';
-import { type DrawerProps } from './types';
-/**
- * __Drawer__
- *
- * A drawer is a panel that slides in from the left side of the screen.
- *
- * - [Examples](https://atlassian.design/components/drawer/examples)
- * - [Code](https://atlassian.design/components/drawer/code)
- * - [Usage](https://atlassian.design/components/drawer/usage)
- */
-declare const Drawer: ({ width, isOpen, isFocusLockEnabled, shouldReturnFocus, autoFocusFirstElem, onKeyDown, onClose, testId, children, icon, closeLabel, scrollContentLabel, onCloseComplete, onOpenComplete, overrides, zIndex, label, titleId, enterFrom, }: DrawerProps) => React.JSX.Element | null;
-export default Drawer;

package/dist/types-ts4.5/components/primitives/content.d.ts

@@ -1,11 +0,0 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-import { type CSSObject, jsx } from '@emotion/react';
-import { type ContentProps } from '../types';
-declare const contentDefaults: {
-    component: ({ cssFn, scrollContentLabel, ...props }: ContentProps) => jsx.JSX.Element;
-    cssFn: () => CSSObject;
-};
-export default contentDefaults;

package/dist/types-ts4.5/components/primitives/drawer-wrapper.d.ts

@@ -1,29 +0,0 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-import { type ReactElement, type Ref } from 'react';
-import { type DrawerPrimitiveProps, type Widths } from '../types';
-export declare const wrapperWidth: Widths;
-interface FocusLockRefTargetProps extends Pick<DrawerPrimitiveProps, 'width' | 'testId' | 'label' | 'titleId'> {
-    /**
-     * This must have two children explicitly as we target the second child as the Content.
-     */
-    children: [
-        ReactElement,
-        ReactElement
-    ];
-    /**
-     * A ref pointing to our drawer wrapper, passed to `onCloseComplete` and `onOpenComplete` callbacks.
-     */
-    drawerRef: Ref<HTMLDivElement>;
-    /**
-     * The className coming from the SlideIn render callback.
-     */
-    className?: string;
-}
-/**
- * A wrapper that controls the styling of the drawer with a few hacks with refs to get our Touch±Scroll locks working.
- */
-declare const DrawerWrapper: import("react").ForwardRefExoticComponent<FocusLockRefTargetProps & import("react").RefAttributes<HTMLElement>>;
-export default DrawerWrapper;

package/dist/types-ts4.5/components/primitives/focus-lock.d.ts

@@ -1,10 +0,0 @@
-import React from 'react';
-import { type FocusLockProps } from '../types';
-/**
- * __Focus lock__
- *
- * Thin wrapper over react-focus-lock. This wrapper only exists to ensure API compatibility.
- * This component should be deleted during https://ecosystem.atlassian.net/browse/AK-5658
- */
-declare const FocusLock: ({ isFocusLockEnabled, autoFocusFirstElem, shouldReturnFocus, children, }: FocusLockProps) => React.JSX.Element;
-export default FocusLock;

package/dist/types-ts4.5/components/primitives/index.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-import { type DrawerPrimitiveProps } from '../types';
-declare const DrawerPrimitive: ({ children, icon: Icon, closeLabel, scrollContentLabel, onClose, onCloseComplete, onOpenComplete, overrides, testId, in: isOpen, shouldReturnFocus, autoFocusFirstElem, isFocusLockEnabled, width, label, titleId, enterFrom, }: DrawerPrimitiveProps) => React.JSX.Element;
-export default DrawerPrimitive;

package/dist/types-ts4.5/components/primitives/sidebar.d.ts

@@ -1,12 +0,0 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-import { type FC } from 'react';
-import { type CSSObject } from '@emotion/react';
-import { type SidebarProps } from '../types';
-declare const sidebarDefaults: {
-    component: FC<SidebarProps>;
-    cssFn: () => CSSObject;
-};
-export default sidebarDefaults;

package/dist/types-ts4.5/components/types.d.ts

@@ -1,172 +0,0 @@
-import { type ComponentType, type ReactElement, type ReactNode, type RefObject, type SyntheticEvent } from 'react';
-import { type CSSObject } from '@emotion/react';
-import { type Direction } from '@atlaskit/motion';
-export type Widths = {
-    extended: {
-        width: string;
-    };
-    full: {
-        width: string;
-    };
-    medium: {
-        width: number;
-    };
-    narrow: {
-        width: number;
-    };
-    wide: {
-        width: number;
-    };
-};
-export type DrawerWidth = 'extended' | 'full' | 'medium' | 'narrow' | 'wide';
-export interface BaseProps {
-    /**
-     * 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;
-    /**
-     * The content of the drawer.
-     */
-    children?: ReactNode;
-    /**
-     * Use this to render an icon for the drawer close/back control, if it's available.
-     */
-    icon?: ComponentType<any>;
-    /**
-     * This is the accessible name for the close/back control of the drawer. The default is "Close drawer".
-     */
-    closeLabel?: string;
-    /**
-     * When the content is scrollable, this is the accessible name for the the drawer region. The default is "Scrollable content".
-     */
-    scrollContentLabel?: ContentProps['scrollContentLabel'];
-    /**
-     * Sets the width of the drawer.
-     */
-    width?: DrawerWidth;
-    /**
-     * Sets the direction the draw enters from. The default is "left".
-     */
-    enterFrom?: Direction;
-    /**
-     * A callback function that will be called when the drawer has finished its opening transition.
-     */
-    onOpenComplete?: (node: HTMLElement | null) => void;
-    /**
-     * A callback function that will be called when the drawer has finished its close transition.
-     */
-    onCloseComplete?: (node: HTMLElement | null) => void;
-    /**
-     * Avoid overrides whenever possible. The `overrides` prop allows granular customisation of the drawer. Both the sidebar and content components can be overridden.
-     */
-    overrides?: OverridesType;
-}
-export interface DrawerLabel {
-    /**
-     * This is an `aria-label` attribute. It sets an accessible name for the drawer wrapper, for people who use assistive technology.
-     * Usage of either this, or the `titleId` attribute is strongly recommended.
-     */
-    label?: string;
-    /**
-     * This is an ID referenced by the drawer wrapper's `aria-labelledby` attribute. This ID should be assigned to the drawer `title` element.
-     * Usage of either this, or the `label` attribute is strongly recommended.
-     */
-    titleId?: string;
-}
-export type DefaultsType = {
-    Sidebar: {
-        component: React.ComponentType<SidebarProps>;
-        cssFn: (defaultStyles: CSSObject) => CSSObject;
-    };
-    Content: {
-        component: React.ComponentType<ContentProps>;
-        cssFn: (defaultStyles: CSSObject) => CSSObject;
-    };
-};
-export type OverridesType = {
-    Sidebar?: {
-        component?: React.ComponentType<SidebarProps>;
-        /**
-         * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-2673 for more information.
-         */
-        cssFn?: (defaultStyles: CSSObject) => CSSObject;
-    };
-    Content?: {
-        component?: React.ComponentType<ContentProps>;
-        /**
-         * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-2673 for more information.
-         */
-        cssFn?: (defaultStyles: CSSObject) => CSSObject;
-    };
-};
-export type DrawerPrimitiveDefaults = Pick<DefaultsType, 'Sidebar' | 'Content'>;
-export type DrawerPrimitiveOverrides = Pick<OverridesType, 'Sidebar' | 'Content'>;
-export interface SidebarProps extends React.HTMLProps<HTMLDivElement> {
-    /**
-     * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-2673 for more information.
-     */
-    cssFn: (defaultStyles: CSSObject) => CSSObject;
-}
-export type SidebarCSSProps = Omit<SidebarProps, 'cssFn'>;
-export interface ContentProps extends React.HTMLProps<HTMLDivElement> {
-    /**
-     * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-2673 for more information.
-     */
-    cssFn: (defaultStyles: CSSObject) => CSSObject;
-    /**
-     * When the content is scrollable, this is the accessible name for the the drawer region. The default is "Scrollable content".
-     */
-    scrollContentLabel?: string;
-}
-export type ContentCSSProps = Omit<ContentProps, 'cssFn'>;
-export interface DrawerPrimitiveProps extends BaseProps, FocusLockSettings, DrawerLabel {
-    in: boolean;
-    onClose: (event: SyntheticEvent<HTMLElement>) => void;
-}
-export type DrawerProps = BaseProps & FocusLockSettings & DrawerLabel & {
-    /**
-     * Callback function called while the drawer is displayed and `keydown` event is triggered.
-     */
-    onKeyDown?: (event: SyntheticEvent) => void;
-    /**
-     * Callback function called when the drawer is closed.
-     */
-    onClose?: (event: SyntheticEvent<HTMLElement>, analyticsEvent?: any) => void;
-    /**
-     * Controls if the drawer is open or closed.
-     */
-    isOpen: boolean;
-    /**
-     * Z-index that the popup should be displayed in.
-     * This is passed to the portal component.
-     * Defaults to `unset`.
-     */
-    zIndex?: number | 'unset';
-};
-export interface FocusLockSettings {
-    /**
-     * Controls whether to focus the first tabbable element inside the focus lock. Set to `true` by default.
-     */
-    autoFocusFirstElem?: boolean | (() => HTMLElement | null);
-    /**
-     * Enable this to keep focus inside the component until it’s closed. This is strongly recommended, as it prevents people who use assistive technology from accidentally navigating out of the drawer using the tab key.
-     */
-    isFocusLockEnabled?: boolean;
-    /**
-     * ReturnFocus controls what happens when the user exits focus lock mode.
-     * If true, focus returns to the trigger element . If false, focus remains where it was when the FocusLock was deactivated.
-     * If ref is passed, focus returns to that specific ref element.
-     */
-    shouldReturnFocus?: boolean | RefObject<HTMLElement>;
-}
-export interface FocusLockProps extends FocusLockSettings {
-    /**
-     * Content inside the focus lock.
-     * Must strictly be a ReactElement and it *must* be implemented to take a `ref` passed from `react-scrollock` to enable Touch Scrolling.
-     */
-    children?: ReactElement;
-}
-/**
- * Type of keyboard event that triggers which key will should close the drawer.
- */
-export type CloseTrigger = 'backButton' | 'blanket' | 'escKey';

package/dist/types-ts4.5/components/utils.d.ts

@@ -1,7 +0,0 @@
-type OverridesFunc<X extends Record<string, any>, Y extends Record<string, any>> = (key: string) => Record<string, any>;
-type ExtenderType = <D extends Record<string, any>, O extends Record<string, any>>(d: D, o?: O) => OverridesFunc<D, O>;
-/**
- * @deprecated Please avoid using this function as we intend to remote it in a future release. See DSP-2673 for more information.
- */
-export declare const createExtender: ExtenderType;
-export {};

package/dist/types-ts4.5/entry-points/compiled.d.ts

@@ -1,5 +0,0 @@
-export { Drawer } from '../compiled/drawer';
-export { DrawerContent } from '../compiled/drawer-panel/drawer-content';
-export { DrawerSidebar } from '../compiled/drawer-panel/drawer-sidebar';
-export { DrawerCloseButton } from '../compiled/drawer-panel/drawer-close-button';
-export type { BaseProps, CloseTrigger, DrawerContentProps, DrawerPanelProps, DrawerProps, DrawerWidth, FocusLockProps, DrawerSidebarProps, } from '../compiled/types';