Banner - Frigade

About this component

The Banner component is a versatile, persistent UI component that typically span the full width of a page or container, often at the top or bottom of the page. They serve as an unobtrusive way to communicate important information and promote additional offerings without disrupting the user’s workflow.

When to use Banners:

Alerts: Ideal for notifying users about critical updates, such as free trial expirations or scheduled maintenance.
Lightweight Up-sells: Effective for promoting related products or features, banners can be strategically targted and placed next to relevant content.

Advantages of Banners:

Non-Disruptive Communication: Since banners remain visible without interrupting the user experience, they allow users to continue their tasks while still being informed.
Flexible Design Options: Banners can be customized with full-bleed graphics and images, making them visually appealing and engaging. Frigade supports custom components including on-brand, eye-catching banners.

Best Practices for Banners:

Use Collections: Leverage Collections to define reusable in-app UI channels, enabling teams to efficiently manage and launch banners across different pages, such as your product dashboard or a specific product pages.
Regulate Frequency: Control the frequency of banner displays to ensure they remain relevant and engaging without overwhelming users.
Make Dismissible: Most often, banners are easily dismissible for the best user expeirence. In select cases, banners may be non-dismissible to communicate a critical message for some time (e.g. product downtime).

Resources

Launch banners with no-code using custom Collections
Target your banner to specific users with Targeting
See industry examples of banners

Demo

See banners in action in our live demo

Installation

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

const App = () => {
  return (
    <Frigade.Banner 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

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.

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.

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" } }} />

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.

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.

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.

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.

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.

autoStart

boolean

Defaults to true.

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" } }} />

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.

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.

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.

variables

Record<string, unknown>

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

Components

​About this component

​Resources

​Demo

​Installation

​Customization

​SDK Properties

About this component

Resources

Demo

Installation

Customization

SDK Properties