adjust children type for compatibility

sumup-oss · Dec 5, 2024 · 6b2ccd8 · 6b2ccd8
1 parent 517ee80
commit 6b2ccd8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/packages/circuit-ui/components/Dialog/Dialog.tsx b/packages/circuit-ui/components/Dialog/Dialog.tsx
@@ -57,7 +57,7 @@ export interface DialogProps
   /**
    * a function that returns the content of the dialog.
    */
-  children?: () => ReactNode;
+  children?: ({ onClose }: { onClose?: DialogProps['onClose'] }) => ReactNode;
   /**
    * Text label for the close button for screen readers.
    * Important for accessibility.
@@ -255,7 +255,9 @@ export const Dialog = forwardRef<HTMLDialogElement, DialogProps>(
           <CloseButton onClick={handleDialogClose} className={classes.close}>
             {closeButtonLabel}
           </CloseButton>
-          {open && <div className={classes.content}>{children?.()}</div>}
+          {open && (
+            <div className={classes.content}>{children?.({ onClose })}</div>
+          )}
         </dialog>
       </>
     );

diff --git a/packages/circuit-ui/components/Dialog/ModalContext.tsx b/packages/circuit-ui/components/Dialog/ModalContext.tsx
@@ -23,10 +23,11 @@ import {
   useState,
 } from 'react';
 
+import type { Optional } from '../../types/util.js';
+
 import type { DialogProps } from './Dialog.js';
 import type { ModalDialogComponent } from './createUseModalDialog.js';
 
-type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
 export type SetModalArgs = Optional<DialogProps, 'open'>;
 
 // keep initial state compatible with the old version of this component