@servicetitan/anvil2 3.14.1 → 3.15.0

package/dist/src/components/Details/Details.d.ts

@@ -1,58 +1,30 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { LayoutUtilProps } from '../../types';
-/**
- * Props for the Details component
- * @extends ComponentPropsWithoutRef<"div">
- * @extends LayoutUtilProps
- */
 export type DetailsProps = ComponentPropsWithoutRef<"div"> & LayoutUtilProps & {
     /**
-     * Determines the controlled expanded state of the details.
-     * @remarks Use this to make the details expanded state controlled.
-     * @default false
+     * Controls whether the content is expanded. When set, internal toggles do
+     * not change the rendered state.
      */
     expanded?: boolean;
-    /**
-     * Determines the default expanded state of the details.
-     * @remarks Use this to make the details expanded state uncontrolled.
-     * @default false
-     */
+    /** Initial state when `expanded` is omitted. Defaults to `false`. */
     defaultExpanded?: boolean;
 };
 /**
- * Details component for creating expandable/collapsible content sections.
- *
- * Features:
- * - Expandable and collapsible content sections
- * - Controlled and uncontrolled state management
- * - Accessible with proper ARIA attributes
- * - Smooth animations for expand/collapse
- * - Keyboard navigation support
- * - Layout utility props for positioning and spacing
- * - Compound component pattern with Summary, Content, and Arrow sub-components
- * - Automatic tracking ID generation for analytics
- *
- * @example
- * <Details defaultExpanded>
- *   <Details.Summary>Click to expand</Details.Summary>
- *   <Details.Content>This content is now visible</Details.Content>
- * </Details>
+ * Disclosure container that coordinates its Summary and Content. Supports
+ * controlled or uncontrolled expanded state.
  */
 export declare const Details: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & LayoutUtilProps & {
     /**
-     * Determines the controlled expanded state of the details.
-     * @remarks Use this to make the details expanded state controlled.
-     * @default false
+     * Controls whether the content is expanded. When set, internal toggles do
+     * not change the rendered state.
      */
     expanded?: boolean;
-    /**
-     * Determines the default expanded state of the details.
-     * @remarks Use this to make the details expanded state uncontrolled.
-     * @default false
-     */
+    /** Initial state when `expanded` is omitted. Defaults to `false`. */
     defaultExpanded?: boolean;
 } & import('react').RefAttributes<HTMLDivElement>> & {
+    /** Button that toggles the disclosure content. */
     Summary: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & import('../..').DataTrackingId & import('react').RefAttributes<HTMLButtonElement>>;
+    /** Expandable content associated with the summary. */
     Content: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
         height?: string | number;
         maxHeight?: string | number;

package/dist/src/components/Details/DetailsContent.d.ts

@@ -1,41 +1,17 @@
 import { ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the DetailsContent component
- * @extends ComponentPropsWithoutRef<"div">
- */
 export type DetailsContentProps = ComponentPropsWithoutRef<"div"> & {
-    /**
-     * Fixed height for the content area
-     */
+    /** Fixes the inner content height and makes it scrollable when needed. */
     height?: string | number;
-    /**
-     * Maximum height for the content area
-     */
+    /** Constrains the inner content height and makes it scrollable when needed. */
     maxHeight?: string | number;
 };
 /**
- * DetailsContent component for the expandable content area of a Details section.
- *
- * Features:
- * - Expandable and collapsible content area
- * - Smooth animations for height transitions
- * - Configurable height and maxHeight constraints
- * - Automatic overflow handling when height is constrained
- * - Proper ARIA associations with the summary
- * - Responsive design with flexible layout
- *
- * @example
- * <Details.Content maxHeight={300}>
- *   <p>This content will be constrained to 300px max height</p>
- * </Details.Content>
+ * Disclosure panel associated with Details.Summary. It remains mounted while
+ * its visibility follows the parent Details state.
  */
 export declare const DetailsContent: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
-    /**
-     * Fixed height for the content area
-     */
+    /** Fixes the inner content height and makes it scrollable when needed. */
     height?: string | number;
-    /**
-     * Maximum height for the content area
-     */
+    /** Constrains the inner content height and makes it scrollable when needed. */
     maxHeight?: string | number;
 } & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/Details/DetailsSummary.d.ts

@@ -1,24 +1,8 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { DataTrackingId } from '../../types';
-/**
- * Props for the DetailsSummary component
- * @extends ComponentPropsWithoutRef<"button">
- */
 export type DetailsSummaryProps = ComponentPropsWithoutRef<"button"> & DataTrackingId;
 /**
- * DetailsSummary component for the clickable header of a Details section.
- *
- * Features:
- * - Clickable button that toggles the Details expanded state
- * - Automatic ARIA attributes for accessibility
- * - Includes animated arrow indicator
- * - Supports custom onClick handlers
- * - Keyboard navigation support (Enter, Space)
- * - Styled with consistent typography and spacing
- *
- * @example
- * <Details.Summary onClick={() => console.log('Summary clicked')}>
- *   Click to expand content
- * </Details.Summary>
+ * Disclosure button for Details.Content. A supplied `onClick` runs before the
+ * internal expanded state toggles.
  */
 export declare const DetailsSummary: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & DataTrackingId & import('react').RefAttributes<HTMLButtonElement>>;

package/dist/src/components/Details/internal/DetailsArrow.d.ts

@@ -1,20 +1,4 @@
 import { ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the DetailsArrow component
- * @extends ComponentPropsWithoutRef<"span">
- */
 export type DetailsArrowProps = ComponentPropsWithoutRef<"span">;
-/**
- * DetailsArrow component for the animated arrow indicator in DetailsSummary.
- *
- * Features:
- * - Animated chevron icon that rotates on expand/collapse
- * - Automatically reflects the current expanded state
- * - Uses consistent icon sizing and styling
- * - Smooth transition animations
- * - Accessible with proper ARIA context
- *
- * @example
- * <DetailsArrow className="custom-arrow" />
- */
+/** Rotating indicator that reflects the parent Details state. */
 export declare const DetailsArrow: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "ref"> & import('react').RefAttributes<HTMLSpanElement>>;

package/dist/src/components/Dialog/Dialog.d.ts

@@ -3,283 +3,106 @@ import { OpenCloseTransitionStateEffects } from '../../internal/hooks';
 import { FocusableElement, DisableCloseOnEscapeOrClickProps, Size } from '../../types';
 import { DrillDownContextProps } from '../DrillDown/internal/DrillDownContext';
 /**
- * Props for the Dialog component
  * @extends ComponentPropsWithoutRef<"dialog">
- * @extends DialogTransitionStateEffects
+ * @extends OpenCloseTransitionStateEffects
  * @extends DisableCloseOnEscapeOrClickProps
  */
 export type DialogProps = ComponentPropsWithoutRef<"dialog"> & OpenCloseTransitionStateEffects & DisableCloseOnEscapeOrClickProps & {
-    /**
-     * @default false
-     */
+    /** Expands the dialog to the viewport instead of using `size`. Defaults to `false`. */
     fullScreen?: boolean;
-    /**
-     * @default "medium"
-     */
+    /** Width preset used outside full-screen mode. Defaults to `medium`. */
     size?: Extract<Size, "medium" | "large" | "xlarge">;
-    /**
-     * @default false
-     */
+    /** Controls whether the dialog is shown. Defaults to `false`. */
     open?: boolean;
+    /** Called by Escape, outside-click, and `Dialog.CancelButton` close actions. */
     onClose?: () => void;
-    /**
-     * Callback when clicking outside the dialog
-     */
+    /** Called on an outside click even when that click is not allowed to close the dialog. */
     onClickOutside?: (e: globalThis.MouseEvent) => void;
-    /**
-     * Enables scroll chaining
-     * @link https://developer.mozilla.org/en-US/docs/Glossary/Scroll_chaining
-     */
+    /** Allows scrolling to continue into the page instead of locking the shadow host. */
     enableScrollChaining?: boolean;
     /**
-     * Given an array of focusable elements, return the initial focus target.
-     * @param focusables - The focusable elements to pick from
-     * @returns The initial focus target
+     * Chooses initial focus from the dialog's tabbable elements. By default,
+     * cancel buttons are skipped when another target is available.
      */
     initialFocusResolver?: (focusables: FocusableElement[]) => FocusableElement;
-    /**
-     * Sets the default DrillDown index when used in an uncontrolled way
-     */
+    /** DrillDown panel opened when navigation begins. Defaults to index `0`. */
     defaultDrillDownIndex?: DrillDownContextProps["index"];
-    /**
-     * Callback to pass context to useDrillDown hook
-     */
+    /** Receives the current DrillDown controls and whether the dialog is interactive. */
     onDrillDownContextChange?: (context: DrillDownContextProps) => void;
 };
 /**
- * Dialog component for creating modal dialogs and overlays.
- *
- * Features:
- * - Modal dialog with backdrop overlay
- * - Controlled and uncontrolled open state
- * - Smooth open/close animations
- * - Keyboard navigation and focus management
- * - Escape key and click outside to close
- * - Multiple size variants (medium, large, fullscreen)
- * - Scroll chaining support
- * - Toast integration for notifications
- * - Compound component pattern with Header, Footer, Content, and CancelButton sub-components
- * - Automatic tracking ID generation for analytics
- *
- * @example
- * <Dialog open={isOpen} onClose={() => setIsOpen(false)}>
- *   <Dialog.Header>Confirm Action</Dialog.Header>
- *   <Dialog.Content>Are you sure you want to proceed?</Dialog.Content>
- *   <Dialog.Footer>
- *     <Dialog.CancelButton>Cancel</Dialog.CancelButton>
- *     <Button appearance="primary">Confirm</Button>
- *   </Dialog.Footer>
- * </Dialog>
+ * Controlled modal dialog with focus trapping, animated transitions, and
+ * compound header, content, footer, and cancel-button regions.
  */
 export declare const Dialog: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').DialogHTMLAttributes<HTMLDialogElement>, HTMLDialogElement>, "ref"> & OpenCloseTransitionStateEffects & DisableCloseOnEscapeOrClickProps & {
-    /**
-     * @default false
-     */
+    /** Expands the dialog to the viewport instead of using `size`. Defaults to `false`. */
     fullScreen?: boolean;
-    /**
-     * @default "medium"
-     */
+    /** Width preset used outside full-screen mode. Defaults to `medium`. */
     size?: Extract<Size, "medium" | "large" | "xlarge">;
-    /**
-     * @default false
-     */
+    /** Controls whether the dialog is shown. Defaults to `false`. */
     open?: boolean;
+    /** Called by Escape, outside-click, and `Dialog.CancelButton` close actions. */
     onClose?: () => void;
-    /**
-     * Callback when clicking outside the dialog
-     */
+    /** Called on an outside click even when that click is not allowed to close the dialog. */
     onClickOutside?: (e: globalThis.MouseEvent) => void;
-    /**
-     * Enables scroll chaining
-     * @link https://developer.mozilla.org/en-US/docs/Glossary/Scroll_chaining
-     */
+    /** Allows scrolling to continue into the page instead of locking the shadow host. */
     enableScrollChaining?: boolean;
     /**
-     * Given an array of focusable elements, return the initial focus target.
-     * @param focusables - The focusable elements to pick from
-     * @returns The initial focus target
+     * Chooses initial focus from the dialog's tabbable elements. By default,
+     * cancel buttons are skipped when another target is available.
      */
     initialFocusResolver?: (focusables: FocusableElement[]) => FocusableElement;
-    /**
-     * Sets the default DrillDown index when used in an uncontrolled way
-     */
+    /** DrillDown panel opened when navigation begins. Defaults to index `0`. */
     defaultDrillDownIndex?: DrillDownContextProps["index"];
-    /**
-     * Callback to pass context to useDrillDown hook
-     */
+    /** Receives the current DrillDown controls and whether the dialog is interactive. */
     onDrillDownContextChange?: (context: DrillDownContextProps) => void;
 } & import('react').RefAttributes<HTMLDialogElement>> & {
-    /**
-     * DialogHeader component for the header section of a Dialog.
-     *
-     * Features:
-     * - Displays dialog title with headline typography
-     * - Includes close button with proper accessibility
-     * - Sticky positioning for long content
-     * - Consistent spacing and styling
-     * - Automatic focus management
-     * - Automatic tracking ID generation for analytics
-     *
-     * @example
-     * <Dialog.Header>Confirm Delete</Dialog.Header>
-     */
+    /** Renders the dialog title and close control. */
     Header: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & import('../..').DataTrackingId & import('react').RefAttributes<HTMLDivElement>>;
-    /**
-     * DialogFooter component for the footer section of a Dialog.
-     *
-     * Features:
-     * - Container for dialog action buttons
-     * - Optional sticky positioning for long content
-     * - Consistent spacing and alignment
-     * - Right-aligned button layout by default
-     * - Flexible content area for custom layouts
-     *
-     * @example
-     * <Dialog.Footer sticky>
-     *   <Dialog.CancelButton>Cancel</Dialog.CancelButton>
-     *   <Button appearance="primary">Save</Button>
-     * </Dialog.Footer>
-     */
+    /** Groups actions at the end of the dialog. */
     Footer: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & {
         sticky?: boolean;
     } & import('react').RefAttributes<HTMLElement>>;
-    /**
-     * DialogContent component for the main content area of a Dialog.
-     *
-     * Features:
-     * - Main content container for dialog body
-     * - Flexible height with overflow handling
-     * - Consistent padding and spacing
-     * - Responsive design
-     * - Proper content scrolling for long content
-     *
-     * @example
-     * <Dialog.Content>
-     *   <p>This is the main content of the dialog.</p>
-     * </Dialog.Content>
-     */
+    /** Renders the dialog's main content region. */
     Content: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
         sticky?: boolean;
     } & import('react').RefAttributes<HTMLDivElement>>;
-    /**
-     * DialogCancelButton component for cancel/close actions in a Dialog.
-     *
-     * Features:
-     * - Button that automatically closes the dialog when clicked
-     * - Extends all Button component props and functionality
-     * - Proper accessibility with close dialog semantics
-     * - Automatic focus management
-     * - Consistent styling with other dialog elements
-     * - Automatic tracking ID generation for analytics
-     *
-     * @example
-     * <Dialog.CancelButton appearance="ghost">Cancel</Dialog.CancelButton>
-     */
+    /** Closes the dialog after running its own click handler. */
     CancelButton: import('react').ForwardRefExoticComponent<import('./DialogCancelButton').DialogCancelButtonProps & import('react').RefAttributes<HTMLButtonElement>>;
 };
 export declare const DialogElement: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').DialogHTMLAttributes<HTMLDialogElement>, HTMLDialogElement>, "ref"> & OpenCloseTransitionStateEffects & DisableCloseOnEscapeOrClickProps & {
