Embed Fillout forms in your React project
npm install @fillout/reactEmbed Fillout forms directly in your React project. TypeScript included, no dependencies :)
_Hint: If you're looking to use the Fillout API in Node.js, try @fillout/api!_
- Setup
- Embed components
- Standard embed
- FullScreen embed
- Popup embed
- Slider embed
- Popup and Slider embed buttons
- Listening for form events
- Custom domains
Install with npm i @fillout/react
There is a component for each embed type. All of them require the filloutId prop, which is the id of your form. This code is easy to spot in the url of the editor or the live form, for example, forms.fillout.com/t/foAdHjd1Duus.
All embed components allow you to pass URL parameters using the optional parameters prop, and you can also use inheritParameters to make the form inherit the parameters from the host page's url.
This one is pretty simple.
``js
import { FilloutStandardEmbed } from "@fillout/react";
function App() {
return (
export default App;
`
If you'd rather not set the embed height manually and instead have it expand to the form size, use the dynamicResize prop.
The FilloutFullScreenEmbed component fills the entire page, with position: fixed.
`js
import { FilloutFullScreenEmbed } from "@fillout/react";
function App() {
return
}
export default App;
`
This component creates a popup, with a dark background covering the page content behind. Unlike the FullScreen embed, it can be closed using the close button or by clicking outside of the popup.
You control it using your own state. The isOpen and onClose props are required.
`js
import { useState } from "react";
import { FilloutPopupEmbed } from "@fillout/react";
function App() {
const [isOpen, setIsOpen] = useState(false);
return (
<>
isOpen={isOpen}
onClose={() => setIsOpen(false)}
/>
>
);
}
export default App;
`
Similar to the popup embed, this is intended to be used alongside your own button and state, so the component requires isOpen and onClose props. The form will slide out from the side of the screen. You can control which direction it comes from using sliderDirection, which can be left or right (default).
`js
import { useState } from "react";
import { FilloutSliderEmbed } from "@fillout/react";
function App() {
const [isOpen, setIsOpen] = useState(false);
return (
<>
inheritParameters
parameters={{
example: "abc",
}}
isOpen={isOpen}
onClose={() => setIsOpen(false)}
sliderDirection="left"
/>
>
);
}
export default App;
`
If you would prefer not to manage the open state of a popup or slider yourself, you can use FilloutPopupEmbedButton or FilloutSliderEmbedButton. This will render a button that opens the embed when clicked. These components take the same props as their standalone counterparts (except for isOpen and onClose), but have some extra optional props to customize the button.
- text - change the button textcolor
- - change the button background color. the text color will automatically contrast with this as long as you specify a hex code.size
- - small, medium or largefloat
- - make your button float on the screen. bottomLeft or bottomRight.
`js
import { FilloutSliderEmbedButton } from "@fillout/react";
function App() {
return (
inheritParameters
parameters={{
example: "abc",
}}
sliderDirection="left"
text="Schedule a call"
color="#444444"
size="small"
float="bottomRight"
/>
);
}
export default App;
`
If you need greater control over the button appearance, you can just make your own and use it in conjunction with the standalone embed components.
You can listen for certain form events using the onInit, onPageChange and onSubmit props. Each of these give the submission UUID as the first parameter, and the onPageChange prop gives the page ID as the second parameter.
`js
import { FilloutStandardEmbed } from "@fillout/react";
function App() {
return (
dynamicResize
onInit={(submissionUuid) => {
console.log(
User started filling out the form (submission ID: ${submissionUuid})${email} finished filling out the form
);
}}
onPageChange={(submissionUuid, pageId) => {
if (pageId === "qTcp") {
console.log("User is on the review step");
}
}}
onSubmit={async (submissionUuid) => {
const email = await doSomethingOnYourServer(submissionUuid);
console.log();
}}
/>
);
}
export default App;
`
This can be used in conjunction with the @fillout/api package on your server to get information about the structure of your form and to fetch field values once you have the submission UUID.
> ⚠️ The onPageChange may be triggered for any page on your form, including the starting page when the embed first loads. You should always check the page ID instead of making assumptions about where the user is in the form just because the function was triggered.
If you want to take advantage of features that are only available with forms hosted on your own domain, such as custom JS, you can use the domain prop to change the embedded url.
`js
import { FilloutFullScreenEmbed } from "@fillout/react";
function App() {
return (
);
}
export default App;
``