README
Payload Form Builder Plugin
A plugin for Payload CMS to easily allow your admin editors to build and manage forms from the admin panel.
Core features:
- Creates a
forms
collection where you can:- Build dynamic forms with any number of fields
- Add payment fields that can handle dynamic prices
- Build completely custom and dynamic emails
- Creates a
formSubmissions
collection that:- Validates and saves the form data submitted by your frontend
- Sends emails (if applicable)
- Handles payment processing (if applicable)
Installation
yarn add payload-plugin-form-builder
# OR
npm i payload-plugin-form-builder
Basic Usage
In the plugins
array of your Payload config, call the plugin with options:
import { buildConfig } from 'payload/config';
import formBuilder from 'payload-plugin-form-builder';
const config = buildConfig({
collections: [
{
slug: 'pages',
fields: []
}
],
plugins: [
formBuilder()
]
});
export default config;
Options
fields
An object of field types to allow your admin editors to build forms with. Pass either a boolean value or a partial Payload Block to override default settings. See Fields for more details.fields: { text: true, select: true, email: true, state: true, country: true, checkbox: true, number: true, message: true, payment: false }
You can also provide your own custom field definitions by passing a new Payload Block object into
fields
.redirectRelationships
An array of collection slugs that, when enabled, are populated as options in form redirect fields.
redirectRelationships: ['pages']
handlePayment
A beforeChange hook that is called upon form submissions. You can integrate into any third-party payment processing API here. There is a
getPaymentTotal
function that will calculate the total cost after all conditions have been applied.import { getPaymentTotal } from 'payload-plugin-form-builder'; ... handlePayment: async (beforeChangeData) => { // asynchronously process payments here const price = getPaymentTotal({ ...paymentField, // you can get this from somewhere in the beforeChangeData fieldValues: {}, // an object of kay:value pairs for every field in the form }); }
beforeEmail
A beforeChange hook that is called just after emails are prepared, but before they are sent. This is a great place to inject your own HTML template to add custom styles.
beforeEmails: (emailsToSend) => { // modify the emails in any way before they are sent return emails.map((email) => ({ ...email, html: email.html // transform the html in any way you'd like (maybe wrap it in an html template?) })) };
formOverrides
Override anything on the form collection by sending a Payload Collection Config.
formSubmissionOverrides: { slug: 'contact-forms' }
formSubmissionOverrides
By default, this plugin relies on Payload access control to restrict theupdate
andread
operations. This is because anyone should be able to create a form submission, even from a public-facing website - but no one should be able to update a submission one it has been created, or read a submission unless they have permission.You can verride access control and anything else on the form submission collection by sending a Payload Collection Config.
formSubmissionOverrides: { slug: 'leads' }
Fields
Each field is a Payload Block with the following fields:
- Text
name
: stringlabel
: stringdefaultValue
: stringwidth
: stringrequired
: checkbox
- Select
name
: stringlabel
: stringdefaultValue
: stringwidth
: stringoptions
: arrayrequired
: checkbox
- Email
name
: stringlabel
: stringdefaultValue
: stringwidth
: stringrequired
: checkbox
- State
name
: stringlabel
: stringdefaultValue
: stringwidth
: stringrequired
: checkbox
- Country
name
: stringlabel
: stringdefaultValue
: stringwidth
: stringrequired
: checkbox
- Checkbox
name
: stringlabel
: stringdefaultValue
: checkboxwidth
: stringrequired
: checkbox
- Number
name
: stringlabel
: stringdefaultValue
: numberwidth
: stringrequired
: checkbox
- Message
message
: richText
- Payment
name
: stringlabel
: stringdefaultValue
: numberwidth
: stringrequired
: checkboxpriceConditions
: arrayfieldToUse
: relationship, dynamically populated based on the fields in your formcondition
: string -equals
,notEquals
|hasValue
valueForOperator
: string - only ifcondition
isequals
ornotEquals
operator
: string -add
,subtract
,multiply
,divide
valueType
: string -static
,valueOfField
value
: string - only ifvalueType
isstatic
This plugin relies on the email configuration defined in your payload.init()
. It will read from your config and attempt to send your emails using the credentials provided.
TypeScript
All types can be directly imported:
import {
FormConfig,
Form,
FormSubmission,
FieldsConfig,
BeforePayment,
HandlePayment
} from 'payload-plugin-form-builder/dist/types';
Screenshots