-    /**
-     * @default false
-     */
+    /** Expands the dialog to the viewport instead of using `size`. Defaults to `false`. */
     fullScreen?: boolean;
-    /**
-     * @default "medium"
-     */
+    /** Width preset used outside full-screen mode. Defaults to `medium`. */
     size?: Extract<Size, "medium" | "large" | "xlarge">;
-    /**
-     * @default false
-     */
+    /** Controls whether the dialog is shown. Defaults to `false`. */
     open?: boolean;
+    /** Called by Escape, outside-click, and `Dialog.CancelButton` close actions. */
     onClose?: () => void;
-    /**
-     * Callback when clicking outside the dialog
-     */
+    /** Called on an outside click even when that click is not allowed to close the dialog. */
     onClickOutside?: (e: globalThis.MouseEvent) => void;
-    /**
-     * Enables scroll chaining
-     * @link https://developer.mozilla.org/en-US/docs/Glossary/Scroll_chaining
-     */
+    /** Allows scrolling to continue into the page instead of locking the shadow host. */
     enableScrollChaining?: boolean;
     /**
-     * Given an array of focusable elements, return the initial focus target.
-     * @param focusables - The focusable elements to pick from
-     * @returns The initial focus target
+     * Chooses initial focus from the dialog's tabbable elements. By default,
+     * cancel buttons are skipped when another target is available.
      */
     initialFocusResolver?: (focusables: FocusableElement[]) => FocusableElement;
