@carbon/react 1.83.0 → 1.84.0

package/lib/components/Dialog/index.d.ts

@@ -5,7 +5,13 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { type HTMLAttributes } from 'react';
-export interface DialogProps extends HTMLAttributes<HTMLDialogElement> {
+import { InlineLoadingStatus } from '../InlineLoading/InlineLoading';
+/**
+ * ----------
+ * Dialog
+ * ----------
+ */
+interface DialogProps extends HTMLAttributes<HTMLDialogElement> {
     /**
      * Provide the contents of the Dialog
      */
@@ -42,26 +48,205 @@ export interface DialogProps extends HTMLAttributes<HTMLDialogElement> {
      * Specify whether the Dialog is currently open
      */
     open?: boolean;
+    /**
+     * Specify the role of the dialog for accessibility
+     * 'dialog' is the default, but 'alertdialog' can be used for important messages requiring user attention
+     */
+    role?: '' | 'alertdialog';
+    /**
+     * Specify a label for screen readers
+     */
+    ariaLabel?: string;
+    /**
+     * Specify the ID of an element that labels this dialog
+     */
+    ariaLabelledBy?: string;
+    /**
+     * Specify the ID of an element that describes this dialog
+     */
+    ariaDescribedBy?: string;
 }
-export declare const unstable__Dialog: React.ForwardRefExoticComponent<DialogProps & React.RefAttributes<unknown>>;
-export interface DialogHeaderProps extends HTMLAttributes<HTMLDivElement> {
+declare const unstable__Dialog: React.ForwardRefExoticComponent<DialogProps & React.RefAttributes<unknown>>;
+/**
+ * -------------
+ * DialogHeader
+ * -------------
+ */
+interface DialogHeaderProps extends HTMLAttributes<HTMLDivElement> {
     /**
      * Provide the contents to be rendered inside of this component
      */
     children?: React.ReactNode;
 }
-export declare const DialogHeader: React.ForwardRefExoticComponent<DialogHeaderProps & React.RefAttributes<HTMLDivElement>>;
-export interface DialogControlsProps extends HTMLAttributes<HTMLDivElement> {
+declare const DialogHeader: React.ForwardRefExoticComponent<DialogHeaderProps & React.RefAttributes<HTMLDivElement>>;
+/**
+ * ---------------
+ * DialogControls
+ * ---------------
+ */
+interface DialogControlsProps extends HTMLAttributes<HTMLDivElement> {
     /**
      * Provide the contents to be rendered inside of this component
      */
     children?: React.ReactNode;
 }
-export declare const DialogControls: React.ForwardRefExoticComponent<DialogControlsProps & React.RefAttributes<HTMLDivElement>>;
-export interface DialogCloseButtonProps extends HTMLAttributes<HTMLDivElement> {
+declare const DialogControls: React.ForwardRefExoticComponent<DialogControlsProps & React.RefAttributes<HTMLDivElement>>;
+/**
+ * -------------------
+ * DialogCloseButton
+ * -------------------
+ */
+interface DialogCloseButtonProps extends HTMLAttributes<HTMLDivElement> {
     /**
      * Specify a click handler applied to the IconButton
      */
     onClick?: React.MouseEventHandler;
 }
-export declare const DialogCloseButton: React.ForwardRefExoticComponent<DialogCloseButtonProps & React.RefAttributes<HTMLDivElement>>;
+declare const DialogCloseButton: React.ForwardRefExoticComponent<DialogCloseButtonProps & React.RefAttributes<HTMLDivElement>>;
+/**
+ * ------------
+ * DialogTitle
+ * ------------
+ */
+interface DialogTitleProps extends HTMLAttributes<HTMLHeadingElement> {
+    /**
+     * Provide the contents of the DialogTitle
+     */
+    children?: React.ReactNode;
+    /**
+     * Specify an optional className to be applied to the title node
+     */
+    className?: string;
+    /**
+     * Specify an optional id for the title element
+     */
+    id?: string;
+}
+declare const DialogTitle: React.ForwardRefExoticComponent<DialogTitleProps & React.RefAttributes<HTMLHeadingElement>>;
+/**
+ * ---------------
+ * DialogSubtitle
+ * ---------------
+ */
+interface DialogSubtitleProps extends HTMLAttributes<HTMLParagraphElement> {
+    /**
+     * Provide the contents of the DialogSubtitle
+     */
+    children?: React.ReactNode;
+    /**
+     * Specify an optional className to be applied to the subtitle node
+     */
+    className?: string;
+    /**
+     * Specify an optional id for the subtitle element
+     */
+    id?: string;
+}
+declare const DialogSubtitle: React.ForwardRefExoticComponent<DialogSubtitleProps & React.RefAttributes<HTMLParagraphElement>>;
+/**
+ * -----------
+ * DialogBody
+ * -----------
+ */
+interface DialogBodyProps extends HTMLAttributes<HTMLDivElement> {
+    /**
+     * Provide the contents of the DialogBody
+     */
+    children?: React.ReactNode;
+    /**
+     * Specify an optional className to be applied to the body node
+     */
+    className?: string;
+    /**
+     * Specify whether the content has overflow that should be scrollable
+     */
+    hasScrollingContent?: boolean;
+}
+declare const DialogBody: React.ForwardRefExoticComponent<DialogBodyProps & React.RefAttributes<HTMLDivElement>>;
+/**
+ * -------------
+ * DialogFooter
+ * -------------
+ */
+interface DialogFooterProps extends HTMLAttributes<HTMLDivElement> {
+    /**
+     * Provide the contents of the DialogFooter
+     */
+    children?: React.ReactNode;
+    /**
+     * Specify an optional className to be applied to the footer node
+     */
+    className?: string;
+    /**
+     * Specify a handler for closing dialog (secondary button)
+     */
+    onRequestClose?: React.ReactEventHandler<HTMLElement>;
+    /**
+     * Specify a handler for the secondary button.
+     * Useful if separate handler from `onRequestClose` is desirable
+     */
+    onSecondarySubmit?: React.ReactEventHandler<HTMLElement>;
+    /**
+     * Specify a handler for submitting dialog (primary button)
+     */
+    onRequestSubmit?: React.ReactEventHandler<HTMLElement>;
+    /**
+     * Specify the text for the primary button
+     */
+    primaryButtonText?: React.ReactNode;
+    /**
+     * Specify whether the Button should be disabled, or not
+     */
+    primaryButtonDisabled?: boolean;
+    /**
+     * Specify the text for the secondary button
+     */
+    secondaryButtonText?: React.ReactNode;
+    /**
+     * Specify an array of config objects for secondary buttons
+     */
+    secondaryButtons?: Array<{
+        buttonText: React.ReactNode;
+        onClick: React.MouseEventHandler<HTMLButtonElement>;
+    }>;
+    /**
+     * Specify whether the Dialog is for dangerous actions
+     */
+    danger?: boolean;
+    /**
+     * Specify loading status
+     */
+    loadingStatus?: InlineLoadingStatus;
+    /**
+     * Specify the description for the loading text
+     */
+    loadingDescription?: string;
+    /**
+     * Specify the description for the loading icon
+     */
+    loadingIconDescription?: string;
+    /**
+     * Specify an optional handler to be invoked when loading is
+     * successful
+     */
+    onLoadingSuccess?: () => void;
+}
+declare const DialogFooter: React.ForwardRefExoticComponent<DialogFooterProps & React.RefAttributes<HTMLDivElement>>;
+/**
+ * -------
+ * Exports
+ * -------
+ */
+type DialogComponentType = typeof unstable__Dialog & {
+    Root: typeof unstable__Dialog;
+    Header: typeof DialogHeader;
+    Controls: typeof DialogControls;
+    CloseButton: typeof DialogCloseButton;
+    Title: typeof DialogTitle;
+    Subtitle: typeof DialogSubtitle;
+    Body: typeof DialogBody;
+    Footer: typeof DialogFooter;
+};
+declare const Dialog: DialogComponentType;
+export { Dialog, unstable__Dialog, DialogHeader, DialogControls, DialogCloseButton, DialogTitle, DialogSubtitle, DialogBody, DialogFooter, };
+export type { DialogProps, DialogHeaderProps, DialogControlsProps, DialogCloseButtonProps, DialogTitleProps, DialogSubtitleProps, DialogBodyProps, DialogFooterProps, };