@knocklabs/react-native
TypeScript icon, indicating that this package has built-in type declarations

0.2.5 • Public • Published

Knock React Native SDK

A set of components for integrating Knock in-app notifications into a React Native application.

Full documentation

Installation

Via NPM:

npm install @knocklabs/react-native

Via Yarn:

yarn add @knocklabs/react-native

Configuration

To configure the feed you will need:

  1. A public API key (found in the Knock dashboard)
  2. A user ID, and optionally an auth token for production environments
  3. If integrating an in-app feed, a feed channel ID (found in the Knock dashboard)

Usage

You can integrate the feed into your app as follows:

import {
  KnockFeedProvider,
  KnockProvider,
  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}>
      <KnockFeedProvider feedId={process.env.KNOCK_FEED_ID}>
        <NotificationFeedContainer>
          <Text>Notifications go in here!</Text>
        </NotificationFeedContainer>
      </KnockFeedProvider>
    </KnockProvider>
  );
};

Headless usage

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>;
};

Related links

Readme

Keywords

none

Package Sidebar

Install

npm i @knocklabs/react-native

Weekly Downloads

1,913

Version

0.2.5

License

MIT

Unpacked Size

56.4 kB

Total Files

33

Last publish

Collaborators

  • cjbell