-    /**
-     * Sets the default DrillDown index when used in an uncontrolled way
-     */
+    /** DrillDown panel opened when navigation begins. Defaults to index `0`. */
     defaultDrillDownIndex?: DrillDownContextProps["index"];
-    /**
-     * Callback to pass context to useDrillDown hook
-     */
+    /** Receives the current DrillDown controls and whether the dialog is interactive. */
     onDrillDownContextChange?: (context: DrillDownContextProps) => void;
 } & import('react').RefAttributes<HTMLDialogElement>> & {
-    /**
-     * DialogHeader component for the header section of a Dialog.
-     *
-     * Features:
-     * - Displays dialog title with headline typography
-     * - Includes close button with proper accessibility
-     * - Sticky positioning for long content
-     * - Consistent spacing and styling
-     * - Automatic focus management
-     * - Automatic tracking ID generation for analytics
-     *
-     * @example
-     * <Dialog.Header>Confirm Delete</Dialog.Header>
-     */
+    /** Renders the dialog title and close control. */
     Header: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & import('../..').DataTrackingId & import('react').RefAttributes<HTMLDivElement>>;
-    /**
-     * DialogFooter component for the footer section of a Dialog.
-     *
-     * Features:
-     * - Container for dialog action buttons
-     * - Optional sticky positioning for long content
-     * - Consistent spacing and alignment
-     * - Right-aligned button layout by default
-     * - Flexible content area for custom layouts
-     *
-     * @example
-     * <Dialog.Footer sticky>
-     *   <Dialog.CancelButton>Cancel</Dialog.CancelButton>
-     *   <Button appearance="primary">Save</Button>
-     * </Dialog.Footer>
-     */
+    /** Groups actions at the end of the dialog. */
     Footer: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & {
         sticky?: boolean;
     } & import('react').RefAttributes<HTMLElement>>;
-    /**
-     * DialogContent component for the main content area of a Dialog.
-     *
-     * Features:
-     * - Main content container for dialog body
-     * - Flexible height with overflow handling
-     * - Consistent padding and spacing
-     * - Responsive design
-     * - Proper content scrolling for long content
-     *
-     * @example
-     * <Dialog.Content>
-     *   <p>This is the main content of the dialog.</p>
-     * </Dialog.Content>
-     */
+    /** Renders the dialog's main content region. */
     Content: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
         sticky?: boolean;
     } & import('react').RefAttributes<HTMLDivElement>>;
