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
Whether the provider is ready to target and display guides.
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.