API Reference

Installation

npm install formtress-js

Current version: 0.1.17

submitForm(options)

Submits form data to the Formtress endpoint.

import { submitForm } from 'formtress-js'

const result = await submitForm({
  formId: 'your-form-id',
  data: new FormData(formElement),
})

Parameters

Name	Type	Required	Description
options	object	Yes	Submission options.
options.formId	string	Yes	The Form ID from your Formtress dashboard.
options.data	FormData	Yes	A FormData instance containing the fields to submit.

Return value

Returns Promise<SubmitResult>.

interface SubmitResult {
  ok: boolean
  message?: string
}

Field	Type	Description
ok	boolean	true if the submission was accepted and passed validation.
message	string | undefined	Error message from the server. Only present when ok is false.

Webflow script

The Webflow script is a pre-built integration that requires no JavaScript on your part.

CDN URL

https://cdn.jsdelivr.net/npm/formtress-js@0.1.17/dist/js/webflow.js

Behavior

1. On DOMContentLoaded, finds all <form> elements with a data-ft attribute.
2. Attaches a submit handler to each form.
3. Prevents the default form action.
4. Collects form data and sends it to the Formtress endpoint.
5. On success: triggers Webflow’s native success state.
6. On error: triggers Webflow’s error state and updates any data-ft-error element.

Pinning a version

Always pin to a specific version in production:

<script src="https://cdn.jsdelivr.net/npm/formtress-js@0.1.17/dist/js/webflow.js"></script>

To get the latest version automatically (not recommended for production):

<script src="https://cdn.jsdelivr.net/npm/formtress-js@latest/dist/js/webflow.js"></script>