Download the PHP package solution-forest/filament-field-group without Composer

About Solution Forest

Solution Forest Web development agency based in Hong Kong. We help customers to solve their problems. We Love Open Soruces.

We have built a collection of best-in-class products:

• VantagoAds: A self manage Ads Server, Simplify Your Advertising Strategy.
• GatherPro.events: A Event Photos management tools, Streamline Your Event Photos.
• Website CMS Management: Website CMS Management - Filament CMS Plugin
• Filaletter: Filaletter - Filament Newsletter Plugin

Filament Field Group

Filament Field Group is a powerful Laravel package that enhances Filament's form building capabilities. It allows you to easily group and organize form fields, improving the structure and readability of your forms. With this package, you can create collapsible sections, tabs, or custom layouts for your form fields, making complex forms more manageable and user-friendly.

Installation

1. You can install the package via composer:

2. Register the plugin in your Panel provider

3. Then execute the following commands:

Publish Config, View, Translation and Migration

You can publish and run the migrations with:

You can publish the config file with:

Optionally, you can publish the views using

This is the contents of the published config file:

Usage

1. Add FilamentFieldGroupPlugin to you panel.
2. Enable the Field Group resource by setting enabled to true in the config file:

Or enable the plugin on FilamentFieldGroupPlugin

3. Create field groups and fields, for example:

   • Navigate to the Field Group resource in your Filament admin panel.
   • Create a new field group (e.g., "User Basic Info").
   • Add fields to the group (e.g., name, email, etc.).
4. Apply field groups to your form schema:

Available Components

Currently, this package provides the following components:

• Text
• TextArea
• Email
• Password
• Number
• Url
• Select
• Toggle
• Radio
• File
• Image
• Color Picker
• DateTime Picker

More components can be added in the future. Feel free to submit a pull request if you have ideas for additional components!

Advanced Usage

Custom Resources

You can call resources on FilamentFieldGroupPlugin to add/replace original resource:

Custom Field Types

You can add your own custom field types by following these steps:

1. Create a field type class that extends SolutionForest\FilamentFieldGroup\FieldTypes\Configs\FieldTypeBaseConfig
2. Implement the required methods, particularly getFormSchema() which defines the form fields
3. Register your custom field type using one of the methods below:

To completely replace all default field types, set the override parameter to true.

Customizing Field Type Config Form

You can customize the config form for specific field types by adding your own custom options. This is useful when you need to extend the functionality of existing field types with additional configuration parameters.

This allows you to modify the configuration form for field types while preserving all the default options.

Custom Models

You can set custom models for field groups and fields in your AppServiceProvider:

Field Type Mixins

You can extend field type functionality using the mixin method on FieldTypeBaseConfig. This allows you to reuse field configuration logic across different field types:

You can also apply mixins to specific field type classes:

This approach helps maintain DRY code by centralizing common field configurations that can be shared across multiple field types.

Testing

Changelog

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

Contributing

Please see CONTRIBUTING for details.

We welcome contributions to enhance this package. More components can potentially be added, so feel free to submit a pull request with your ideas or improvements.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• alan
• All Contributors

License

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