Download the PHP package ffhs/filament-package_ffhs_custom_forms without Composer

CustomForms Overview

This plugin enables you to create and manage nested forms within FilamentPHP.
It provides a wide range of customizable form fields and supports behavioral rules and templates.

Features:

• ✅ Multiple Form Types: Bind forms to different use cases (e.g. entities) through customizable form types.
• 🧩 General Fields: Define general fields for exports and reusability across form types.
• 🛠 Configurable Field Types: Includes various fields like Repeaters to add additional inputs dynamically.
• 🤏 drag & drop Use an intuitive form builder.
• 🔁 Reactive Rules: Set up rules that react to answers by changing field visibility or modifying selectable options.
• 🌟 Prioritized Select Field: Use enhanced select fields with prioritized or sorted options.
• 📄 Template Snippets: Create reusable form templates to maximize reusability.
• 🧱 Custom Components: Easily embed CustomForms into your application using Filament components.
• 👁️ Multiple View Modes: Switch rendering styles based on where the form is used.
• 🔧 Extensible Architecture: Everything is designed to be customizable — add your own fields, rules, and templates.
• ⬇️ Import/Export: You can import and export custom forms directly from the UI..

Screenshots

Editor

Templates

Fill Form

View Form

Rule Editor

General Fields

Installation

Install the package via composer:

Publish and run the migrations:

Publish the config file with:

The CustomForm plugin needs Icon Picker Plugin You can publish the config file with:

Optionally, you can publish the views using

Usage

1. Register the Plugin

Add the plugin to your PanelProvider:

2. Overview

A CustomForm is composed of two main parts:

• CustomFormConfiguration – The blueprint that defines the forms behavior, fields, and validation rules.

• CustomFields – Dynamic fields rendered within the form.

3. CustomFormConfiguration

Define multiple form configurations to serve different purposes.
For example:

• A registration form with specific dependencies and validations.
• A survey form with its own layout and logic.

To define a new form, extend the CustomFormConfiguration class:

Key methods:

• identifier() – Uniquely links saved form entries to the corresponding configuration.
• displayName() – Shown in Filament’s form selection dropdown.

After creating a new configuration, register it in the ffhs_custom_forms config file:

Notes:

• Add each configuration class to the forms array.
• Run php artisan config:clear.

Features explained

✅ Form Configurations (FormTypes)

You can create different FormTypes, each with its own set of available FieldTypes and required GeneralFields. This allows you to customize forms for different application scenarios.

For example, you might have custom forms for requests and custom forms for applications. Now you can create two different FormTypes:

• One requires a general field for the study location
• The other does not include this field

This makes the form system flexible and reusable across various use cases.

Other functions to overwrite

CustomFields

A CustomField consists of:

• A FieldType – Defines the type and logic of the field (e.g. TextType, SelectType, etc.).
• A set of Options – Configuration values such as placeholder text, min/max values, selectable choices, etc.
• A FieldTypeView – Which can change on a different ViewMode

Predefined Field Types

📥 Input Fields

• TextType::class
• EmailType::class
• NumberType::class
• TextAreaType::class
• DateTimeType::class
• DateType::class
• DateRangeType::class
• FileUploadType::class

🔘 Choice Fields

• SelectType::class
• RadioType::class
• CheckboxListType::class
• ToggleButtonsType::class

✨ Special Fields

• TagsType::class
• KeyValueType::class
• ColorPickerType::class
• IconSelectType::class

📐 Layout Components

• SectionType::class
• FieldsetType::class
• GroupType::class
• TitleType::class
• TextLayoutType::class
• DownloadType::class
• ImageLayoutType::class
• SpaceType::class

Create your own CustomFieldType

Create your own reusable field type by implementing a CustomFieldType and a matching ViewComponent.

1. Define the Field Type Class

2. Register Type in Config

3. Define the FieldTypeView

Other Functions

These optional methods can be overridden in your custom CustomFieldType class to control behavior during field editing, rendering, saving, and cloning.

TypeOptions

The TypeOptions are options components which can add to a field-type to modify the components. The TypeOptions can automatically apply some effects if the return $input = $this->makeComponent(TextInput::class, $record); is used in the TypeView.

Predefined Type Option Classes

These classes define configurable TypeOptions used in CustomFormFields.

1. ActionLabelTypeOption.php
2. AlpineMaskOption.php
3. BooleanOption.php
4. ColumnsOption.php
5. ColumnSpanOption.php
6. DateFormatOption.php
7. HelperTextTypeOption.php
8. IconOption.php
9. ImaginaryTypeOption.php
10. InLineLabelOption.php
11. InlineOption.php
12. MaxAmountOption.php
13. MaxLengthOption.php
14. MaxSelectOption.php
15. MaxValueOption.php
16. MinAmountOption.php
17. MinLengthOption.php
18. MinSelectOption.php
19. MinValueOption.php
20. NewLineOption.php
21. RelatedFieldOption.php
22. ReorderableTypeOption.php
23. RequiredOption.php
24. ShowAsFieldsetOption.php
25. ShowInViewOption.php
26. ShowLabelOption.php
27. ValidationAttributeOption.php
28. ValidationMessageOption.php

Using TypeOptions in a CustomFieldType

You can add extra type options to your custom field by overriding extraTypeOptions() or generalTypeOptions():

• Each key represents the option name.
• The value is an instance of a TypeOption, usually created via ::make().
• You can customize how the option behaves using methods like modifyDefault() or modifyOptionComponent().

Creating a custom TypeOption

To create your own option, extend the TypeOption class:

Other optional functions

Use FastTypeOption

FastTypeOption allows you to quickly add custom options directly in your FieldType and react to them in your FieldTypeView.

OptionsGroups

OptionsGroups help organize multiple related TypeOptions into logical collections, making your field configuration cleaner and easier to manage.

In the image TypeOptions are marked red and the OptionGroups are marked blue.

How to use OptionGroups?

Rules: Events and Triggers

Rules can be divided into events and triggers. Triggers cause events to be executed. A rule can consist of multiple triggers that can be combined using 'AND' or 'OR' logic and can execute multiple events.

Predefined Events

• HideEvent
• VisibleEvent
• DisabledEvent
• RequiredEvent
• ChangeOptionsEvent

Predefined Triggers

• IsInfolistTrigger
• ValueEqualsRuleTrigger
• AlwaysRuleTrigger

Create own Trigger

1. Create an MyTrigger class

2. Add your trigger class in the config file:

Create own Event

1. Create an MyEvent class

2. Add your event class in the config file:

Embed CustomForms

You can embed CustomForms or their answers in various parts of your application using specialized components. Below are examples of usage patterns and customization options.

Editor

Embed the form editor in your layout using CustomFormEditor:

Form Answer Edit

Embed a form for editing its answer using EmbeddedCustomForm. Basic usage:

With automatic saving:

Split layout by section type:

Split layout by specific fields:

Split layout by pose (e.g. question number range):

View answer on an infolist

Embed a view for its answer using EmbeddedCustomForm.

Basic usage:

Split layout by section type:

Split layout by specific fields:

Split layout by pose (e.g. question number range):

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Postcards

We highly appreciate you sending us a postcard. You'll find our address on our page.

License

The MIT License (MIT). Please see License File for more information.