Ember
How to set up Flows in your Ember application.
Flows makes it easy to add product adoption experiences into your Ember app. Integrating Flows into your app enables you to create interactive workflows, user onboarding, guided tours, in-app messaging, and more.
This guide walks you through integrating Flows into your Ember app using the JavaScript SDK and components package to get you started.
Using an AI coding assistant? Install the Flows install skill to let your agent set up Flows automatically.
Install the JavaScript SDK and components package
You can install the Flows JavaScript SDK from npm:
npm i @flows/js @flows/js-componentsInitialize the SDK
Use the init function to initialize the SDK with your organization ID and environment key, which you can find in the Settings > General and Settings > Environments sections of the Flows dashboard.
Check out the Ember template project for a complete example.
Create a flows.ts initializer at app/initializers/flows.ts to handle the initialization logic. Also, add the <flows-floating-blocks> custom element to your application template to render floating blocks.
import { init } from "@flows/js";
import { setupJsComponents } from "@flows/js-components";
import * as components from "@flows/js-components/components";
import * as tourComponents from "@flows/js-components/tour-components";
import * as surveyComponents from "@flows/js-components/survey-components";
import "@flows/js-components/index.css";
export function initialize() {
init({
organizationId: "YOUR_ORGANIZATION_ID", // Find this in Settings > General
userId: "YOUR_USER_ID", // Identify the user
environment: "production", // Default environment
});
setupJsComponents({
components: { ...components },
tourComponents: { ...tourComponents },
surveyComponents: { ...surveyComponents },
});
}
export default {
initialize,
};For a full list of supported properties, see the init function documentation. For an example of how to create a custom component, see the Ember template project.
Create your first workflow
That's it! You're now ready to create your first workflow. See our quickstart guide for more information.