Code

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

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

Flow Configuration

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

sequential
boolean
If true, all steps must be completed in order. This means that the next step will be disabled until the current step is completed. Default behavior is false.
steps
array
The steps to show in the checklist flow.
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.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

React Component Props

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.


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

Register the Flow as a modal to prevent popup collisions (only one modal Flow will render at a time).


onComplete

Optional onComplete: FlowHandlerProp

Handler for when the Flow is completed. If this function a promise that evaluates to false, the Flow will not be marked as completed.


onDismiss

Optional onDismiss: FlowHandlerProp

Handler for when the Flow is dismissed. If this function a promise that evaluates to false, the Flow will not be marked as dismissed.


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.


stepTypes

Optional stepTypes: StepTypes

Map of step types to their respective components. Use this to build custom step components. The type defined on the step in the Flow YAML config should match the key in this object. For instance, if you have a step with type: 'custom', you should provide a component for it like so:

<Checklist.Collapsible stepTypes={{ custom: CustomStepComponent }} />

The corresponding YAML config would look like:

steps:
 - id: custom-step
   type: custom

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