default

Is an output accessor.

value

For the HTML::FormFu::Element::Checkbox and HTML::FormFu::Element::Radio elements, "value" sets what the value of the field will be if it is checked or selected. If the "default" is the same as the "value", then the field will be checked or selected when rendered.

For the HTML::FormFu::Element::Radiogroup and HTML::FormFu::Element::Select elements, the "value" is ignored: values or options provides the equivalent function.

Is an output accessor.

non_param

Default Value: false

If true, values for this field are never returned by "params" in HTML::FormFu, "param" in HTML::FormFu and "valid" in HTML::FormFu.

This is useful for Submit buttons, when you only use its value as an indicator

placeholder

Is an output accessor.

javascript

If set, the contents will be rendered within a "script" tag, within the field's container.

retain_default

Default Value: "false"

force_default

If the default value is being changed after FormFu->process is being called the later default value is respected for rendering, *but* nevertheless the input value doesn't respect that, it will remain the first value.

Default Value: "false"

default_empty_value

Default Value: "false"

repeatable_count

The value is inherited from "repeatable_count" in HTML::FormFu::Element::Repeatable.

clone

deflators

deflator

auto_datalist_id

If any Input element had a datalist, but does not have "datalist_id" in HTML::FormFu::Role::Element::Input set, "auto_datalist_id" is used to generate the datalist id.

The following character substitution will be performed: %f will be replaced by $form->id, %n will be replaced by $field->name, %r will be replaced by $block->repeatable_count.

Is an inheriting accessor.

filters

filter

constraints

constraint

inflators

inflator

validators

validator

transformers

transformer

CONTAINER

Default value: 'div'

The container wrapping each entire field, any label, comment, and errors.

container_attributes

Attributes added to the container tag.

Is an attribute accessor.

auto_container_class

Default Value: '%t'

If set, then the container of each field will be given a class-name based on the given pattern.

Supports substitutions: %f, %n, %t.

Is an inheriting accessor.

auto_container_label_class

Default Value: 'label'

If set, and if the field has a label, the container will be given a class-name based on the given pattern.

Supports substitutions: %f, %n, %t.

Is an inheriting accessor.

auto_container_comment_class

Default Value: '%t'

If set, and if the field has a comment, the container will be given a class-name based on the given pattern.

Supports substitutions: %f, %n, %t.

Is an inheriting accessor.

auto_container_error_class

Default Value: 'error'

If set, then the container of each field with an error will be given a class-name based on the given pattern.

Supports substitutions: %f, %n.

Is an inheriting accessor.

auto_container_per_error_class

Default Value: 'error_%s_%t'

If set, then the container of each field with an error will be given a class-name based on the given pattern.

Supports substitutions: %f, %n, %t, %s.

Is an inheriting accessor.

FORM FIELD

If set, then the field will be given an id attribute, if it doesn't have one already.

E.g., setting "$form->auto_id('%n')" will make each field have an ID the same as the field's name. This makes our form config simpler, and ensures we don't need to manually update IDs if any field names are changed.

Supports substitutions: %f, %n, %r.

Is an inheriting accessor.

LABEL

Set a label to communicate the purpose of the form-field to the user.

Is an output accessor.

auto_label

If label isn't already set, the value of "auto_label" is passed through localize to generate a label.

Supports substitutions: %f, %n.

The generated string will be passed to "localize" to create the label.

Is an inheriting accessor.

label_tag

Default value: 'label' (except Checkboxgroup)

Default value: 'legend' (only Checkboxgroup)

Set which tag is used to wrap a label.

Is an inheriting accessor.

label_attributes

Attributes added to the label container.

Is an attribute accessor.

COMMENT

Set a comment to be displayed along with the form-field.

Is an output accessor.

comment_attributes

Attributes added to the comment container.

Is an attribute accessor.

auto_comment_class

Default Value: '%t'

If set, and if the field has a comment, the comment tag will be given a class-name based on the given pattern.

Supports substitutions: %f, %n, %t.

Is an inheriting accessor.

ERROR CONTAINER

If set, and if the field has any errors, a container of this type is wrapped around all of the field error messages.

    # Example - this would wrap each individual error in a 'li' tag,
    # with a single 'ul' tag wrapped around all the errors.

    element:
      name: foo
      error_container_tag: ul
      error_tag: li

Is an inheriting accessor.

error_container_attributes

Set attributes on the container-tag, if "error_container_tag" is set.

Is an attribute accessor.

auto_error_container_class

Add a class-name to the error container.

Supports substitutions: %f, %n.

Is an inheriting accessor.

auto_error_container_per_error_class

