Flow Form Framework 5.0 Documentation

This documentation covering version 5.0 has been rendered at: May 16, 2023

Forms

The Form API is an extensible and flexible framework to build web forms.

It includes the following features:

• Ready-to-use standard form elements
• Creation of Multi-Step Forms
• Server- and Client-Side Validation
• highly flexible rendering of form elements, based on Fluid or any custom renderer
• Extensible with new form elements
• robust, object oriented API
• Integration into Neos Flow and Neos CMS

Also, there are some useful Related Packages that make use of the extension points and provide useful additions. For example there is the original Form YAML Builder that is a Flow based web application for graphically assembling and modifying forms:

Since version 5 there’s also a Neos Form Builder that adds these features and more to the Neos CMS Backend:

About This Documentation

This documentation contains a number of tutorial-style guides which will explain various aspects of the Form API and the Form Framework. It is not intended as in-depth reference, although there will be links to the in-depth API reference at various points.

• Quickstart
  • API Overview
  • Anatomy of a Form
  • Create your first form
  • Render a form
  • Validation
  • Finishers
  • Summary
  • Next Steps
• Configuring form rendering with YAML
  • Setup
  • Form configuration
  • File Uploads
• Adjusting Form Output
  • Presets Explained
  • Form Element Types Explained
  • Supertypes
  • Creating a Custom Preset
  • Adjusting a Form Element Template
  • Changing The Form Layout
  • Creating a New Form Element
• Translating Forms
  • Configuration
  • XLIFF files
  • Complete example
• Extending Form API
  • Custom PHP-based Form Elements
  • Custom Form Element Renderers

Credits

The initial implementation has been generously sponsored by AKOM360 - Multi Channel Marketing. Further work has been supported by internezzo ag - agentur für online-kommunikation and Format D GmbH

It has been implemented by:

• Sebastian Kurfürst, sandstorm|media
• Bastian Waidelich, wwwision