Solid
How to set up Flows in your Solid application.
Flows makes it easy to add product adoption experiences into your Solid app built with or without SolidStart. 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 Solid app using the JavaScript SDK and components package to get you started.
Check out our template projects for examples of how to implement Flows in your application.
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.
Create a Flows component to handle the initialization logic and rendering of the floating blocks. Then add the Flows component to your root layout. Lastly tell TypeScript about Flows custom elements in a global.d.ts file.
import { onMount } from "solid-js";
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";
// Don't forget to import the CSS styles for Flows components
import "@flows/js-components/index.css";
export const Flows = () => {
onMount(() => {
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 },
});
});
return <flows-floating-blocks />;
};For a full list of supported properties, see the init function documentation. For an example of how to create a custom component, see the Solid 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.
Last updated on