feat(components): Rename offset prop to placementOffset in Inbox comp…

…onents for consistency
novuhq · Nov 25, 2024 · 78c6828 · 78c6828
1 parent 7888e2d
commit 78c6828
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/packages/js/src/ui/components/Inbox.tsx b/packages/js/src/ui/components/Inbox.tsx
@@ -21,7 +21,7 @@ export type InboxProps = {
   onPrimaryActionClick?: NotificationActionClickHandler;
   onSecondaryActionClick?: NotificationActionClickHandler;
   placement?: Placement;
-  offset?: OffsetOptions;
+  placementOffset?: OffsetOptions;
 };
 
 export enum InboxPage {
@@ -96,7 +96,7 @@ export const Inbox = (props: InboxProps) => {
   const isOpen = () => props?.open ?? isOpened();
 
   return (
-    <Popover.Root open={isOpen()} onOpenChange={setIsOpened} placement={props.placement} offset={props.offset}>
+    <Popover.Root open={isOpen()} onOpenChange={setIsOpened} placement={props.placement} offset={props.placementOffset}>
       <Popover.Trigger
         asChild={(triggerProps) => (
           <Button class={style('inbox__popoverTrigger')} variant="ghost" size="icon" {...triggerProps}>

diff --git a/packages/react/src/components/Inbox.tsx b/packages/react/src/components/Inbox.tsx
@@ -17,8 +17,8 @@ const _DefaultInbox = (props: DefaultInboxProps) => {
     onNotificationClick,
     onPrimaryActionClick,
     onSecondaryActionClick,
-    offset,
     placement,
+    placementOffset,
   } = props;
   const { novuUI } = useNovuUI();
   const { mountElement } = useRenderer();
@@ -36,7 +36,7 @@ const _DefaultInbox = (props: DefaultInboxProps) => {
           onNotificationClick,
           onPrimaryActionClick,
           onSecondaryActionClick,
-          offset,
+          placementOffset,
           placement,
         },
         element,
@@ -123,7 +123,7 @@ const InboxChild = React.memo((props: InboxProps) => {
     onNotificationClick,
     onPrimaryActionClick,
     onSecondaryActionClick,
-    offset,
+    placementOffset,
     placement,
   } = props;
 
@@ -137,7 +137,7 @@ const InboxChild = React.memo((props: InboxProps) => {
         onPrimaryActionClick={onPrimaryActionClick}
         onSecondaryActionClick={onSecondaryActionClick}
         placement={placement}
-        offset={offset}
+        placementOffset={placementOffset}
       />
     </NovuUI>
   );

diff --git a/packages/react/src/utils/types.ts b/packages/react/src/utils/types.ts
@@ -21,7 +21,7 @@ export type DefaultInboxProps = {
   onPrimaryActionClick?: NotificationActionClickHandler;
   onSecondaryActionClick?: NotificationActionClickHandler;
   placement?: InboxProps['placement'];
-  offset?: InboxProps['offset'];
+  placementOffset?: InboxProps['placementOffset'];
 };
 
 export type BaseProps = {

diff --git a/playground/nextjs/src/pages/index.tsx b/playground/nextjs/src/pages/index.tsx
@@ -15,7 +15,7 @@ export default function Home() {
           },
         }}
         placement="left-start"
-        offset={25}
+        placementOffset={25}
       />
     </>
   );