​
About this component

The Tour component is a sequential walkthrough designed to guide users through in-app steps. While tours can be one of the most effective ways to onboard users, they can also be a bit controversial. A poorly designed tour can be frustrating, especially if it interrupts users when they have a task in mind. We’ve all been there—logging into an app only to be confronted by an intrusive tour that disrupts our focus. This often leads to users rushing to close or ignore the tour, resulting in a net negative experience.

When to Use Tours:

  • Product Onboarding: Show new users around critical workflows to get started
  • Feature Launches: Increase adoption of a new feature by showing users how it workflows
  • Ongoing Education: Automatically trigger tours for users once they reach a certain usage threshold, or give users the ability to request a tour themselves if they get stuck

Best Practices for Announcements:

  • Opt-In Design: Tours should ideally be opt-in. Asking users if they want guidance results in much higher engagement compared to forcing a tour upon them. Users can opt in from a checklist, announcement, inline card, or help hub.
  • Actionable Steps: Avoid generic and obvious statements like “This is the X page.” Instead, make tours actionable by connecting them to actual user actions. For example, a step that completes only when a user enters specific input or successfully finishes a task.
  • Keep It Short: Tours should be concise—avoid lengthy, 16-step tours that can overwhelm users.
  • Dismissible: Generally, tours should be dismissible. Be cautious about creating a tour that cannot be closed.
  • Relaunch Hub: If relevant, consider providing a hub where users can relaunch specific tours. This is helpful if they are not ready or don’t have time when prompted.

​
Resources

​
Demo

​
Installation

import * as Frigade from "@frigade/react";

const App = () => {
  return <Frigade.Tour flowId="my-flow-id" />;
};

​
Customization

To learn about how to customize Frigade components, see the customization documentation and examples of custom themes in action.

​
SDK Properties

​
align
AlignValue

The alignment of the tooltip relative to the anchor. Possible values: after, before, center, end, start.

​
alignOffset
number

The offset of the tooltip relative to the anchor along the alignment axis.

​
as
ElementType<any, keyof IntrinsicElements>

Optional component to wrap the child components in, e.g. as={Dialog} will render the Flow in a modal Dialog. Defaults to Box.

​
autoScroll
boolean

Automatically scroll to the anchor element of the current Step

​
autoStart
boolean

Whether to automatically mark the Flow started (i.e. in progress) when the Flow is eligible to be shown. You will need to call flow.start() or step.start() from the parent component if you set this to false. Most components should not need to override this behavior.

Defaults to true.

​
container
string , Element , DocumentFragment

Specify a container in the DOM render the Tour into. Use this to render the Tour into a different container/scrollable ancestor.

​
css
Interpolation<Theme>

Emotion CSS prop to apply to the component. See Theming documentation for more information.

Example usage:

<Frigade.Checklist css={{ backgroundColor: "pink", ".fr-button-primary": { backgroundColor: "fuchsia" } }} />
​
defaultOpen
boolean

Whether the tooltip should be open by default.

​
dismissible
boolean

Whether the Flow is dismissible or not

​
flowId
string

The Flow ID to render. You can find the Flow ID in the Frigade dashboard.

​
forceMount
boolean

If true, the Flow will be mounted even if it has already been completed or dismissed. However, if the user does not match the Flow’s targeting, the Flow will not be mounted.

​
lockScroll
boolean

Whether to lock the scroll of the container when the Spotlight is enabled. Defaults to true.

​
modal
boolean

Whether to render a modal overlay behind the tooltip.

​
onComplete
FlowHandlerProp

Handler for when the Flow is completed. This is event is fired immediately after the user completes the Flow.

​
onDismiss
FlowHandlerProp

Handler for when the Flow is dismissed (skipped). This is event is fired immediately after the user dismisses the Flow.

​
onOpenChange
(open: boolean) => void

Callback function triggered when the open state of the tooltip changes.

​
onPrimary
StepHandlerProp

Handler for when primary button is clicked. If this function returns false or a promise that resolves to false, the step will not be automatically completed when clicked.

​
onSecondary
StepHandlerProp

Handler for when secondary button is clicked. If this function returns false or a promise that resolves to false, the step will not be automatically completed when clicked.

​
open
boolean

Controls the open state of the tooltip. Use this for controlled components.

​
sequential
boolean

Whether the Tour should be completed by the end-user in sequential order. If false, all steps will be rendered at once. Defaults to true, which means only one step will be rendered at a time in sequential order.

​
side
SideValue

The preferred side of the anchor to render the tooltip. Possible values: top, right, bottom, left.

​
sideOffset
number

The distance in pixels from the tooltip to the anchor element.

​
spotlight
boolean

Whether to highlight the anchor element with a spotlight/scrim effect.

​
variables
Record<string, unknown>

Variables to pass to the Flow. You can use variables in the Flow configuration to customize copy. For instance, you can use title: Hello, ${name}! in the Flow configuration and pass variables={{name: 'John'}} to customize the copy.

Hint