@atlaskit/dropdown-menu 11.14.4 → 12.0.0

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

@@ -1,303 +0,0 @@
-import { KeyboardEvent, MouseEvent, ReactElement, ReactNode, Ref } from 'react';
-import type { CustomItemProps, MenuGroupProps, SectionProps } from '@atlaskit/menu/types';
-import type { ContentProps, TriggerProps } from '@atlaskit/popup/types';
-export type FocusableElement = HTMLAnchorElement | HTMLButtonElement;
-export type Action = 'next' | 'prev' | 'first' | 'last';
-export type Placement = 'auto-start' | 'auto' | 'auto-end' | 'top-start' | 'top' | 'top-end' | 'right-start' | 'right' | 'right-end' | 'bottom-end' | 'bottom' | 'bottom-start' | 'left-end' | 'left' | 'left-start';
-export type ItemId = string;
-export type GroupId = string;
-export type CachedItem = {
-    id: ItemId;
-    groupId: GroupId;
-};
-export type FocusItem = {
-    itemId: ItemId;
-    itemNode: HTMLElement;
-};
-export type Behaviors = 'checkbox' | 'radio' | 'menuitemcheckbox' | 'menuitemradio';
-export interface CustomTriggerProps<TriggerElement extends HTMLElement = HTMLElement> extends Omit<TriggerProps, 'ref'> {
-    /**
-     * Ref that should be applied to the trigger. This is used to calculate the menu position.
-     */
-    triggerRef: Ref<TriggerElement>;
-    /**
-     * Makes the trigger appear selected.
-     */
-    isSelected?: boolean;
-    /**
-     * Event that is triggered when the element is clicked.
-     */
-    onClick?: (e: MouseEvent | KeyboardEvent) => void;
-    /**
-     * 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.
-     *
-     * As dropdown-menu is composed of different components, we passed down the testId to the sub component you want to test:
-     * - `testId--trigger` to get the menu trigger.
-     * - `testId--content` to get the dropdown content trigger.
-     */
-    testId?: string;
-}
-export interface OnOpenChangeArgs {
-    isOpen: boolean;
-    event: MouseEvent | KeyboardEvent;
-}
-export interface MenuWrapperProps extends MenuGroupProps {
-    setInitialFocusRef?: ContentProps['setInitialFocusRef'];
-    onClose?: ContentProps['onClose'];
-    onUpdate: ContentProps['update'];
-    isLoading?: DropdownMenuProps['isLoading'];
-    statusLabel?: DropdownMenuProps['statusLabel'];
-}
-export interface DropdownMenuGroupProps extends SectionProps {
-}
-export interface DropdownMenuProps<TriggerElement extends HTMLElement = HTMLElement> {
-    /**
-     * Controls the appearance of the menu.
-     * Default menu has scroll after its height exceeds the pre-defined amount.
-     * Tall menu has no scroll until the height exceeds the height of the viewport.
-     */
-    appearance?: 'default' | 'tall';
-    /**
-     * Controls if the first menu item receives focus when menu is opened. Note that the menu has a focus lock
-     * which traps the focus within the menu. Also, the first item gets fouced automatically
-     * if the menu is triggered using the keyboard.
-     *
-     */
-    autoFocus?: boolean;
-    /**
-     * Content that will be rendered inside the layer element. Should typically be
-     * `DropdownItemGroup` or `DropdownItem`, or checkbox / radio variants of those.
-     */
-    children?: ReactNode;
-    /**
-     * If true, a Spinner is rendered instead of the items
-     */
-    isLoading?: boolean;
-    /**
-     * Text to be used as status for assistive technologies. Defaults to "Loading".
-     */
-    statusLabel?: string;
-    /**
-     * Controls the open state of the dropdown.
-     */
-    isOpen?: boolean;
-    /**
-     * Position of the menu.
-     */
-    placement?: Placement;
-    /**
-     * Allows the dropdown menu to be placed on the opposite side of its trigger if it does not
-     * fit in the viewport.
-     */
-    shouldFlip?: boolean;
-    /**
-     * The root element where the DropdownMenu content should be rendered.
-     * `true` - rendering in the DOM node closest to the trigger. `false` - rendering in React.Portal.
-     * Defaults to `false`.
-     */
-    shouldRenderToParent?: boolean;
-    /**
-     * Controls the spacing density of the menu.
-     */
-    spacing?: Extract<MenuGroupProps['spacing'], 'cozy' | 'compact'>;
-    /**
-     * Content which will trigger the dropdown menu to open and close. Use with `triggerType`
-     * to easily get a button trigger.
-     */
-    trigger?: string | ((triggerButtonProps: CustomTriggerProps<TriggerElement>) => ReactElement);
-    /**
-     * 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.
-     *
-     * As dropdown-menu is composed of different components, we passed down the testId to the sub component you want to test:
-     * - `testId--trigger` to get the menu trigger.
-     * - `testId--content` to get the dropdown content trigger.
-     */
-    testId?: string;
-    /**
-     * Controls the initial open state of the dropdown. If provided, the component is considered to be controlled
-     * which means that the user is responsible for managing the open and close state of the menu.
-     */
-    defaultOpen?: boolean;
-    /**
-     * Called when the menu should be open/closed. Receives an object with `isOpen` state.
-     */
-    onOpenChange?: (args: OnOpenChangeArgs) => void;
-    /**
-     * Z-index that the popup should be displayed in.
-     * This is passed to the portal component.
-     * Defaults to `layers.modal()` from `@atlaskit/theme` which is 510.
-     */
-    zIndex?: number;
-}
-export interface DropdownItemProps {
-    /**
-     * Primary content for the item.
-     */
-    children: React.ReactNode;
-    /**
-     * Custom component to render as an item.
-     * Should be wrapped in `forwardRef` to avoid accessibility issues when controlling keyboard focus.
-     */
-    component?: CustomItemProps['component'];
-    /**
-     * Description of the item.
-     * This will render smaller text below the primary text of the item as well as slightly increasing the height of the item.
-     */
-    description?: string | JSX.Element;
-    /**
-     * Makes the element appear disabled as well as removing interactivity.
-     */
-    isDisabled?: boolean;
-    /**
-     * When `true` the title of the item will wrap multiple lines if it's long enough.
-     */
-    shouldTitleWrap?: boolean;
-    /**
-     * When `true` the description of the item will wrap multiple lines if it's long enough.
-     */
-    shouldDescriptionWrap?: boolean;
-    /**
-     * Event that is triggered when the element is clicked.
-     */
-    onClick?: (e: MouseEvent | KeyboardEvent) => void;
-    /**
-     * Makes the element appear selected.
-     */
-    isSelected?: boolean;
-    /**
-     * Link to another page.
-     */
-    href?: string;
-    /**
-     * Where to display the linked URL,
-     * see [anchor information](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) on mdn for more information.
-     */
-    target?: string;
-    /**
-     * Adds a title attribute to the root item element.
-     */
-    title?: string;
-    /**
-     * Element to render before the item text.
-     * Generally should be an [icon](https://atlaskit.atlassian.com/packages/design-system/icon) component.
-     */
-    elemBefore?: React.ReactNode;
-    /**
-     * Element to render after the item text.
-     * Generally should be an [icon](https://atlaskit.atlassian.com/packages/design-system/icon) component.
-     */
-    elemAfter?: React.ReactNode;
-    /**
-     * The relationship of the linked URL as space-separated link types.
-     * Generally you'll want to set this to "noopener noreferrer" when `target` is "_blank".
-     */
-    rel?: 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;
-}
-export interface DropdownItemCheckboxProps {
-    /**
-     * Primary content for the item.
-     */
-    children: React.ReactNode;
-    /**
-     * Description of the item.
-     * This will render smaller text below the primary text of the item as well as slightly increasing the height of the item.
-     */
-    description?: string | JSX.Element;
-    /**
-     * Makes the checkbox appear disabled as well as removing interactivity.
-     */
-    isDisabled?: boolean;
-    /**
-     * When `true` the title of the item will wrap multiple lines if it's long enough.
-     */
-    shouldTitleWrap?: boolean;
-    /**
-     * When `true` the description of the item will wrap multiple lines if it's long enough.
-     */
-    shouldDescriptionWrap?: boolean;
-    /**
-     * Event that is triggered when the checkbox is clicked.
-     */
-    onClick?: (e: MouseEvent | KeyboardEvent) => void;
-    /**
-     * Sets whether the checkbox is checked or unchecked.
-     */
-    isSelected?: boolean;
-    /**
-     * Sets whether the checkbox begins selected.
-     */
-    defaultSelected?: boolean;
-    /**
-     * Unique id of a checkbox
-     */
-    id: string;
-    /**
-     * Adds a title attribute to the root item element.
-     */
-    title?: 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;
-}
-export interface DropdownItemRadioProps {
-    /**
-     * Primary content for the item.
-     */
-    children: React.ReactNode;
-    /**
-     * Description of the item.
-     * This will render smaller text below the primary text of the item as well as slightly increasing the height of the item.
-     */
-    description?: string | JSX.Element;
-    /**
-     * Makes the checkbox appear disabled as well as removing interactivity.
-     */
-    isDisabled?: boolean;
-    /**
-     * When `true` the title of the item will wrap multiple lines if it's long enough.
-     */
-    shouldTitleWrap?: boolean;
-    /**
-     * When `true` the description of the item will wrap multiple lines if it's long enough.
-     */
-    shouldDescriptionWrap?: boolean;
-    /**
-     * Event that is triggered when the checkbox is clicked.
-     */
-    onClick?: (e: MouseEvent | KeyboardEvent) => void;
-    /**
-     * Sets whether the checkbox is checked or unchecked.
-     */
-    isSelected?: boolean;
-    /**
-     * Sets whether the checkbox begins selected.
-     */
-    defaultSelected?: boolean;
-    /**
-     * Unique id of a checkbox
-     */
-    id: string;
-    /**
-     * Adds a title attribute to the root item element.
-     */
-    title?: 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;
-}

