Docs
/
In-App UI
React
Components
KnockGuideProvider

KnockGuideProvider

A React context provider that manages in-app guide state and provides guide-related functionality to child components.

Usage

#

Props

#
channelIdstringRequired

The channel ID for the guide channel.

readyToTargetboolean

Signals when the provider should initialize the guide client and fetch eligible guides. To prevent guides from being fetched with incomplete or undefined targeting data, set to true only when all targetParams data is available.

listenForUpdatesboolean

Whether to listen for real-time guide updates. Defaults to true.

colorModeColorMode

The color mode for guide styling (light or dark).

targetParamsKnockGuideTargetParams

Additional targeting parameters for guide display conditions.

trackLocationFromWindowboolean

Whether to automatically track location changes from the browser window.

orderResolutionDurationnumber

Duration in milliseconds for resolving guide order conflicts.

throttleCheckIntervalnumber

Interval in milliseconds for throttling guide checks.

childrenReactNode

Child components that will have access to the guide context.