@primer/react 38.30.1-rc.bce2a87c7 → 38.31.0-rc.2630f104b

package/dist/ActionList/index.js

@@ -1,43 +1,43 @@
-import { List } from './List.js';
-import { GroupHeading, Group } from './Group.js';
-import { GroupContext } from './GroupContext.js';
-import { Item } from './Item.js';
-import { LinkItem } from './LinkItem.js';
-import { Divider } from './Divider.js';
-import { Description } from './Description.js';
-import { TrailingAction } from './TrailingAction.js';
-import { TrailingVisual, LeadingVisual } from './Visuals.js';
-import { Heading } from './Heading.js';
-import { ActionListContainerContext } from './ActionListContainerContext.js';
-
+import { ActionListContainerContext } from "./ActionListContainerContext.js";
+import { Heading } from "./Heading.js";
+import { List } from "./List.js";
+import { GroupContext } from "./GroupContext.js";
+import { Group, GroupHeading } from "./Group.js";
+import { Description } from "./Description.js";
+import { LeadingVisual, TrailingVisual } from "./Visuals.js";
+import { TrailingAction } from "./TrailingAction.js";
+import { Item } from "./Item.js";
+import { LinkItem } from "./LinkItem.js";
+import { Divider } from "./Divider.js";
+//#region src/ActionList/index.ts
 /**
- * Collection of list-related components.
- */
+* Collection of list-related components.
+*/
 const ActionList = Object.assign(List, {
-  /** Context for the `ActionList` container. */
-  ContainerContext: ActionListContainerContext,
-  /** Collects related `Items` in an `ActionList`. */
-  Group,
-  /** An actionable or selectable `Item` */
-  Item,
-  /** A `Item` that renders a full-size anchor inside ListItem */
-  LinkItem,
-  /** Visually separates `Item`s or `Group`s in an `ActionList`. */
-  Divider,
-  /** Secondary text which provides additional information about an `Item`. */
-  Description,
-  /** Icon (or similar) positioned before `Item` text. */
-  LeadingVisual,
-  /** Icon (or similar) positioned after `Item` text. */
-  TrailingVisual,
-  /** Heading for an `ActionList`. */
-  Heading,
-  /** Context for `ActionList.Group` to propagate selectionVariant and other group-level props. */
-  GroupContext,
-  /** Heading for `ActionList.Group` */
-  GroupHeading,
-  /** Secondary action */
-  TrailingAction
+	/** Context for the `ActionList` container. */
+	ContainerContext: ActionListContainerContext,
+	/** Collects related `Items` in an `ActionList`. */
+	Group,
+	/** An actionable or selectable `Item` */
+	Item,
+	/** A `Item` that renders a full-size anchor inside ListItem */
+	LinkItem,
+	/** Visually separates `Item`s or `Group`s in an `ActionList`. */
+	Divider,
+	/** Secondary text which provides additional information about an `Item`. */
+	Description,
+	/** Icon (or similar) positioned before `Item` text. */
+	LeadingVisual,
+	/** Icon (or similar) positioned after `Item` text. */
+	TrailingVisual,
+	/** Heading for an `ActionList`. */
+	Heading,
+	/** Context for `ActionList.Group` to propagate selectionVariant and other group-level props. */
+	GroupContext,
+	/** Heading for `ActionList.Group` */
+	GroupHeading,
+	/** Secondary action */
+	TrailingAction
 });
-
+//#endregion
 export { ActionList };

package/dist/ActionList/shared.d.ts

@@ -1,123 +1,101 @@
-import React from 'react';
-import type { AriaRole } from '../utils/types';
-import type { PolymorphicProps } from '../utils/modern-polymorphic';
+import { AriaRole } from "../utils/types/AriaRole.js";
+import { PolymorphicProps } from "../utils/modern-polymorphic.js";
+import React from "react";
+
+//#region src/ActionList/shared.d.ts
 type ExcludeSelectEventHandler<T> = T extends any ? Omit<T, 'onSelect'> : never;
