@amboss/design-system 3.37.0 → 3.37.2

package/build/esm/components/Patterns/Modal/Modal.d.ts

@@ -1,4 +1,4 @@
-import type { AriaAttributes } from "react";
+import type { AriaAttributes, RefObject } from "react";
 import React from "react";
 import type { Property } from "csstype";
 import type { PortalProps } from "../../Portal/Portal";
@@ -50,6 +50,15 @@ type BaseProps = {
     isMaxWidthLimit?: boolean;
     size?: "m" | "l";
     closeButtonAriaLabel?: string;
+    /**
+     * Determines which element receives focus when the modal opens.
+     * - Pass a **RefObject** to focus a specific custom element.
+     * - Pass a string that will act as css selector to focus that specific element
+     * For and actionButton, secondaryButton, pass a ref to those elements and to this prop
+     * For closeButton focus, pass "[data-modal-close-btn]"
+     * - If **undefined**, focus falls back to the first focusable element in the modal.
+     */
+    initialFocus?: RefObject<HTMLElement | SVGElement> | string;
 } & Omit<AriaAttributes, "aria-label" | "aria-labelledby">;
 /** At least one of header, aria-label, or aria-labelledby must be provided for accessibility */
 type LabelProps = {
@@ -77,7 +86,7 @@ type ConditionalProps = {
     ImageComponent?: React.ElementType<any>;
 };
 export type ModalProps = BaseProps & LabelProps & ConditionalProps & Pick<PortalProps, "portalContainer">;
-export declare function Modal({ header, subHeader, labelHeader, children, imageUrl, ImageComponent, secondaryButton, cancelButtonLabel, isDismissible, isFullScreen, isMaxWidthLimit, actionButton, role, onAction, size, privateProps: { skipPortal, height, zeroPadding, tabbableOptions }, portalContainer, closeButtonAriaLabel, "data-e2e-test-id": dataE2eTestId, imageAlt, ...ariaAttributes }: ModalProps): React.ReactElement;
+export declare function Modal({ header, subHeader, labelHeader, children, imageUrl, ImageComponent, secondaryButton, cancelButtonLabel, isDismissible, isFullScreen, isMaxWidthLimit, actionButton, role, onAction, size, privateProps: { skipPortal, height, zeroPadding, tabbableOptions }, portalContainer, closeButtonAriaLabel, "data-e2e-test-id": dataE2eTestId, imageAlt, initialFocus, ...ariaAttributes }: ModalProps): React.ReactElement;
 export declare namespace Modal {
     var Stack: ({ children, ...rest }: Omit<StackProps, "space">) => React.JSX.Element;
     var Text: ({ children, ...rest }: Omit<TextProps, "size" | "variant">) => React.JSX.Element;