Add a class-name to the error container for each error on that field.

Supports substitutions: %f, %n, %t, %s.

Is an inheriting accessor.

ERROR MESSAGES

Default value: 'span'

Sets the tag used to wrap each individual error message.

Defaults to "span".

Is an inheriting accessor.

auto_error_message

Default Value: 'form_%s_%t'

If set, then each error will be given an auto-generated message, if it doesn't have one already.

The generated string will be passed to "localize" to create the message.

For example, a Required constraint will return the string "form_constraint_required". Under the default localization behaviour, the appropriate message for "form_constraint_required" will be used from the default I18N package.

Supports substitutions: %f, %n, %t, %s.

Is an inheriting accessor.

error_attributes

Set attributes on the tag of each error message.

Is an attribute accessor.

auto_error_field_class

Upon error, add a class name firectly to the field tag (e.g. "input", "select" tag).

Supports substitutions: %f, %n.

auto_error_class

Default Value: 'error_%s_%t'

Add a class-name to the tag of each error message.

Supports substitutions: %f, %n, %t, %s.

Is an inheriting accessor.

PROCESSOR CLASSES

Add a class-name to the container tag, for each constraint added to the field.

Supports substitutions: %f, %n, %t.

Is an inheriting accessor.

auto_inflator_class

Add a class-name to the container tag, for each inflator added to the field.

Supports substitutions: %f, %n, %t.

Is an inheriting accessor.

auto_validator_class

Add a class-name to the container tag, for each validator added to the field.

Supports substitutions: %f, %n, %t.

Is an inheriting accessor.

auto_transformer_class

Add a class-name to the container tag, for each transformer added to the field.

Supports substitutions: %f, %n, %t.

Is an inheriting accessor.

REORDERING FIELD COMPONENTS

layout

    # Default Value
    $element->layout( [
        'errors',
        'label',
        'field',
        'comment',
        'javascript',
    ] );

Example: Move the form field (the input tag or equivalent) inside the label tag, after the label text. Remove the comment - this will now never be rendered.

    # YAML config
    layout:
      - errors
      - label:
          - label_text
          - field
      - javascript

    # prettified example of rendered markup
    <div>
        <span>This field is required.</span>
        <label>
            Foo
            <input name="foo" type="text" />
        </label>
    </div>

Example: Don't wrap the label text inside it's usual tag. Insert the form field (the input tag or equivalent) inside an arbitrary extra tag.

    # YAML config
    layout:
      - errors
      - label_text
      -
        div:
          attributes:
            class: xxx
          content: field
      - comment
      - javascript

    # prettified example of rendered markup
    <div>
        <span>This field is required.</span>
        Foo
        <div class="xxx">
            <input name="foo" type="text" />
        </div>
    </div>

The following elements override the default layout value:

HTML::FormFu::Element::Checkboxgroup

HTML::FormFu::Element::Hidden

Specification

The layout method accepts an array-ref, hash-ref, or string argument.

The processing is recursive, so each item in an array-ref may be any value accepted by the layout method.

A hash-ref must contain a single key and value pair. If the hash key is the string "label", it creates a "label" tag, using any previously defined LABEL customizations. This allows the label tag to contains other elements, such as the form field.

All other hash key values are asssumed to be an arbitrary block tag name. The value must be a hash-ref, and may contain one or both "attributes" or "content" keys.

Any "attributes" value must be a hash-ref, whose key/values are added to the block tag. No processing or expansion is done to the "attributes" hash-ref at all.

The "content" value may be anything accepted by the layout method.

The following strings are accepted:

errors

Renders the element error messages.

See ERROR CONTAINER and ERROR MESSAGES to customize the tags and attributes.

label

Renders the element label.

See LABEL to customize the tag and attributes.

label_text

Renders the element label text, without the usual label_tag.

field

Renders the form field control (an input tag, button, or other control).

comment

Renders the element comment.

See COMMENT to customize the tag and attributes.

javascript

Renders a "script" tag containing any javascript.

multi_layout

    # Default Value
    $element->multi_layout( [
        'label',
        'field',
    ] );

Example: Swap the label/field order. This is equivalent to the now-deprecated reverse_multi method.

    # YAML config
    multi_layout:
      - field
      - label

The following elements override the default "multi_layout" value:

HTML::FormFu::Element::Checkbox

field_filename

Must be set by more specific field classes.

label_filename

Defaults to "label".

get_errors

add_error

clear_errors

get_deflators

get_deflator

get_filters

get_filter

get_constraints

get_constraint

get_inflators

get_inflator

get_validators

get_validator

get_transformers

get_transformer

get_errors

clear_errors