-export type ActionListItemProps<As extends React.ElementType = 'li'> = ExcludeSelectEventHandler<PolymorphicProps<As, 'li'>> & {
-    /**
-     * Primary content for an Item
-     */
-    children?: React.ReactNode;
-    /**
-     * Callback that will trigger both on click selection and keyboard selection.
-     * This is not called for disabled or inactive items.
-     */
-    onSelect?: (event: React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>) => void;
-    /**
-     * Is the `Item` is currently selected?
-     */
-    selected?: boolean;
-    /**
-     * Indicate whether the item is active. There should never be more than one active item.
-     */
-    active?: boolean;
-    /**
-     * Style variations associated with various `Item` types.
-     *
-     * - `"default"` - An action `Item`.
-     * - `"danger"` - A destructive action `Item`.
-     */
-    variant?: 'default' | 'danger';
-    size?: 'medium' | 'large';
-    /**
-     * Items that are disabled can not be clicked, selected, or navigated through.
-     */
-    disabled?: boolean;
-    /**
-     * The ARIA role describing the function of `Item` component. `option` is a common value.
-     */
-    role?: AriaRole;
-    /**
-     * id to attach to the root element of the Item
-     */
-    id?: string;
-    /**
-     * Text describing why the item is inactive. This may be used when an item's usual functionality
-     * is unavailable due to a system error such as a database outage.
-     */
-    inactiveText?: string;
-    /**
-     * Whether the item is loading
-     */
-    loading?: boolean;
-    /**
-     * Private API for use internally only. Used by LinkItem to wrap contents in an anchor
-     */
-    _PrivateItemWrapper?: React.FC<React.PropsWithChildren<MenuItemProps>>;
-    className?: string;
-    groupId?: string;
-    renderItem?: (item: React.FC<React.PropsWithChildren<MenuItemProps>>) => React.ReactNode;
-    handleAddItem?: (item: React.FC<React.PropsWithChildren<MenuItemProps>>) => void;
-    /**
-     * @deprecated `as` prop has no effect on `ActionList.Item`, only `ActionList.LinkItem`
-     */
-    as?: As;
+type ActionListItemProps<As extends React.ElementType = 'li'> = ExcludeSelectEventHandler<PolymorphicProps<As, 'li'>> & {
+  /**
+   * Primary content for an Item
+   */
+  children?: React.ReactNode;
+  /**
+   * Callback that will trigger both on click selection and keyboard selection.
+   * This is not called for disabled or inactive items.
+   */
+  onSelect?: (event: React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>) => void;
+  /**
+   * Is the `Item` is currently selected?
+   */
+  selected?: boolean;
+  /**
+   * Indicate whether the item is active. There should never be more than one active item.
+   */
+  active?: boolean;
+  /**
+   * Style variations associated with various `Item` types.
+   *
+   * - `"default"` - An action `Item`.
+   * - `"danger"` - A destructive action `Item`.
+   */
+  variant?: 'default' | 'danger';
+  size?: 'medium' | 'large';
+  /**
+   * Items that are disabled can not be clicked, selected, or navigated through.
+   */
+  disabled?: boolean;
+  /**
+   * The ARIA role describing the function of `Item` component. `option` is a common value.
+   */
+  role?: AriaRole;
+  /**
+   * id to attach to the root element of the Item
+   */
+  id?: string;
+  /**
+   * Text describing why the item is inactive. This may be used when an item's usual functionality
+   * is unavailable due to a system error such as a database outage.
+   */
+  inactiveText?: string;
+  /**
+   * Whether the item is loading
+   */
+  loading?: boolean;
+  /**
+   * Private API for use internally only. Used by LinkItem to wrap contents in an anchor
+   */
+  _PrivateItemWrapper?: React.FC<React.PropsWithChildren<MenuItemProps>>;
+  className?: string;
+  groupId?: string;
+  renderItem?: (item: React.FC<React.PropsWithChildren<MenuItemProps>>) => React.ReactNode;
+  handleAddItem?: (item: React.FC<React.PropsWithChildren<MenuItemProps>>) => void;
+  /**
+   * @deprecated `as` prop has no effect on `ActionList.Item`, only `ActionList.LinkItem`
+   */
+  as?: As;
 };
 type MenuItemProps = {
-    onClick?: (event: React.MouseEvent<HTMLElement>) => void;
-    onKeyPress?: (event: React.KeyboardEvent<HTMLElement>) => void;
-    'aria-disabled'?: boolean;
-    tabIndex?: number;
-    'aria-labelledby'?: string;
-    'aria-describedby'?: string;
-    role?: string;
-    className?: string;
+  onClick?: (event: React.MouseEvent<HTMLElement>) => void;
+  onKeyPress?: (event: React.KeyboardEvent<HTMLElement>) => void;
+  'aria-disabled'?: boolean;
+  tabIndex?: number;
+  'aria-labelledby'?: string;
+  'aria-describedby'?: string;
+  role?: string;
+  className?: string;
 };
-export type ItemContext = Pick<ActionListItemProps<React.ElementType>, 'variant' | 'disabled' | 'size'> & {
-    inlineDescriptionId?: string;
-    blockDescriptionId?: string;
-    trailingVisualId?: string;
-    inactive?: boolean;
-    setTruncatedText?: (text: string | undefined) => void;
-};
-export declare const ItemContext: React.Context<ItemContext>;
-export declare const getVariantStyles: (variant: ActionListItemProps<React.ElementType>["variant"], disabled: ActionListItemProps<React.ElementType>["disabled"], inactive?: boolean) => {
-    color: string;
-    iconColor: string;
-    annotationColor: string;
-    hoverColor?: undefined;
-} | {
-    color: string;
-    iconColor: string;
-    annotationColor: string;
-    hoverColor: string;
-};
-export declare const TEXT_ROW_HEIGHT = "20px";
-export type ActionListProps<As extends React.ElementType = 'ul'> = PolymorphicProps<As, 'ul', React.PropsWithChildren<{
-    /**
-     * `inset` children are offset (vertically and horizontally) from `List`’s edges, `full` children are flush (vertically and horizontally) with `List` edges
-     */
-    variant?: 'inset' | 'horizontal-inset' | 'full';
-    /**
-     * Whether multiple Items or a single Item can be selected.
-     */
-    selectionVariant?: 'single' | 'radio' | 'multiple';
-    /**
-     * Display a divider above each `Item` in this `List` when it does not follow a `Header` or `Divider`.
-     */
-    showDividers?: boolean;
-    /**
-     * The ARIA role describing the function of `List` component. `listbox` or `menu` are a common values.
-     */
-    role?: AriaRole;
-    /**
-     * Disables the focus zone for the list if applicable. Focus zone is enabled by default for `menu` and `listbox` roles, or components such as `ActionMenu` and `SelectPanel`.
-     */
-    disableFocusZone?: boolean;
-    className?: string;
+type ActionListProps<As extends React.ElementType = 'ul'> = PolymorphicProps<As, 'ul', React.PropsWithChildren<{
+  /**
+   * `inset` children are offset (vertically and horizontally) from `List`’s edges, `full` children are flush (vertically and horizontally) with `List` edges
+   */
+  variant?: 'inset' | 'horizontal-inset' | 'full';
+  /**
+   * Whether multiple Items or a single Item can be selected.
+   */
+  selectionVariant?: 'single' | 'radio' | 'multiple';
+  /**
+   * Display a divider above each `Item` in this `List` when it does not follow a `Header` or `Divider`.
+   */
+  showDividers?: boolean;
+  /**
+   * The ARIA role describing the function of `List` component. `listbox` or `menu` are a common values.
+   */
+  role?: AriaRole;
+  /**
+   * Disables the focus zone for the list if applicable. Focus zone is enabled by default for `menu` and `listbox` roles, or components such as `ActionMenu` and `SelectPanel`.
+   */
+  disableFocusZone?: boolean;
+  className?: string;
 }>>;
-type ContextProps = Pick<ActionListProps<React.ElementType>, 'variant' | 'selectionVariant' | 'showDividers' | 'role'> & {
-    headingId?: string;
-};
-export declare const ListContext: React.Context<ContextProps>;
-export {};
-//# sourceMappingURL=shared.d.ts.map
+//#endregion
+export { ActionListItemProps, ActionListProps };

package/dist/ActionList/shared.js

@@ -1,10 +1,6 @@
-import React from 'react';
-
-// need to explicitly omit `onSelect` from native HTML <li> attributes to avoid collision
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-
-const ItemContext = /*#__PURE__*/React.createContext({});
-
-const ListContext = /*#__PURE__*/React.createContext({});
-
+import React from "react";
+//#region src/ActionList/shared.ts
+const ItemContext = /*#__PURE__*/ React.createContext({});
+const ListContext = /*#__PURE__*/ React.createContext({});
+//#endregion
 export { ItemContext, ListContext };

package/dist/ActionMenu/ActionMenu.d.ts

@@ -1,52 +1,52 @@
-import React from 'react';
-import type { AnchoredOverlayProps } from '../AnchoredOverlay';
-import type { OverlayProps } from '../Overlay';
-import type { ButtonProps } from '../Button';
-import type { AnchorPosition } from '@primer/behaviors';
-import type { ForwardRefComponent as PolymorphicForwardRefComponent } from '../utils/polymorphic';
-import type { FCWithSlotMarker, WithSlotMarker } from '../utils/types/Slots';
-export type MenuCloseHandler = (gesture: 'anchor-click' | 'click-outside' | 'escape' | 'tab' | 'item-select' | 'arrow-left' | 'close') => void;
-export type MenuContextProps = Pick<AnchoredOverlayProps, 'anchorRef' | 'renderAnchor' | 'open' | 'onOpen' | 'anchorId'> & {
-    onClose?: MenuCloseHandler;
-    isSubmenu?: boolean;
-};
-export type ActionMenuProps = {
-    /**
-     * Recommended: `ActionMenu.Button` or `ActionMenu.Anchor` with `ActionMenu.Overlay`
-     */
-    children: React.ReactElement<any>[] | React.ReactElement<any>;
-    /**
-     * If defined, will control the open/closed state of the overlay. Must be used in conjunction with `onOpenChange`.
-     */
-    open?: boolean;
-    /**
-     * If defined, will control the open/closed state of the overlay. Must be used in conjunction with `open`.
-     */
-    onOpenChange?: (s: boolean) => void;
+import { FCWithSlotMarker, SlotMarker, WithSlotMarker } from "../utils/types/Slots.js";
+import { ForwardRefComponent } from "../utils/polymorphic.js";
+import { ButtonProps } from "../Button/types.js";
+import { ActionListDividerProps } from "../ActionList/Divider.js";
+import { AnchoredOverlayProps } from "../AnchoredOverlay/AnchoredOverlay.js";
+import { OverlayProps } from "../Overlay/Overlay.js";
+import React from "react";
+import { AnchorPosition } from "@primer/behaviors";
+
+//#region src/ActionMenu/ActionMenu.d.ts
+type ActionMenuProps = {
+  /**
+   * Recommended: `ActionMenu.Button` or `ActionMenu.Anchor` with `ActionMenu.Overlay`
+   */
+  children: React.ReactElement<any>[] | React.ReactElement<any>;
+  /**
+   * If defined, will control the open/closed state of the overlay. Must be used in conjunction with `onOpenChange`.
+   */
+  open?: boolean;
+  /**
+   * If defined, will control the open/closed state of the overlay. Must be used in conjunction with `open`.
+   */
+  onOpenChange?: (s: boolean) => void;
 } & Pick<AnchoredOverlayProps, 'anchorRef'>;
-export type ActionMenuAnchorProps = {
-    children: React.ReactElement<any>;
-    id?: string;
+type ActionMenuAnchorProps = {
+  children: React.ReactElement<any>;
+  id?: string;
 } & React.HTMLAttributes<HTMLElement>;
 /** this component is syntactical sugar 🍭 */
-export type ActionMenuButtonProps = ButtonProps;
+type ActionMenuButtonProps = ButtonProps;
 type MenuOverlayProps = Partial<OverlayProps> & Pick<AnchoredOverlayProps, 'align' | 'side' | 'variant' | 'displayInViewport'> & {
-    /**
-     * Recommended: `ActionList`
-     */
-    children: React.ReactNode;
-    onPositionChange?: ({ position }: {
-        position: AnchorPosition;
-    }) => void;
+  /**
+   * Recommended: `ActionList`
+   */
+  children: React.ReactNode;
+  onPositionChange?: ({
+    position
+  }: {
+    position: AnchorPosition;
+  }) => void;
 };
-export declare const ActionMenu: React.FC<React.PropsWithChildren<ActionMenuProps>> & import("..").SlotMarker & {
-    Button: PolymorphicForwardRefComponent<"button", ButtonProps>;
-    Anchor: WithSlotMarker<React.ForwardRefExoticComponent<{
-        children: React.ReactElement<any>;
-        id?: string;
-    } & React.HTMLAttributes<HTMLElement> & React.RefAttributes<HTMLElement>>>;
-    Overlay: FCWithSlotMarker<React.PropsWithChildren<MenuOverlayProps>>;
-    Divider: FCWithSlotMarker<React.PropsWithChildren<import("..").ActionListDividerProps>>;
+declare const ActionMenu: React.FC<React.PropsWithChildren<ActionMenuProps>> & SlotMarker & {
+  Button: ForwardRefComponent<"button", ButtonProps>;
+  Anchor: WithSlotMarker<React.ForwardRefExoticComponent<{
+    children: React.ReactElement<any>;
+    id?: string;
+  } & React.HTMLAttributes<HTMLElement> & React.RefAttributes<HTMLElement>>>;
+  Overlay: FCWithSlotMarker<React.PropsWithChildren<MenuOverlayProps>>;
+  Divider: FCWithSlotMarker<React.PropsWithChildren<ActionListDividerProps>>;
 };
-export {};
-//# sourceMappingURL=ActionMenu.d.ts.map
+//#endregion
+export { ActionMenu, ActionMenuAnchorProps, ActionMenuButtonProps, ActionMenuProps };