Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.trysiren.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The @sirenapp/react-native-inbox SDK is a comprehensive and customizable React Native UI kit for displaying and managing notifications. This documentation provides comprehensive information on how to install, configure, and use the SDK effectively.

​
Installation

npm install @sirenapp/react-native-inbox

​
Configuration

​
Initialization

Initialize the SDK with the user token and recipient ID. Wrap the provider around your App’s root. 
import { SirenProvider } from '@sirenapp/react-native-inbox';

const config = {
  userToken: 'your_user_token',
  recipientId: 'your_recipient_id',
};

function App() {
  return (
    <SirenProvider config={config}>
      {/* Your app components */}
    </SirenProvider>
  );
}

​
Configure Notification Icon

This component consists of a notification icon along with a badge to display the number of unviewed notifications. 
import { SirenInboxIcon } from '@sirenapp/react-native-inbox';

<SirenInboxIcon />

​
Icon Props

PropDescriptionTypeDefault
themeObject for custom themesTheme{}
customStylesObject for custom stylingCustomStyleProps{}
notificationIconOption to use custom notification iconJSX.Elementnull
darkModeToggle to enable dark modebooleanfalse
onErrorCallback for handling errors(error: SirenErrorType) => voidnull
onPressCustom click handler() => voidnull
disabledDisable click on iconbooleanfalse
hideBadgeHide unviewed count badgebooleanfalse

​
Customization

Theme Customization
type Theme = {
  dark: ThemeProps;
  light: ThemeProps;
};

type ThemeProps = {
  badgeStyle?: {
    color?: string;
    textColor?: string;
  };
};
Style Customization
type CustomStyleProps = {
  notificationIcon?: {
    size?: number,
  };
  badgeStyle?: {
    size?: number;
    textSize?: number;    
    top?: number;
    right?: number;
  };
};

​
Configure Notification Inbox

Inbox is a paginated list view for displaying notifications. 
import { SirenInbox } from '@sirenapp/react-native-inbox';

<SirenInbox />

​
Inbox Props

PropDescriptionTypeDefault
themeObject for custom themesTheme{}
customStylesObject for custom stylingCustomStyleProps{}
darkModeToggle dark modebooleanfalse
itemsPerFetchNotifications per request (max 50)number20
cardPropsCard customizationCardPropsSee below
customCardCustom card renderer(notification) => JSX.Elementnull
onCardClickCard click handler(notification) => void() => null
listEmptyComponentEmpty state componentJSX.Elementnull
headerPropsHeader customizationHeaderPropsSee below
customFooterCustom footer componentJSX.Elementnull
customLoaderCustom loading componentJSX.Elementnull
customErrorWindowCustom error componentJSX.Elementnull
onErrorError handler(error: SirenErrorType) => voidnull

​
Customization

Theme Customization
type Theme = {
  dark: ThemeProps;
  light: ThemeProps;
};

type ThemeProps = {
  colors?: {
    primaryColor?: string;
    textColor?: string;
    neutralColor?: string;
    borderColor?: string;
    highlightedCardColor?: string;
    dateColor?: string;
    deleteIcon?: string;
    timerIcon?: string;
    clearAllIcon?: string;
    infiniteLoader?: string;
  };
  windowHeader?: {
    background?: string;
    titleColor?: string;
    headerActionColor?: string;
    borderColor?: string;
  };
  windowContainer?: {
    background?: string;
  };
  notificationCard?: {
    borderColor?: string;
    background?: string;
    titleColor?: string;
    subTitleColor?: string;
    descriptionColor?: string;
  };
};
Style Customization
type CustomStyleProps = {
  window?: {
    width?: DimensionValue;
    height?: DimensionValue;
  };
  windowHeader?: {
    height?: number;
    titleFontWeight?: TextStyle['fontWeight'];
    titleSize?: number;
    borderWidth?: string;
    titlePadding?: number;
  };
  windowContainer?: {
    padding?: number;
  };
  notificationCard?: {
    padding?: number;
    borderWidth?: number;
    avatarSize?: number;
    titleFontWeight?: TextStyle['fontWeight'];
    titleSize?: number;
    subtitleFontWeight?: TextStyle['fontWeight'];
    subtitleSize?: number;
    descriptionFontWeight?: TextStyle['fontWeight'];
    descriptionSize?: number;
    dateSize?: number;
  };
  deleteIcon?: {
    size?: number;
  };
  timerIcon?: {
    size?: number;
  };
  clearAllIcon?: {
    size?: number;
  };
};

​
CardProps

type CardProps = {
  hideAvatar?: boolean;
  onAvatarClick?: (notification: NotificationDataType) => void;
  disableAutoMarkAsRead?: boolean;
  deleteIcon?: JSX.Element;
  hideDelete?: boolean;
  hideMediaThumbnail?: boolean;
  onMediaThumbnailClick?: (notification: NotificationDataType) => void;
};

​
HeaderProps

type HeaderProps = {
  title?: string;
  hideHeader?: boolean;
  hideClearAll?: boolean;
  customHeader?: JSX.Element | null;
  showBackButton?: boolean;
  backButton?: JSX.Element;
  onBackPress?: () => void;
};

​
Hooks

​
useSiren

useSiren is a hook that provides utility functions for modifying notifications. 
import { useSiren } from '@sirenapp/react-native-inbox';

function MyComponent() {
  const { markAsReadById, deleteById } = useSiren();

  function handleMarkAsRead(id) {
    markAsReadById(id);
  }

  return (
    // Your component logic
  );
}

​
useSiren Functions

FunctionParametersTypeDescription
markAsReadByDatestartDatestring (ISO date)Marks notifications as read until given date
markAsReadByIdidstringMarks a notification as read
deleteByIdidstringDeletes a notification by ID
deleteByDatestartDatestring (ISO date)Deletes notifications until given date
markAllAsViewedstartDatestring (ISO date)Marks notifications as viewed until given date

​
Complete Example

import React from 'react';
import { SafeAreaView, View } from 'react-native';
import { 
  SirenProvider, 
  SirenInbox, 
  SirenInboxIcon,
  useSiren 
} from '@sirenapp/react-native-inbox';

function App(): React.JSX.Element {
  const config = {
    userToken: 'your_user_token',
    recipientId: 'your_recipient_id',
  };

  return (
    <SirenProvider config={config}>
      <MyContainer />
    </SirenProvider>
  );
}

function MyContainer(): React.JSX.Element {
  const [showInbox, setShowInbox] = React.useState(false);
  const { markAllAsViewed } = useSiren();

  React.useEffect(() => {
    // Mark all notifications as viewed when component mounts
    markAllAsViewed(new Date().toISOString());
  }, []);

  return (
    <SafeAreaView style={{ flex: 1 }}>
      <View style={{ padding: 16 }}>
        <SirenInboxIcon 
          onPress={() => setShowInbox(true)}
          darkMode={false}
        />
      </View>
      
      {showInbox && (
        <SirenInbox
          darkMode={false}
          headerProps={{
            title: 'Notifications',
            showBackButton: true,
            onBackPress: () => setShowInbox(false)
          }}
          cardProps={{
            hideAvatar: false, 
            disableAutoMarkAsRead: false
          }}
        />
      )}
    </SafeAreaView>
  );
}

export default App;