package/tmp/api-report-tmp.d.ts

@@ -1,147 +0,0 @@
-## API Report File for "@atlaskit/dropdown-menu"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-/// <reference types="react" />
-
-import type { CustomItemProps } from '@atlaskit/menu/types';
-import { default as DropdownItemGroup } from '@atlaskit/menu/section';
-import { KeyboardEvent as KeyboardEvent_2 } from 'react';
-import type { MenuGroupProps } from '@atlaskit/menu/types';
-import { MouseEvent as MouseEvent_2 } from 'react';
-import { default as React_2 } from 'react';
-import { ReactElement } from 'react';
-import { ReactNode } from 'react';
-import { Ref } from 'react';
-import type { SectionProps } from '@atlaskit/menu';
-import type { SectionProps as SectionProps_2 } from '@atlaskit/menu/types';
-import type { TriggerProps } from '@atlaskit/popup/types';
-
-// @public (undocumented)
-export interface CustomTriggerProps<TriggerElement extends HTMLElement = HTMLElement> extends Omit<TriggerProps, 'ref'> {
-    isSelected?: boolean;
-    onClick?: (e: KeyboardEvent_2 | MouseEvent_2) => void;
-    testId?: string;
-    triggerRef: Ref<TriggerElement>;
-}
-
-// @public
-export const DropdownItem: React_2.ForwardRefExoticComponent<DropdownItemProps & React_2.RefAttributes<HTMLElement>>;
-
-// @public
-export const DropdownItemCheckbox: (props: DropdownItemCheckboxProps) => JSX.Element;
-
-// @public
-export const DropdownItemCheckboxGroup: (props: DropdownItemCheckboxGroupProps) => JSX.Element;
-
-// @public (undocumented)
-interface DropdownItemCheckboxGroupProps extends SectionProps {
-    id: string;
-}
-
-// @public (undocumented)
-interface DropdownItemCheckboxProps {
-    children: React.ReactNode;
-    defaultSelected?: boolean;
-    description?: JSX.Element | string;
-    id: string;
-    isDisabled?: boolean;
-    isSelected?: boolean;
-    onClick?: (e: KeyboardEvent_2 | MouseEvent_2) => void;
-    shouldDescriptionWrap?: boolean;
-    shouldTitleWrap?: boolean;
-    testId?: string;
-    title?: string;
-}
-
-export { DropdownItemGroup }
-
-// @public (undocumented)
-export interface DropdownItemProps {
-    children: React.ReactNode;
-    component?: CustomItemProps['component'];
-    description?: JSX.Element | string;
-    elemAfter?: React.ReactNode;
-    elemBefore?: React.ReactNode;
-    href?: string;
-    isDisabled?: boolean;
-    isSelected?: boolean;
-    onClick?: (e: KeyboardEvent_2 | MouseEvent_2) => void;
-    rel?: string;
-    shouldDescriptionWrap?: boolean;
-    shouldTitleWrap?: boolean;
-    target?: string;
-    testId?: string;
-    title?: string;
-}
-
-// @public
-export const DropdownItemRadio: (props: DropdownItemRadioProps) => JSX.Element;
-
-// @public
-export const DropdownItemRadioGroup: (props: DropdownItemRadioGroupProps) => JSX.Element;
-
-// @public (undocumented)
-interface DropdownItemRadioGroupProps extends SectionProps {
-    // (undocumented)
-    id: string;
-}
-
-// @public (undocumented)
-interface DropdownItemRadioProps {
-    children: React.ReactNode;
-    defaultSelected?: boolean;
-    description?: JSX.Element | string;
-    id: string;
-    isDisabled?: boolean;
-    isSelected?: boolean;
-    onClick?: (e: KeyboardEvent_2 | MouseEvent_2) => void;
-    shouldDescriptionWrap?: boolean;
-    shouldTitleWrap?: boolean;
-    testId?: string;
-    title?: string;
-}
-
-// @public
-const DropdownMenu: <T extends HTMLElement = HTMLElement>(props: DropdownMenuProps<T>) => JSX.Element;
-export default DropdownMenu;
-
-// @public (undocumented)
-export interface DropdownMenuGroupProps extends SectionProps_2 {
-}
-
-// @public (undocumented)
-export interface DropdownMenuProps<TriggerElement extends HTMLElement = HTMLElement> {
-    appearance?: 'default' | 'tall';
-    autoFocus?: boolean;
-    children?: ReactNode;
-    defaultOpen?: boolean;
-    isLoading?: boolean;
-    isOpen?: boolean;
-    onOpenChange?: (args: OnOpenChangeArgs) => void;
-    placement?: Placement;
-    shouldFlip?: boolean;
-    shouldRenderToParent?: boolean;
-    spacing?: Extract<MenuGroupProps['spacing'], 'compact' | 'cozy'>;
-    statusLabel?: string;
-    testId?: string;
-    trigger?: ((triggerButtonProps: CustomTriggerProps<TriggerElement>) => ReactElement) | string;
-    zIndex?: number;
-}
-
-// @public (undocumented)
-export interface OnOpenChangeArgs {
-    // (undocumented)
-    event: KeyboardEvent_2 | MouseEvent_2;
-    // (undocumented)
-    isOpen: boolean;
-}
-
-// @public (undocumented)
-type Placement = 'auto' | 'auto-end' | 'auto-start' | 'bottom' | 'bottom-end' | 'bottom-start' | 'left' | 'left-end' | 'left-start' | 'right' | 'right-end' | 'right-start' | 'top' | 'top-end' | 'top-start';
-
-// (No @packageDocumentation comment for this package)
-
-```