​
Setup Guide

Check out our guide on how to create your first product tour in just a few minutes.

​
Code

​
Flow Configuration

The following props are available in the YAML Config defined in the Frigade Dashboard:

​
steps
array
The steps to show in the tooltip tour.
​
steps[].id
string
Unique identifier for the step. Do not change this once the step has been created.
​
steps[].title
string
The title of the step
​
steps[].subtitle
string
The description of the step
​
steps[].imageUri
string
Url to an image to display in the step
​
steps[].iconUri
string
Url to an icon to display in the step. This is only supported by the carousel checklist component.
​
steps[].videoUri
string
Url to a video to display in the step such as YouTube, Vimeo, or a direct link to an mp4 file
​
steps[].primaryButton
object
Config for the primary button in this step.
​
steps[].primaryButton.action
boolean,string
Primary button action. (defaults to step.complete).
Possible values: false, flow.back, flow.complete, flow.forward, flow.restart, flow.skip, flow.start, step.complete, step.skip, step.reset, step.start
​
steps[].primaryButton.target
string
Primary button URI target (defaults to _self).
​
steps[].primaryButton.title
string
Primary button title. If omitted, the primary button will not be shown.
​
steps[].primaryButton.uri
string
Primary button URI.
​
steps[].primaryButtonTitle
string
Deprecated: use primaryButton.title instead. The title of the primary button
​
steps[].primaryButtonUri
string
Deprecated: use primaryButton.uri instead. The url to open when the primary button is clicked
​
steps[].primaryButtonUriTarget
string
Deprecated: use primaryButton.target instead. The target of the primary button url (default: _blank; use _self to open in the same window). Setting it to # will open the existing page and dismiss any Frigade modals.
​
steps[].secondaryButton
object
Config for the secondary button in this step.
​
steps[].secondaryButton.action
boolean,string
Secondary button action. (defaults to step.complete).
Possible values: false, flow.back, flow.complete, flow.forward, flow.restart, flow.skip, flow.start, step.complete, step.skip, step.reset, step.start
​
steps[].secondaryButton.target
string
Secondary button URI target (defaults to _self).
​
steps[].secondaryButton.title
string
Secondary button title. If omitted, the secondary button will not be shown.
​
steps[].secondaryButton.uri
string
Secondary button URI.
​
steps[].secondaryButtonTitle
string
Deprecated: use secondaryButton.title instead. The title of the secondary button
​
steps[].secondaryButtonUri
string
Deprecated: use secondaryButton.uri instead. The url to open when the secondary button is clicked
​
steps[].secondaryButtonUriTarget
string
Deprecated: use secondaryButton.target instead. The target of the secondary button url (default: _blank; use _self to open in the same window). Setting it to # will open the existing page and dismiss any Frigade modals.
​
steps[].completionCriteria
string
Targeting that automatically completes the step. E.g.: user.property(‘connectedBank’) == true
​
steps[].startCriteria
string
Targeting that automatically blocks the step from starting until it becomes true. E.g.: user.property(‘connectedBank’) == true
​
steps[].visibilityCriteria
string
Targeting that automatically shows the step when it becomes true. E.g.: user.property(‘connectedBank’) == true
​
steps[].props
object
Override the default UI props for the corresponding component
​
steps[].selector
string
CSS class or ID of the element to highlight in the step (e.g. .my-element or #my-element)

​
React Component Props

​
align

Optional align: AlignValue

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

​
alignOffset

Optional alignOffset: number

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

​
as

Optional 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

Optional autoScroll: boolean

Automatically scroll to the anchor element of the current Step

​
container

Optional 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

Optional 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

Optional defaultOpen: boolean

Whether the tooltip should be open by default.

​
dismissible

Optional dismissible: boolean

Whether the Flow is dismissible or not

​
flowId

flowId: string

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

​
forceMount

Optional 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.

Optional modal: boolean

Whether to render a modal overlay behind the tooltip.

​
onComplete

Optional onComplete: FlowHandlerProp

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

​
onDismiss

Optional onDismiss: FlowHandlerProp

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

​
onOpenChange

Optional onOpenChange: (open: boolean) => void

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

Parameters

NameType
openboolean

Returns

void

​
onPrimary

Optional onPrimary: StepHandlerProp

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

​
onSecondary

Optional onSecondary: StepHandlerProp

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

​
open

Optional open: boolean

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

​
sequential

Optional 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

Optional side: SideValue

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

​
sideOffset

Optional sideOffset: number

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

​
spotlight

Optional spotlight: boolean

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

​
variables

Optional 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.

View definition

Hint