A set of components for integrating Knock in-app notifications into a React Native application.
Via NPM:
npm install @knocklabs/react-native
Via Yarn:
yarn add @knocklabs/react-native
To configure the feed you will need:
- A public API key (found in the Knock dashboard)
- A user ID, and optionally an auth token for production environments
- If integrating an in-app feed, a feed channel ID (found in the Knock dashboard)
You can integrate the feed into your app as follows:
import {
KnockProvider,
KnockFeedProvider,
NotificationFeedContainer,
} from "@knocklabs/react-native";
const YourAppLayout = () => {
const [isVisible, setIsVisible] = useState(false);
const notifButtonRef = useRef(null);
return (
<KnockProvider apiKey={process.env.KNOCK_PUBLIC_API_KEY} userId={userId}>
{/* Optionally, use the KnockFeedProvider to connect an in-app feed */}
<KnockFeedProvider feedId={process.env.KNOCK_FEED_ID}>
<NotificationFeedContainer>
<Text>Notifications go in here!</Text>
</NotificationFeedContainer>
</KnockFeedProvider>
</KnockProvider>
);
};Alternatively, if you don't want to use our components you can render the feed in a headless mode using our hooks:
import {
useAuthenticatedKnockClient,
useNotifications,
} from "@knocklabs/react-native";
import create from "zustand";
const YourAppLayout = () => {
const knockClient = useAuthenticatedKnockClient(
process.env.KNOCK_PUBLIC_API_KEY,
currentUser.id,
);
const notificationFeed = useNotifications(
knockClient,
process.env.KNOCK_FEED_ID,
);
const useNotificationStore = create(notificationFeed.store);
const { metadata } = useNotificationStore();
useEffect(() => {
notificationFeed.fetch();
}, [notificationFeed]);
return <Text>Total unread: {metadata.unread_count}</Text>;
};