README

Form builder for Preflow. Renders fields with labels, errors, and help text from a simple template API. Binds to models, reads #[Validate] attributes for type inference and required detection, and auto-enhances forms with inline validation when a hypermedia driver is active.

Installation

composer require preflow/form

Requires preflow/validation and preflow/view. Optionally integrates with preflow/data (model binding) and preflow/htmx (inline validation).

Quick Start

Plain form (no model)

{% set form = form_begin({action: '/contact', csrf_token: csrf_token()}) %}
{{ form.begin()|raw }}
    {{ form.field('name')|raw }}
    {{ form.field('email', {type: 'email'})|raw }}
    {{ form.field('message', {type: 'textarea'})|raw }}
    {{ form.submit('Send')|raw }}
{{ form_end()|raw }}

Model-bound form (inside a component)

{% set form = form_begin({model: game, errorBag: errors}) %}
<form {{ hd.post('save', componentClass, componentId, props)|raw }}>
    {{ form.field('name')|raw }}
    {{ form.select('status', {options: {draft: 'Draft', published: 'Published'}})|raw }}
    {{ form.field('description', {type: 'textarea'})|raw }}
    {{ form.submit('Save')|raw }}
</form>

The form builder reads #[Validate] attributes from the model to infer input types (email rule = type="email"), detect required fields, and populate select options from in: rules.

Field Methods

Method	Description
`form.field(name, options)`	Text, email, password, number, date, url, tel, hidden
`form.select(name, options)`	Dropdown with `options` map
`form.checkbox(name, options)`	Single checkbox
`form.radio(name, options)`	Radio group
`form.file(name, options)`	File upload input
`form.hidden(name, value)`	Hidden input (no label/wrapper)
`form.submit(label, options)`	Submit button

Field Options

Option	Description
`type`	Input type (auto-inferred from model rules if bound)
`label`	Label text (auto-generated from field name if omitted)
`value`	Field value (falls back to old input, then model property)
`required`	Required indicator (auto-detected from `required` rule)
`help`	Help text below the field
`errors`	Error messages (auto-populated from ErrorBag)
`attrs`	Raw HTML attributes passed to the input (escape hatch)
`width`	Width hint for use inside groups (`'1/3'`, `'2/3'`)
`options`	Key-value map for select/radio fields

Field Groups

Group fields for side-by-side layout:

{{ form.group({class: 'form-row', label: 'Address'})|raw }}
    {{ form.field('zip', {width: '1/3'})|raw }}
    {{ form.field('city', {width: '2/3'})|raw }}
{{ form.endGroup()|raw }}

Auto-Generation

Generate fields from model #[Validate] attributes:

{# All validated fields #}
{{ form.fields()|raw }}

{# Cherry-pick #}
{{ form.fields({only: ['name', 'email']})|raw }}

{# Exclude #}
{{ form.fields({except: ['password_hash', 'created_at']})|raw }}

{# Override specific fields #}
{{ form.fields({only: ['name', 'email', 'role'], override: {role: {type: 'select', options: roles}}})|raw }}

Validation Scenarios

Override rules per form for create/update differences:

{% set form = form_begin({
    model: user,
    rules: isEdit
        ? {password: ['nullable', 'min:8']}
        : {password: ['required', 'min:8']}
}) %}

Or use on: directives on the model:

#[Validate('required', 'min:8', 'on:create')]
#[Validate('nullable', 'min:8', 'on:update')]
public string $password = '';

{% set form = form_begin({model: user, scenario: 'create'}) %}

Hypermedia Integration

When inside a component with a hypermedia driver active, the form builder can auto-add inline validation attributes. The attrs escape hatch lets you pass any driver-specific attributes:

{{ form.field('email', {
    attrs: {
        'hx-post': validateUrl,
        'hx-trigger': 'blur delay:300ms',
        'hx-target': 'closest .form-group',
        'hx-swap': 'outerHTML'
    }
})|raw }}

License

MIT

preflow / form

Maintainers

Package info

Statistics

Security