-    /**
-     * DialogCancelButton component for cancel/close actions in a Dialog.
-     *
-     * Features:
-     * - Button that automatically closes the dialog when clicked
-     * - Extends all Button component props and functionality
-     * - Proper accessibility with close dialog semantics
-     * - Automatic focus management
-     * - Consistent styling with other dialog elements
-     * - Automatic tracking ID generation for analytics
-     *
-     * @example
-     * <Dialog.CancelButton appearance="ghost">Cancel</Dialog.CancelButton>
-     */
+    /** Closes the dialog after running its own click handler. */
     CancelButton: import('react').ForwardRefExoticComponent<import('./DialogCancelButton').DialogCancelButtonProps & import('react').RefAttributes<HTMLButtonElement>>;
 };

package/dist/src/components/Dialog/DialogCancelButton.d.ts

@@ -1,21 +1,6 @@
 import { ButtonProps } from '../Button';
 import { DataTrackingId } from '../../types';
-/**
- * Props for the DialogCancelButton component
- * @extends ButtonProps
- */
+/** @extends ButtonProps */
 export type DialogCancelButtonProps = ButtonProps & DataTrackingId;
-/**
- * DialogCancelButton component for cancel/close actions in a Dialog.
- *
- * Features:
- * - Button that automatically closes the dialog when clicked
- * - Extends all Button component props and functionality
- * - Proper accessibility with close dialog semantics
- * - Automatic focus management
- * - Consistent styling with other dialog elements
- *
- * @example
- * <Dialog.CancelButton appearance="ghost">Cancel</Dialog.CancelButton>
- */
+/** Button that runs its click handler before closing the enclosing dialog. */
 export declare const DialogCancelButton: import('react').ForwardRefExoticComponent<DialogCancelButtonProps & import('react').RefAttributes<HTMLButtonElement>>;

