@nimbus-ds/components 5.18.0 → 5.19.0

package/dist/index.d.ts

@@ -1775,6 +1775,7 @@ export interface ModalSprinkle {
 declare const modal: {
 	classnames: {
 		overlay: string;
+		overlayScoped: string;
 		container: string;
 		container__close: string;
 		container__footer: string;
@@ -2132,7 +2133,9 @@ declare const sidebar: {
 	};
 	classnames: {
 		overlay: string;
+		overlayScoped: string;
 		container: string;
+		containerScoped: string;
 		container__header: string;
 		container__body: string;
 		container__footer: string;
@@ -3278,6 +3281,7 @@ export interface CollapsibleProperties {
 }
 export type CollapsibleBaseProps = CollapsibleProperties & Omit<HTMLAttributes<HTMLElement>, "onChange">;
 export declare const Collapsible: React.FC<CollapsibleProperties> & CollapsibleComponents;
+export type CloseOnOutsidePress = (event: PointerEvent | MouseEvent) => boolean;
 export interface ModalBodyProperties {
 	/**
 	 * The content of the modal body.
@@ -3348,13 +3352,33 @@ export interface ModalProperties extends ModalSprinkle {
 	 * Id to be embedded in the portal element
 	 */
 	portalId?: string;
+	/**
+	 * Controls whether clicking/pressing outside should close the modal.
+	 * - boolean: enable/disable dismissal on outside press
+	 * - function: receive the DOM event and return true to allow closing, false to ignore
+	 *
+	 * Defaults to true.
+	 */
+	closeOnOutsidePress?: boolean | CloseOnOutsidePress;
+	/**
+	 * The attribute name to ignore when checking for outside clicks. Useful to
+	 * mark regions (e.g., a chat) that should not close the modal when clicked.
+	 * @default "data-nimbus-outside-press-ignore"
+	 */
+	ignoreAttributeName?: string;
 	/**
 	 * The padding properties are used to generate space around an modal's content area.
 	 * @default base
 	 */
 	padding?: keyof typeof modal.properties.padding;
 }
-export type ModalProps = ModalProperties & HTMLAttributes<HTMLDivElement>;
+export type ModalProps = ModalProperties & {
+	/**
+	 * Root element where the portal should be mounted. When provided and not null,
+	 * the portal renders inside this element; when null/undefined, the default root is used.
+	 */
+	root?: HTMLElement | null;
+} & HTMLAttributes<HTMLDivElement>;
 export declare const Modal: React.FC<ModalProps> & ModalComponents;
 export interface PaginationItemData {
 	pageNumber: number | string;
@@ -3552,8 +3576,27 @@ export interface SidebarProperties extends SidebarSprinkle {
 	 * @default true
 	 */
 	needRemoveScroll?: boolean;
+	/**
+	 * Controls whether clicking/pressing outside should close the sidebar.
+	 * - boolean: enable/disable dismissal on outside press
+	 * - function: receive the DOM event and return true to allow closing, false to ignore
+	 *
+	 * Defaults to true for backward compatibility.
+	 */
+	closeOnOutsidePress?: boolean | CloseOnOutsidePress;
+	/**
+	 * The attribute name to ignore when checking for outside clicks.
+	 * @default "data-nimbus-outside-press-ignore"
+	 */
+	ignoreAttributeName?: string;
 }
-export type SidebarProps = SidebarProperties & HTMLAttributes<HTMLDivElement>;
+export type SidebarProps = SidebarProperties & {
+	/**
+	 * Root element where the portal should be mounted. When provided and not null,
+	 * the portal renders inside this element; when null/undefined, the default root is used.
+	 */
+	root?: HTMLElement | null;
+} & HTMLAttributes<HTMLDivElement>;
 export declare const Sidebar: React.FC<SidebarProps> & SidebarComponents;
 /**
  * Represents the visual state of a step