In-App UI
React
Hooks
useGuideContext

useGuideContext

The useGuideContext hook is used to access the guide context and client instance within a guide provider. This hook provides access to the guide client and theme information.

Parameters

#

This hook does not accept any parameters.

Returns

#
clientKnockGuideClient

The guide client instance for managing guides.

colorMode'light' | 'dark'

The current theme color mode.

Example

#

Basic usage

#

The following example demonstrates how to use the useGuideContext hook to access the guide client and theme.