In-App UI
React
Hooks
useGuides

useGuides

The useGuides hook returns an array of guides matching the provided filter criteria. It supports typing the guide step content to ensure type safety.

Parameters

#
typestring
Match any guide by its type, which corresponds to the key of a message type

Returns

#

A UseGuidesReturn object with the following properties:

guidesKnockGuide[]
Zero or more matching guides

Example

#

Getting guides for a specific message type

#

Typing the guides

#