Cleanup components' props interfaces

sumup-oss · Jan 16, 2025 · bb3e133 · bb3e133
1 parent b18cf72
commit bb3e133
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 9 deletions.
diff --git a/packages/circuit-ui/components/Dialog/Dialog.tsx b/packages/circuit-ui/components/Dialog/Dialog.tsx
@@ -88,7 +88,7 @@ export interface DialogProps
    */
   preventClose?: boolean;
   /**
-   * Enables focusing a particular element in the dialog content and override default behavior. This will have no effect if the dialog is not modal.
+   * Enables focusing a particular element in the dialog content and overrides the default behavior.
    * @default `false`.
    */
   initialFocusRef?: RefObject<HTMLElement>;

diff --git a/packages/circuit-ui/components/Modal/Modal.stories.tsx b/packages/circuit-ui/components/Modal/Modal.stories.tsx
@@ -76,8 +76,6 @@ const openModal = async ({
 const baseArgs: ModalProps = {
   open: false,
   onClose: () => {},
-  'aria-labelledby': 'title',
-  'aria-describedby': 'description',
   variant: 'contextual',
   children: defaultModalChildren,
 };

diff --git a/packages/circuit-ui/components/Modal/Modal.tsx b/packages/circuit-ui/components/Modal/Modal.tsx
@@ -28,7 +28,11 @@ import classes from './Modal.module.css';
 export interface ModalProps
   extends Omit<
     DialogProps,
-    'onCloseStart' | 'onCloseEnd' | 'isModal' | 'animationDuration'
+    | 'onCloseStart'
+    | 'onCloseEnd'
+    | 'isModal'
+    | 'animationDuration'
+    | 'preventOutsideClickRefs'
   > {
   /**
    * Use the `immersive` variant to focus the user's attention on the dialog content.
@@ -38,7 +42,7 @@ export interface ModalProps
   /**
    * Callback when the modal dialog is closed.
    */
-  onClose: DialogProps['onCloseEnd'];
+  onClose?: DialogProps['onCloseEnd'];
   /**
    * @deprecated This prop was passed to `react-modal` and is no longer relevant.
    * Use the `preventClose` prop instead. Also see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/dialog_role#required_javascript_features

diff --git a/packages/circuit-ui/components/Popover/Popover.tsx b/packages/circuit-ui/components/Popover/Popover.tsx
@@ -75,7 +75,16 @@ export interface PopoverReferenceProps {
 export interface PopoverProps
   extends Omit<
     DialogProps,
-    'children' | 'role' | 'open' | 'onCloseEnd' | 'onCloseStart'
+    | 'children'
+    | 'role'
+    | 'open'
+    | 'onCloseEnd'
+    | 'onCloseStart'
+    | 'isModal'
+    | 'animationDuration'
+    | 'preventClose'
+    | 'initialFocusRef'
+    | 'preventOutsideClickRefs'
   > {
   /**
    * Determines whether the Popover is open or closed.

diff --git a/packages/circuit-ui/components/Toggletip/Toggletip.tsx b/packages/circuit-ui/components/Toggletip/Toggletip.tsx
@@ -57,7 +57,15 @@ export interface ToggletipReferenceProps {
 export interface ToggletipProps
   extends Omit<
     DialogProps,
-    'onCloseStart' | 'onCloseEnd' | 'isModal' | 'animationDuration'
+    | 'onCloseStart'
+    | 'onCloseEnd'
+    | 'isModal'
+    | 'animationDuration'
+    | 'initialFocusRef'
+    | 'open'
+    | 'preventClose'
+    | 'preventOutsideClickRefs'
+    | 'children'
   > {
   /**
    * The button element that triggers the toggletip.
@@ -88,7 +96,7 @@ export interface ToggletipProps
   /**
    * Where to display the toggletip relative to the trigger component. The
    * toggletip will automatically move if there isn't enough space available.
-   * Default: 'top'.
+   * @default 'top'.
    */
   placement?: Placement;
   /**
@@ -98,7 +106,7 @@ export interface ToggletipProps
    * positive) or towards (if negative) the reference element. Pass an object
    * to displace the floating element on both the main and cross axes.
    *
-   * Default: 12.
+   * @default: 12.
    */
   offset?: number | { mainAxis?: number; crossAxis?: number };
 }