react-hooks.useengagespot

Home > @engagespot/react-hooks > useEngagespot

useEngagespot() function

Signature:

export declare function useEngagespot({
  apiKey,
  userId,
  formatDate,
  placementOptions,
  disableNotificationChime,
  notificationChimeSrc,
  disableTitleUpdate,
  titleUpdateText,
  ...options
}: UseEngagespotOptions): {
  isValid: boolean;
  page: number;
  isMobile: boolean;
  useSystemDarkTheme: typeof useSystemDarkTheme;
  togglePanelVisibility: (
    panelUpdateFn?: (visibility: boolean) => boolean,
  ) => void;
  panelVisibility: boolean;
  getButtonProps: () => {
    onClick: () => void;
    ref: import('react').RefObject<HTMLButtonElement>;
  };
  getPanelProps: () => {
    ref: import('react').RefObject<HTMLElement>;
    style:
      | import('react').CSSProperties
      | {
          position: string;
          top: number;
          left: number;
          zIndex: number;
          width: string;
        };
  };
  getArrowProps: () => {
    ref: import('react').RefObject<HTMLElement>;
    style: import('react').CSSProperties;
  };
  getPanelOffsetProps: () => {
    style:
      | import('react').CSSProperties
      | {
          height: string;
          width: string;
        };
  };
  useJumpToTop: typeof useJumpToTop;
  notifications: {
    data: NotificationItem[];
    unreadCount: number;
  };
  notificationPermissionState: PermissionState;
  scroll: {
    loaderRef: (node: any) => void;
    containerRef: (node: any) => void;
    hasMore: boolean;
  };
};

Parameters

Parameter	Type	Description
{ apiKey, userId, formatDate, placementOptions, disableNotificationChime, notificationChimeSrc, disableTitleUpdate, titleUpdateText, ...options }	UseEngagespotOptions

Returns:

{ isValid: boolean; page: number; isMobile: boolean; useSystemDarkTheme: typeof useSystemDarkTheme; togglePanelVisibility: (panelUpdateFn?: (visibility: boolean) => boolean) => void; panelVisibility: boolean; getButtonProps: () => { onClick: () => void; ref: import("react").RefObject<HTMLButtonElement>; }; getPanelProps: () => { ref: import("react").RefObject<HTMLElement>; style: import("react").CSSProperties \| { position: string; top: number; left: number; zIndex: number; width: string; }; }; getArrowProps: () => { ref: import("react").RefObject<HTMLElement>; style: import("react").CSSProperties; }; getPanelOffsetProps: () => { style: import("react").CSSProperties \| { height: string; width: string; }; }; useJumpToTop: typeof useJumpToTop; notifications: { data: NotificationItem\[\]; unreadCount: number; }; notificationPermissionState: PermissionState; scroll: { loaderRef: (node: any) => void; containerRef: (node: any) => void; hasMore: boolean; }; }