React Native API reference
Complete API reference for the Knock React Native SDK.
In this section, you'll find the complete documentation for the components exposed in @knocklabs/react-native, including the props available.
Note: You can see a reference for the methods available for the Knock class, as well as a Feed instance under the client JS docs.
Components
#KnockProvider
#The top-level provider that connects to Knock with the given API key and authenticates a user.
Props
#Accepts KnockProviderProps
The public API key for the environment.
User identification data.
A JWT that identifies the authenticated user, signed with the private key provided in the Knock dashboard. Required to secure your production environment. Learn more.
Defaults to true. When false, children still render but the Knock client stays idle: no identify call, no API requests, and no websocket. Flipping it to true authenticates and connects the client; flipping it back to false disconnects it and clears its data. Use it to defer activity until you have a complete identity (see below).
A custom API host for Knock.
An optional set of translations to override the default en translations used in the feed components.
Deferring activity with enabled
#KnockProvider takes an enabled prop that defaults to true. When it's false, the provider still renders its children, but the Knock client sits idle: it doesn't identify the user, make any API requests, or open a websocket. Set it back to true and the client authenticates and connects; set it to false again and it disconnects and clears its data.
This is the recommended way to gate the provider on a complete identity — for example, an enhanced-security user token that isn't ready on the first render — rather than mounting and unmounting KnockProvider as that identity changes:
When enabled becomes true, feed components remount and reload their data, and Slack and Microsoft Teams connection status re-checks for the authenticated user. To react to these transitions in your own components, use the useKnockAuthState hook.
KnockFeedProvider
#The feed-specific provider that connects to a feed for that user. Must be a child of the KnockProvider.
Props
#Accepts KnockFeedProviderProps:
The channel ID of the in-app feed to be displayed.
Set defaults for tenant, has_tenant, source, archived to scope all subsequent feed queries.
Sets the theme as either light or dark mode (defaults to light).
KnockPushNotificationProvider
#A context provider designed to streamline the integration of push notifications within your React Native application. It facilitates the registration of device push tokens with the Knock backend, enabling the delivery of notifications.
It is recommended to use the usePushNotifications hook to interact with this context provider.
Note: Must be a child of the KnockProvider.
Props
#None other than children.
Hooks
#useKnock
#The KnockProvider exposes a useKnock hook for all child components.
Returns: Knock, an instance of the Knock JS client.
Example:
useKnockFeed
#The KnockFeedProvider exposes a useKnockFeed hook for all child components.
Returns: KnockFeedProviderState
The instance of the Knock client.
The instance of the authenticated Feed.
A zustand store containing the FeedStoreState.
Current value of the filter status for the Feed.
A function to set the current FilterStatus.
The current theme color.
Example:
useAuthenticatedKnockClient
#Creates an authenticated Knock client.
Returns: Knock instance, authenticated against the user
Example:
useKnockAuthState
#Subscribes to a Knock client's authentication state, re-rendering when the authenticated user changes. Use it to react to the enabled prop on KnockProvider flipping between states.
Returns: KnockAuthState
Whether a user is authenticated to the client.
The ID of the authenticated user, or undefined when no user is authenticated.
The user token in use for the authenticated user, when one was provided.
Example:
useNotifications
#Creates a Feed instance for the provided Knock client which creates a stateful, real-time connection to Knock to build in-app experiences.
Returns: Feed instance
Example:
useTranslations
#Exposed under KnockI18nProvider child components.
Returns:
The current locale code (defaults to en).
A helper function to get the value of a translation from the current Translations.
usePushNotifications
#The KnockPushNotificationProvider exposes a usePushNotifications hook for all child components, enabling them to register and unregister a device's push token from a channel.
Returns: KnockPushNotificationContextType
Registers the device's push token with a specific channel in the Knock backend.
Removes the device's push token from a specific channel in the Knock backend.
Example:
Types
#UserIdentificationOptions
#User identification data to pass through to the authenticate method.
The id for the user.
Attribute to attach to the user on identification.
I18nContent
#Used to set translations available in the child components exposed under KnockFeedProvider and KnockSlackProvider. Used in the useTranslations hook.
Note: locale must be a valid locale code.