package/dist/src/components/Dialog/DialogContent.d.ts

@@ -1,42 +1,11 @@
 import { ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the DialogContent component
- * @extends ComponentPropsWithoutRef<"div">
- */
+/** @extends ComponentPropsWithoutRef<"div"> */
 export type DialogContentProps = ComponentPropsWithoutRef<"div"> & {
-    /**
-     * When true, the content will stick below the header during scroll.
-     * @default false
-     */
+    /** Pins the content below the changing header while the dialog scrolls. Defaults to `false`. */
     sticky?: boolean;
 };
-/**
- * DialogContent component for the main content area of a Dialog.
- *
- * Features:
- * - Main content container for dialog body
- * - Flexible height with overflow handling
- * - Optional sticky positioning below header
- * - Consistent padding and spacing
- * - Responsive design
- * - Proper content scrolling for long content
- *
- * @example
- * // Basic content
- * <Dialog.Content>
- *   <p>This is the main content of the dialog.</p>
- * </Dialog.Content>
- *
- * @example
- * // Sticky content (e.g., search field that remains visible while scrolling)
- * <Dialog.Content sticky>
- *   <TextField placeholder="Filter results..." />
- * </Dialog.Content>
- */
+/** Main content region of a `Dialog`. */
 export declare const DialogContent: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
-    /**
-     * When true, the content will stick below the header during scroll.
-     * @default false
-     */
+    /** Pins the content below the changing header while the dialog scrolls. Defaults to `false`. */
     sticky?: boolean;
 } & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/Dialog/DialogFooter.d.ts

@@ -1,33 +1,11 @@
 import { ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the DialogFooter component
- * @extends ComponentPropsWithoutRef<"footer">
- */
+/** @extends ComponentPropsWithoutRef<"footer"> */
 export type DialogFooterProps = ComponentPropsWithoutRef<"footer"> & {
-    /**
-     * @default false
-     */
+    /** Keeps the action row visible at the bottom of scrolling content. Defaults to `false`. */
     sticky?: boolean;
 };
-/**
- * DialogFooter component for the footer section of a Dialog.
- *
- * Features:
- * - Container for dialog action buttons
- * - Optional sticky positioning for long content
- * - Consistent spacing and alignment
- * - Right-aligned button layout by default
- * - Flexible content area for custom layouts
- *
- * @example
- * <Dialog.Footer sticky>
- *   <Dialog.CancelButton>Cancel</Dialog.CancelButton>
- *   <Button appearance="primary">Save</Button>
- * </Dialog.Footer>
- */
+/** Action row at the end of a dialog. */
 export declare const DialogFooter: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & {
-    /**
-     * @default false
-     */
+    /** Keeps the action row visible at the bottom of scrolling content. Defaults to `false`. */
     sticky?: boolean;
 } & import('react').RefAttributes<HTMLElement>>;

package/dist/src/components/Dialog/DialogHeader.d.ts

@@ -1,21 +1,6 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { DataTrackingId } from '../../types';
-/**
- * Props for the DialogHeader component
- * @extends ComponentPropsWithoutRef<"header">
- */
+/** @extends ComponentPropsWithoutRef<"header"> */
 export type DialogHeaderProps = ComponentPropsWithoutRef<"header"> & DataTrackingId;
-/**
- * DialogHeader component for the header section of a Dialog.
- *
- * Features:
- * - Displays dialog title with headline typography
- * - Includes close button with proper accessibility
- * - Sticky positioning for long content
- * - Consistent spacing and styling
- * - Automatic focus management
- *
- * @example
- * <Dialog.Header>Confirm Delete</Dialog.Header>
- */
+/** Dialog heading with a built-in close control. */
 export declare const DialogHeader: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & DataTrackingId & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/Dialog/internal/DialogContext.d.ts

@@ -6,9 +6,6 @@ export type DialogContextProps = {
     hasOpenPopover?: boolean;
     setHasOpenPopover?: Dispatch<SetStateAction<boolean | undefined>>;
     headerRef?: RefObject<HTMLElement>;
-    /**
-     * The current transition state of the dialog.
-     */
     state?: OpenCloseTransitionStates;
 };
 export declare const DialogContext: import('react').Context<DialogContextProps | null>;