Custom Fields for Filament

https://github.com/aureuserp/custom-fields
Admin
A Filament v5 plugin that enables end-users to add dynamic custom fields to any Eloquent model and...
Tokens:64,826
Snippets:488
Trust Score:7.2
License:MIT
Update:5 days ago
Show doc for...
Tokens:
Raw
### Config file example

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Example configuration file for app-wide defaults. Contains navigation and resource settings. The 'register' key controls whether the admin CRUD is enabled.

```php
// config/custom-fields.php
return [
    'navigation' => [
        'label'   => 'Custom Fields',
        'group'   => 'Settings',
        'icon'    => 'heroicon-o-puzzle-piece',
        'sort'    => 50,
        'badge'   => null,
        'register'=> true,
    ],
    'resource' => [
        'register'           => true,
        'slug'               => 'admin/custom-fields',
        'cluster'            => \App\Filament\Clusters\AdminTools::class,
        'model_label'        => null,
        'plural_model_label' => null,
    ],
];
```

--------------------------------

### Employee model with HasCustomFields and usage example

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Eloquent model using the trait, plus a usage example showing automatic fillable and casting for custom fields.

```php
use Webkul\CustomFields\Concerns\HasCustomFields;

class Employee extends Model
{
    use HasCustomFields;

    protected $fillable = ['name', 'department_id'];
}

// After an admin defines a "hobbies" checkbox_list field:
$employee = Employee::create([
    'name' => 'Alice',
    'department_id' => 1,
    'hobbies' => ['chess', 'hiking'],  // ← custom field, automatically fillable + cast to array
]);

$employee->hobbies;  // ['chess', 'hiking']  ← automatically cast from JSON
```

--------------------------------

### Composer install command

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/README.md

Install the package via Composer. The package is auto-discovered and its migration runs on `php artisan migrate`.

```bash
composer require aureuserp/custom-fields
```

--------------------------------

### With include/exclude

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-columns.md

Example showing include and exclude usage together.

```php
$columns = CustomColumns::make(EmployeeResource::class)
    ->include(['hobbies'])            // only the hobbies column
    ->exclude(['salary'])             // never expose salary
    ->getColumns();
```

--------------------------------

### Standalone component usage with include/exclude

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Each injector component can be used standalone. The example shows CustomFields::make() with include and exclude lists, then getSchema() to retrieve the schema.

```php
use Webkul\CustomFields\Filament\Forms\Components\CustomFields;
use Webkul\CustomFields\Filament\Infolists\Components\CustomEntries;
use Webkul\CustomFields\Filament\Tables\Columns\CustomColumns;
use Webkul\CustomFields\Filament\Tables\Filters\CustomFilters;

CustomFields::make(MyResource::class)
    ->include(['hobbies'])
    ->exclude(['internal_notes'])
    ->getSchema();
```

--------------------------------

### Fluent setters in panel provider

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Configures the plugin via fluent setters in the Filament panel provider. Recommended for per-panel overrides. The example shows setting navigation group, label, icon, sort, badge, badge color, slug, and cluster.

```php
// app/Providers/Filament/AdminPanelProvider.php
use Webkul\CustomFields\CustomFieldsPlugin;

->plugins([
    CustomFieldsPlugin::make()
        ->navigationGroup(__('admin.navigation.setting'))
        ->navigationLabel('Custom Fields')
        ->navigationIcon('heroicon-o-puzzle-piece')
        ->navigationSort(50)
        ->navigationBadge(fn () => \Webkul\CustomFields\Models\Field::count())
        ->navigationBadgeColor('primary')
        ->slug('admin/custom-fields')
        ->cluster(\App\Filament\Clusters\AdminTools::class),
])
```

--------------------------------

### Combining with base columns manually

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-columns.md

Example merging CustomColumns output with manually defined base columns.

```php
$allColumns = array_merge(
    [TextColumn::make('name'), TextColumn::make('department')],
    CustomColumns::make(EmployeeResource::class)->getColumns()
);
```

--------------------------------

### Example: safe invocation when the host table may not exist

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-column-manager.md

Shows calling createColumn on a field that may not have a table yet; it is a no-op if the table or column already exists. Then checks if the column exists.

```php
$field = Field::findOrFail($id);

CustomFieldsColumnManager::createColumn($field); // no-op if the table or column already exists

if (Schema::hasColumn(app($field->customizable_type)->getTable(), $field->code)) {
    // column exists
}
```

--------------------------------

### Example: creating a column manually after programmatically creating a field

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-column-manager.md

Shows how to create a custom field and then call createColumn to add the database column. The comment shows the resulting ALTER TABLE statement.

```php
use Webkul\CustomFields\CustomFieldsColumnManager;
use Webkul\CustomFields\Models\Field;

$field = Field::create([
    'name' => 'Hobbies',
    'code' => 'hobbies',
    'type' => 'checkbox_list',
    'customizable_type' => \App\Models\Employee::class,
    'use_in_table' => false,
]);

CustomFieldsColumnManager::createColumn($field);
// ALTER TABLE employees ADD hobbies json NULL
```

--------------------------------

### App-wide config defaults for custom-fields.php

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/configuration.md

Set default configuration values in config/custom-fields.php. Used when fluent setter is not provided. Example disables the admin CRUD resource app-wide.

```php
// config/custom-fields.php
return [
    'resource' => [
        'register' => false,   // disable the admin CRUD app-wide
    ],
];
```

--------------------------------

### Lazy closure resolution example

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Shows how closures passed to setters are resolved lazily at read time, allowing dynamic values like live counts. The getNavigationBadge() call returns the current count at that moment.

```php
$plugin = CustomFieldsPlugin::get();

$plugin->navigationBadge(fn () => Field::count().' fields');

echo $plugin->getNavigationBadge(); // "12 fields" at read time
```

--------------------------------

### static get(): static

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Returns the plugin via `filament('custom-fields')` if a Filament application context exists; otherwise falls back to the container instance.

```APIDOC
## static get(): static

### Description
Returns the plugin via `filament('custom-fields')` if a Filament application context exists. If any `\Throwable` is raised (e.g. outside of a Filament request lifecycle), it falls back to `app(static::class)`. This is the method used internally by `FieldResource::plugin()` so that the resource always reads configuration from the same instance.

### Method
`static get(): static`

### Return Value
- **static** - The plugin instance, retrieved from the current Filament panel when available, otherwise from the container.

```

--------------------------------

### options array example

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/types.md

Plain string array used for select, radio, and checkbox_list field types. Consumed by CustomFields::createField(), CustomFilters::createFilter(), and CustomFilters::createConstraint().

```php
['chess', 'hiking', 'reading']
```

--------------------------------

### mergeFillable usage example

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/concerns-has-custom-fields-eloquent.md

Merges codes into $this->fillable without duplicates: array_unique(array_merge($this->fillable, $attributes)). The example shows deduplication and the resulting fillable array.

```php
$model = new Employee;

$model->mergeFillable(['hobbies', 'nickname']);
$model->mergeFillable(['nickname']); // deduplicated — nickname appears once

$model->getFillable(); // contains 'name', 'department_id', 'hobbies', 'nickname'
```

--------------------------------

### Register CustomFieldsPlugin with navigation settings in Filament panel provider

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Pass the plugin to a panel's ->plugins([...]) method. The example sets the navigation group to 'Settings' and the navigation icon to 'heroicon-o-puzzle-piece'.

```php
use Webkul\CustomFields\CustomFieldsPlugin;

->plugins([
    CustomFieldsPlugin::make()
        ->navigationGroup('Settings')
        ->navigationIcon('heroicon-o-puzzle-piece'),
])
```

--------------------------------

### Override getCustomFields() for multi-tenant filtering

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/concerns-has-custom-fields-eloquent.md

Example of overriding getCustomFields() to add tenant scoping. Calls parent and adds a where clause on tenant_id.

```php
class Employee extends Model
{
    use HasCustomFields;

    protected function getCustomFields()
    {
        return parent::getCustomFields()->where('tenant_id', $this->tenant_id);
    }
}
```

--------------------------------

### static get() method implementation

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Returns the plugin via filament('custom-fields') if a Filament application context exists; otherwise falls back to app(static::class). Used internally by FieldResource::plugin().

```php
public static function get(): static
{
    try {
        return filament(app(static::class)->getId());
    } catch (\Throwable) {
        return app(static::class);
    }
}
```

--------------------------------

### table_settings array example

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/types.md

List of {setting, value?} maps applied to table columns and used for filter gating. Applied by CustomColumns::applySetting(). CustomFilters::getFields() requires whereJsonContains('table_settings', ['setting' => 'filterable']).

```php
[
    ['setting' => 'sortable'],
    ['setting' => 'filterable'],   // presence enables CustomFilters inclusion
    ['setting' => 'alignment', 'value' => 'left'],
    ['setting' => 'weight', 'value' => 'Bold'],   // resolved to Filament FontWeight enum case
]
```

--------------------------------

### Example: updating a field and ensuring the column exists

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-column-manager.md

Shows updating a field's name and then calling updateColumn to ensure the column still exists. The comment notes it ensures employees.hobbies still exists.

```php
$field = Field::findOrFail($id);
$field->update(['name' => 'Renamed label']);

CustomFieldsColumnManager::updateColumn($field); // ensures employees.hobbies still exists
```

--------------------------------

### Example: deleting a column for a force-deleted field

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-column-manager.md

Shows calling deleteColumn on a trashed field to drop the database column. The comment shows the resulting ALTER TABLE statement.

```php
use Webkul\CustomFields\CustomFieldsColumnManager;

$field = Field::withTrashed()->findOrFail($id);

CustomFieldsColumnManager::deleteColumn($field); // ALTER TABLE employees DROP COLUMN hobbies
```

--------------------------------

### Standalone use in a table definition

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-columns.md

Example of using CustomColumns in a Filament resource's table() method.

```php
use Filament\Tables\Table;
use Webkul\CustomFields\Filament\Tables\Columns\CustomColumns;

public static function table(Table $table): Table
{
    return $table->columns(CustomColumns::make(static::class)->getColumns());
}
```

--------------------------------

### form_settings array example

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/types.md

Persisted state of the Form Settings section. Contains 'validations' and 'settings' keys. CustomFields::applyValidation() and applySetting() invoke component methods with 0, 1, or 2 arguments depending on presence of 'field'/'value'.

```php
[
    'validations' => [
        ['validation' => 'required'],                        // rule name (component method)
        ['validation' => 'requiredIf', 'field' => 'x', 'value' => 'y'],
        ['validation' => 'minLength', 'value' => '2'],
    ],
    'settings' => [
        ['setting' => 'placeholder', 'value' => 'Type here…'],
        ['setting' => 'autofocus'],
    ],
]
```

--------------------------------

### CustomFields::make() usage example

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-fields.md

Builds a Filament form schema from custom field definitions for a given resource. Use include() and exclude() to filter fields, then getSchema() to retrieve the schema array.

```php
use Webkul\CustomFields\Filament\Forms\Components\CustomFields;

$schema = CustomFields::make(EmployeeResource::class)
    ->include(['hobbies'])
    ->exclude(['internal_notes'])
    ->getSchema();
```

--------------------------------

### Run migrations

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Run the package migrations. The migration is registered via Spatie's package-tools and executed on `php artisan migrate`.

```bash
php artisan migrate
```

--------------------------------

### Publish package resources

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Run these artisan commands to publish the package's config, migrations, and translations. Each command publishes a specific tag.

```bash
php artisan vendor:publish --tag="custom-fields-config"
```

```bash
php artisan vendor:publish --tag="custom-fields-migrations"
```

```bash
php artisan vendor:publish --tag="custom-fields-translations"
```

--------------------------------

### boot(Panel $panel): void

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Empty hook; the plugin performs no boot-time work.

```APIDOC
## boot(Panel $panel): void

### Description
Empty hook; the plugin performs no boot-time work.

### Method
`boot(Panel $panel): void`

### Parameters
- **$panel** (Filament\Panel) - Required - The Filament panel being booted.

### Return Value
- **void** - No return value.

```

--------------------------------

### boot(Panel $panel) method signature

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Empty hook; the plugin performs no boot-time work.

```php
public function boot(Panel $panel): void
```

--------------------------------

### Publish config file with artisan vendor:publish

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/configuration.md

Run this command to publish the package configuration file to config/custom-fields.php.

```bash
php artisan vendor:publish --tag="custom-fields-config"
```

--------------------------------

### configurePackage method

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/service-provider.md

Configures the package: registers config files, translations, and a migration. The migration runs automatically on 'php artisan migrate'.

```php
public function configurePackage(Package $package): void
{
    $package
        ->name(static::$name)
        ->hasConfigFile(['custom-fields', 'filament-shield'])
        ->hasTranslations()
        ->hasMigration('2024_11_13_052541_create_custom_fields_table')
        ->runsMigrations();
}
```

--------------------------------

### Protected applySetting() method signature

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-entries.md

Applies a single setting to an entry. Only runs when method_exists($column, $name). Special handling for 'weight' and 'size' enum values; otherwise calls the method with or without a value.

```php
protected function applySetting(Entry $column, array $setting): void
```

--------------------------------

### applySetting() method

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-columns.md

Applies a single table setting to a column. Only runs when the method exists on the column. 'weight' values resolve against FontWeight cases, 'size' against TextSize cases via constant().

```php
protected function applySetting(Column $column, array $setting): void
```

--------------------------------

### Run tests and code style checks

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Commands to run before submitting a PR. Executes Pest feature tests and Pint code style checks for the plugin.

```bash
vendor/bin/pest plugins/aureuserp/custom-fields/tests/Feature
vendor/bin/pint plugins/aureuserp/custom-fields
```

--------------------------------

### Constructor and make() factory

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-columns.md

The constructor takes a fully-qualified Filament Resource class. The make() factory creates a configured component instance.

```php
final public function __construct(string $resource)
```

```php
public static function make(string $resource): static
{
    $static = app(static::class, ['resource' => $resource]);

    $static->configure();

    return $static;
}
```

--------------------------------

### Constructor and factory: __construct and make

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-filters.md

The constructor takes a fully-qualified Filament Resource class. The static make() method resolves the class from the container, configures it, and returns the instance.

```php
final public function __construct(string $resource)

public static function make(string $resource): static
{
    $static = app(static::class, ['resource' => $resource]);

    $static->configure();

    return $static;
}
```

--------------------------------

### Run feature tests

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Executes the package's feature tests using Pest. The test suite contains 31 tests and 114 assertions.

```bash
vendor/bin/pest plugins/aureuserp/custom-fields/tests/Feature
```

--------------------------------

### Public method signatures: include(), exclude(), getSchema()

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-entries.md

Lists the public methods available on CustomEntries. include() and exclude() set whitelist/blacklist field codes and return $this; getSchema() returns an array of infolist entries ordered by sort ascending.

```php
public function include(array $fields): static
public function exclude(array $fields): static
public function getSchema(): array
```

--------------------------------

### Generate Shield policies

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Generates Shield policies for the FieldResource when the policy denies everything.

```bash
php artisan shield:generate --resource=FieldResource
```

--------------------------------

### With include/exclude and settings-driven entries

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-entries.md

Creates entries with both include and exclude filters, returning the schema array.

```php
$entries = CustomEntries::make(EmployeeResource::class)
    ->include(['hobbies'])
    ->exclude(['internal_notes'])
    ->getSchema();
```

--------------------------------

### CustomEntries::make() with include() and getSchema()

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-entries.md

Creates a CustomEntries instance for a Filament resource, includes only the 'hobbies' field, and returns the infolist schema array.

```php
use Webkul\CustomFields\Filament\Infolists\Components\CustomEntries;

$entries = CustomEntries::make(EmployeeResource::class)
    ->include(['hobbies'])
    ->getSchema();
```

--------------------------------

### static make() method implementation

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Resolves the plugin from the Laravel container. Because the class is registered as a singleton, repeated calls return the same instance.

```php
public static function make(): static
{
    return app(static::class);
}
```

--------------------------------

### Protected createEntry() method signature

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-entries.md

Maps a Field's type to a Filament infolist entry class. Each entry is created with ::make($field->code)->label($field->name) and then all infolist_settings are applied via applySetting().

```php
protected function createEntry(Field $field): Component
```

--------------------------------

### Fix class not found error

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Run these commands to clear the autoload cache and optimize the application when encountering 'Class not found' for Webkul\CustomFields\….

```bash
composer dump-autoload && php artisan optimize:clear
```

--------------------------------

### Default config/custom-fields.php content

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/configuration.md

Full default configuration for the custom-fields package, including navigation and resource settings. Adjust values as needed; defaults are shown.

```php
return [

    'navigation' => [

        'label' => null,                      // fallback: translated navigation.title
        'group' => null,                      // fallback: translated navigation.group
        'icon' => 'heroicon-o-puzzle-piece',
        'active_icon' => null,
        'sort' => 5,
        'badge' => null,
        'badge_color' => null,
        'badge_tooltip' => null,
        'parent_item' => null,
        'sub_position' => null,
        'register' => true,

    ],

    'resource' => [

        'register' => true,
        'slug' => 'fields',
        'cluster' => null,
        'model_label' => null,
        'plural_model_label' => null,
        'tenant_relationship' => null,

    ],

];
```

--------------------------------

### Standalone use inside an infolist schema

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-entries.md

Shows how to use CustomEntries::make(static::class)->getSchema() inside a Filament infolist() method to build the schema.

```php
use Filament\Infolists\Infolist;
use Webkul\CustomFields\Filament\Infolists\Components\CustomEntries;

public static function infolist(Infolist $infolist): Infolist
{
    return $infolist->schema(
        CustomEntries::make(static::class)->getSchema()
    );
}
```

--------------------------------

### CustomEntries::make()

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-entries.md

Factory method to create a new CustomEntries component instance. Resolves the class from the container and configures it.

```APIDOC
## CustomEntries::make()

### Description
Factory method to create a new CustomEntries component instance. Resolves the class from the container and configures it.

### Method
`public static function make(string $resource): static`

### Parameters
- **$resource** (string) - Required - Fully-qualified Filament Resource class

### Return
- **static** - A configured component instance

### Example
```php
$entries = CustomEntries::make(EmployeeResource::class);
```
```

--------------------------------

### Per-panel fluent overrides for CustomFieldsPlugin

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/configuration.md

Configure the plugin per Filament panel using fluent setters. Highest priority in resolution order. Sets navigation group, label, icon, sort, badge, slug, and cluster.

```php
->plugins([
    \Webkul\CustomFields\CustomFieldsPlugin::make()
        ->navigationGroup(__('admin.navigation.setting'))
        ->navigationLabel('Custom Fields')
        ->navigationIcon('heroicon-o-puzzle-piece')
        ->navigationSort(50)
        ->navigationBadge(fn () => \Webkul\CustomFields\Models\Field::count())
        ->navigationBadgeColor('primary')
        ->slug('admin/custom-fields')
        ->cluster(\App\Filament\Clusters\AdminTools::class),
])
```

--------------------------------

### CustomEntries::make(MyResource::class)->include(['hobbies'])->exclude(['internal_notes'])->getSchema()

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Standalone usage of the CustomEntries component to generate an infolist schema for a resource. Accepts include/exclude lists to filter custom fields.

```APIDOC
## CustomEntries::make(MyResource::class)->include(['hobbies'])->exclude(['internal_notes'])->getSchema()

### Description
Standalone usage of the CustomEntries component to generate an infolist schema for a resource. Accepts include/exclude lists to filter custom fields.

### Method
make

### Parameters
- **$resource** (class-string) - Required - The resource class.
- **include** (array) - Optional - List of field codes to include (empty means all).
- **exclude** (array) - Optional - List of field codes to exclude.

### Return Value
- (Schema) - The generated schema.
```

--------------------------------

### static make(): static

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Resolves the plugin from the Laravel container. Because the class is registered as a singleton, repeated calls return the same instance.

```APIDOC
## static make(): static

### Description
Resolves the plugin from the Laravel container. Because the class is registered as a singleton in `packageRegistered()`, repeated `make()` calls return the same instance.

### Method
`static make(): static`

### Return Value
- **static** - The singleton `CustomFieldsPlugin` instance from the container.

```

--------------------------------

### Import FieldResource

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/field-resource.md

Import the FieldResource class from the Webkul\CustomFields\Filament\Resources namespace.

```php
use Webkul\CustomFields\Filament\Resources\FieldResource;
```

--------------------------------

### Filament resource trait helper signatures

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Five static helpers on the Filament resource trait accept a base array plus optional include/exclude lists and return base plus custom fields. Include empty means all fields; non-empty whitelists codes; exclude blacklists codes.

```php
static::mergeCustomFormFields(array $base, array $include = [], array $exclude = []): array
static::mergeCustomTableColumns(array $base, array $include = [], array $exclude = []): array
static::mergeCustomTableFilters(array $base, array $include = [], array $exclude = []): array
static::mergeCustomTableQueryBuilderConstraints(array $base, array $include = [], array $exclude = []): array
static::mergeCustomInfolistEntries(array $base, array $include = [], array $exclude = []): array
```

--------------------------------

### Enum fallback with FieldType and InputType

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Uses tryFrom with a fallback to the default enum case for symbolic-constant handling.

```php
use Webkul\CustomFields\Enums\FieldType;
use Webkul\CustomFields\Enums\InputType;

$type = FieldType::tryFrom($raw) ?? FieldType::default();
```

--------------------------------

### plugin() method

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/field-resource.md

Returns the CustomFieldsPlugin singleton instance, used by all navigation and identity getters.

```php
protected static function plugin(): CustomFieldsPlugin
{
    return CustomFieldsPlugin::get();
}
```

--------------------------------

### Module graph

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/README.md

Shows the package's source file structure and their roles. This is a text diagram, not executable code.

```text
src/CustomFieldsServiceProvider.php          → bootstraps package; singleton plugin; CSS asset
src/CustomFieldsPlugin.php                   → Filament Plugin entry point; uses HasPluginConfiguration
src/Concerns/HasPluginConfiguration.php      → fluent navigation/identity config trait (17 setters + 17 getters)
src/CustomFieldsColumnManager.php            → runtime schema manager (create/update/delete columns)
src/Concerns/HasCustomFields.php             → Eloquent trait (fillable/casts merge, lifecycle hooks)
src/Enums/FieldType.php / InputType.php      → backed enums with default()
src/Filament/Concerns/HasCustomFields.php    → Filament resource trait (5 merge + 5 get helpers)
src/Filament/Forms/Components/CustomFields.php       → form schema injector
src/Filament/Infolists/Components/CustomEntries.php  → infolist schema injector
src/Filament/Tables/Columns/CustomColumns.php        → table column injector (use_in_table)
src/Filament/Tables/Filters/CustomFilters.php        → table filters + query-builder constraints (filterable)
src/Filament/Resources/FieldResource.php             → admin CRUD resource + settings schema builders
src/Filament/Resources/FieldResource/Pages/…         → CreateField / EditField / ListFields pages
src/Models/Field.php                                 → custom_fields model (SoftDeletes + SortableTrait)
src/Http/Resources/V1/FieldResource.php              → JSON API resource (no routes ship)
database/factories/FieldFactory.php                  → model factory (contains legacy non-fillable keys)
database/migrations/2024_11_13_052541_create_custom_fields_table.php
config/custom-fields.php                             → publishable configuration
```

--------------------------------

### getPages(): array method

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/field-resource.md

Returns the route definitions for the resource's pages: index, create, and edit.

```php
public static function getPages(): array
{
    return [
        'index'  => ListFields::route('/'),
        'create' => CreateField::route('/create'),
        'edit'   => EditField::route('/{record}/edit'),
    ];
}
```

--------------------------------

### Publish translations

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Publishes the translation files for the custom-fields package. Ships with 'en' and 'ar' under the 'custom-fields::' namespace.

```bash
php artisan vendor:publish --tag="custom-fields-translations"
```

--------------------------------

### Merging entries into a base list

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-entries.md

Shows how the entries array becomes the tail of a mergeCustomInfolistEntries style base list using array_merge.

```php
$full = array_merge($baseEntries, $entries);
```

--------------------------------

### HasCustomFields::mergeCustomInfolistEntries(array $base, array $include = [], array $exclude = [])

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Static helper to merge custom infolist entries into a base array. Accepts include/exclude lists to filter custom fields.

```APIDOC
## HasCustomFields::mergeCustomInfolistEntries(array $base, array $include = [], array $exclude = [])

### Description
Static helper to merge custom infolist entries into a base array. Accepts include/exclude lists to filter custom fields.

### Method
mergeCustomInfolistEntries

### Parameters
- **$base** (array) - Required - The base array of entries.
- **$include** (array) - Optional - List of field codes to include (empty means all).
- **$exclude** (array) - Optional - List of field codes to exclude.

### Return Value
- (array) - The merged array of infolist entries.
```

--------------------------------

### Public static properties: $name and $viewNamespace

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/service-provider.md

Defines the package name and view namespace used by Spatie package-tools. The view namespace has no custom blade views shipped with the package.

```php
public static string $name = 'custom-fields';

public static string $viewNamespace = 'custom-fields';
```

--------------------------------

### Merge helper method signatures

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/concerns-has-custom-fields-filament.md

All five merge helpers share the same signature: they accept a base array plus optional include/exclude whitelists and return the base array merged with custom fields. The include and exclude arrays contain field codes; empty include means all fields.

```php
protected static function mergeCustomFormFields(array $baseSchema, array $include = [], array $exclude = []): array
protected static function mergeCustomTableColumns(array $baseColumns, array $include = [], array $exclude = []): array
protected static function mergeCustomTableFilters(array $baseFilters, array $include = [], array $exclude = []): array
protected static function mergeCustomTableQueryBuilderConstraints(array $baseConstraints, array $include = [], array $exclude = []): array
protected static function mergeCustomInfolistEntries(array $baseSchema, array $include = [], array $exclude = []): array
```

--------------------------------

### CustomFields::make() implementation

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-fields.md

Resolves the component from the Laravel container with the resource class as a constructor parameter and runs configure(), Filament's component configuration hook (empty by default).

```php
public static function make(string $resource): static
{
    $static = app(static::class, ['resource' => $resource]);

    $static->configure();

    return $static;
}
```

--------------------------------

### HasCustomFields::getCustomFields()

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Protected method to override for scoping the custom fields query (e.g., to a specific tenant). Returns a query builder for custom fields.

```APIDOC
## HasCustomFields::getCustomFields()

### Description
Protected method to override for scoping the custom fields query (e.g., to a specific tenant). Returns a query builder for custom fields.

### Method
getCustomFields

### Return Value
- (Builder) - Query builder for custom fields.
```

--------------------------------

### CustomEntries::include()

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-entries.md

Sets the whitelist of field codes to include in the schema. Returns the component instance for chaining.

```APIDOC
## CustomEntries::include()

### Description
Sets the whitelist of field codes to include in the schema. Returns the component instance for chaining.

### Method
`public function include(array $fields): static`

### Parameters
- **$fields** (array) - Required - Field codes to whitelist

### Return
- **static** - The component instance

### Example
```php
$entries = CustomEntries::make(EmployeeResource::class)->include(['hobbies']);
```
```

--------------------------------

### CustomColumns::make() with include() and getColumns()

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-columns.md

Builds a Filament table columns array from custom field definitions. Only fields flagged use_in_table = true are included. The include() method whitelists fields; empty list means all fields.

```php
use Webkul\CustomFields\Filament\Tables\Columns\CustomColumns;

$columns = CustomColumns::make(EmployeeResource::class)
    ->include(['hobbies'])
    ->getColumns();
```

--------------------------------

### packageBooted method

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/service-provider.md

Registers the custom-fields.css asset as a Filament CSS asset under the package identifier 'aureuserp/custom-fields'.

```php
public function packageBooted(): void
{
    FilamentAsset::register([
        Css::make('custom-fields', __DIR__.'/../resources/dist/custom-fields.css'),
    ], 'aureuserp/custom-fields');
}
```

--------------------------------

### getQueryBuilderConstraints() implementation

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-filters.md

Maps each field to a Filament QueryBuilder Constraint via createConstraint(). Returns an array of constraints, each labelled with the field name.

```php
public function getQueryBuilderConstraints(): array
{
    $fields = $this->getFields();

    return $fields->map(function ($field) {
        return $this->createConstraint($field);
    })->toArray();
}
```

--------------------------------

### Protected helper method signatures for custom fields

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/concerns-has-custom-fields-filament.md

Declares the protected companion methods with identical parameter contracts (base argument omitted). Each accepts optional include and exclude arrays and returns an array.

```php
protected static function getCustomFormFields(array $include = [], array $exclude = []): array
protected static function getCustomTableColumns(array $include = [], array $exclude = []): array
protected static function getCustomTableFilters(array $include = [], array $exclude = []): array
protected static function getTableQueryBuilderConstraints(array $include = [], array $exclude = []): array
protected static function getCustomInfolistEntries(array $include = [], array $exclude = []): array
```

--------------------------------

### CustomFields constructor signature

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-fields.md

Final constructor that accepts a fully-qualified Filament Resource class. Instantiate through make() instead of directly.

```php
final public function __construct(string $resource)
```

--------------------------------

### applySetting(Component $component, array $setting): void

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-fields.md

Applies a setting to the component if the method exists. Passes value if present, otherwise calls method with no arguments.

```php
protected function applySetting(Component $component, array $setting): void
```

--------------------------------

### protected getPluginDefaults() method signature

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Returns the hardcoded fallback layer of the resolution order, with keys for navigation and model settings. Values come from config('custom-fields.*') or hardcoded fallbacks.

```php
protected function getPluginDefaults(): array
```

--------------------------------

### protected getPluginDefaults(): array

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Returns the hardcoded, third-priority fallback layer of the resolution order. Provides default values for navigation and model labels.

```APIDOC
## protected getPluginDefaults(): array

### Description
Returns the hardcoded, third-priority fallback layer of the resolution order. Provides default values for navigation and model labels.

### Method
`protected getPluginDefaults(): array`

### Return Value
- **array** - Keyed array with keys: `navigationLabel`, `navigationGroup`, `navigationIcon`, `activeNavigationIcon`, `navigationSort`, `navigationBadge`, `navigationBadgeColor`, `navigationBadgeTooltip`, `navigationParentItem`, `subNavigationPosition`, `modelLabel`, `pluralModelLabel`, `slug`, `cluster`, `tenantRelationshipName`. Values are either published config values or hardcoded fallbacks.

```

--------------------------------

### Using FieldType::default() as fallback

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/types.md

Shows how to safely resolve a raw value to a FieldType, falling back to the default Text case for unknown values.

```php
use Webkul\CustomFields\Enums\FieldType;

$type = FieldType::tryFrom($raw) ?? FieldType::default();
```

--------------------------------

### registerNavigation

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Sets whether navigation should be registered for the custom fields plugin. Accepts a boolean or closure and returns static for chaining.

```APIDOC
## registerNavigation

### Description
Sets whether navigation should be registered for the custom fields plugin. Accepts a boolean or closure and returns static for chaining.

### Method
Setter

### Signature
`public function registerNavigation(bool | Closure $condition = true): static`

### Parameters
- **$condition** (bool | Closure) - Optional - Defaults to `true`. The condition or a closure returning a boolean.

### Return Value
- **static** - Returns the instance for chaining.

### Getter
`shouldRegisterNavigation(): bool`

Resolution: Setter value (Closure-resolved, cast to bool) → `config('custom-fields.navigation.register', true)`.
```

--------------------------------

### packageRegistered method

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/service-provider.md

Registers CustomFieldsPlugin as a singleton in the container, ensuring the same instance is returned across calls.

```php
public function packageRegistered(): void
{
    $this->app->singleton(CustomFieldsPlugin::class);
}
```

--------------------------------

### mergeCustomInfolistEntries

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/concerns-has-custom-fields-filament.md

Merges custom infolist entries into a base schema array. Accepts optional include/exclude whitelists of field codes and returns the base array merged with the custom entries.

```APIDOC
## mergeCustomInfolistEntries

### Description
Merges custom infolist entries into a base schema array. Accepts optional include/exclude whitelists of field codes and returns the base array merged with the custom entries.

### Method
protected static function

### Signature
mergeCustomInfolistEntries(array $baseSchema, array $include = [], array $exclude = []): array

### Parameters
- **$baseSchema** (array) - Required - The developer-defined base infolist entries
- **$include** (array) - Optional - Field codes to whitelist. Empty means "all fields"
- **$exclude** (array) - Optional - Field codes to blacklist

### Return
- **array** - array_merge($base, $custom) — base items first, then the custom items, in sort order

### Delegates To
CustomEntries::make(static::class)->getSchema()
```

--------------------------------

### register(Panel $panel) method signature

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Called by Filament when the plugin is registered on a panel. If shouldRegisterResource() is falsy, it returns immediately; otherwise, for admin panels, it auto-discovers FieldResource and its pages.

```php
public function register(Panel $panel): void
```

--------------------------------

### CustomEntries::getSchema()

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-entries.md

Builds and returns an array of Filament infolist Entry objects, one per custom field, ordered by sort ascending.

```APIDOC
## CustomEntries::getSchema()

### Description
Builds and returns an array of Filament infolist Entry objects, one per custom field, ordered by sort ascending.

### Method
`public function getSchema(): array`

### Parameters
None

### Return
- **array** - An array of Filament infolist Entry objects

### Example
```php
$entries = CustomEntries::make(EmployeeResource::class)->getSchema();
```
```

--------------------------------

### Basic plugin registration with setters

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Registers the CustomFieldsPlugin with per-panel overrides for navigation label, group, icon, sort order, badge, badge color, slug, and cluster. The navigationBadge closure is resolved lazily at read time.

```php
use Webkul\CustomFields\CustomFieldsPlugin;

->plugins([
    CustomFieldsPlugin::make()
        ->navigationLabel('Custom Fields')
        ->navigationGroup('Settings')
        ->navigationIcon('heroicon-o-puzzle-piece')
        ->navigationSort(5)
        ->navigationBadge(fn () => \Webkul\CustomFields\Models\Field::count())
        ->navigationBadgeColor('primary')
        ->slug('admin/custom-fields')
        ->cluster(\App\Filament\Clusters\AdminTools::class),
])
```

--------------------------------

### createColumn() method

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-columns.md

Maps $field->type to a Filament table column class. Each column is created with ::make($field->code)->label($field->name) and table_settings applied via applySetting().

```php
protected function createColumn(Field $field): Column
```

--------------------------------

### getFilters() implementation

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-filters.md

Maps each field to a Filament BaseFilter via createFilter(). Returns an array of filters, each labelled with the field name.

```php
public function getFilters(): array
{
    $fields = $this->getFields();

    return $fields->map(function ($field) {
        return $this->createFilter($field);
    })->toArray();
}
```

--------------------------------

### CustomFields::__construct(string $resource)

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/components-custom-fields.md

Constructor for the CustomFields component. It is final, so instantiate through the make() factory method instead.

```APIDOC
## CustomFields::__construct(string $resource)

### Description
Constructor for the CustomFields component. It is final, so instantiate through the make() factory method instead.

### Method
Constructor

### Signature
```php
final public function __construct(string $resource)
```

### Parameters
- **$resource** (string) - Required - Fully-qualified Filament Resource class (e.g. `EmployeeResource::class`)

### Return
No return value (constructor).
```

--------------------------------

### Basic serialization in a controller

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/field-http-resource.md

Shows a controller's show method returning a FieldResource for a given Field model. The resource is returned directly from the controller action.

```php
use App\Http\Controllers\Controller;
use Illuminate\Http\Request;
use Webkul\CustomFields\Http\Resources\V1\FieldResource;
use Webkul\CustomFields\Models\Field;

class FieldController extends Controller
{
    public function show(Field $field): FieldResource
    {
        return new FieldResource($field);
    }
}
```

--------------------------------

### navigationBadgeTooltip

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Sets the navigation badge tooltip for the custom fields plugin. Accepts a string, closure, or null and returns static for chaining.

```APIDOC
## navigationBadgeTooltip

### Description
Sets the navigation badge tooltip for the custom fields plugin. Accepts a string, closure, or null and returns static for chaining.

### Method
Setter

### Signature
`public function navigationBadgeTooltip(Closure | string | null $tooltip): static`

### Parameters
- **$tooltip** (Closure | string | null) - Required - The tooltip text or a closure returning it.

### Return Value
- **static** - Returns the instance for chaining.

### Getter
`getNavigationBadgeTooltip(): ?string`

Resolution: Setter value → default, cast to string.
```

--------------------------------

### register(Panel $panel): void

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Called by Filament when the plugin is registered on a panel. If shouldRegisterResource() is falsy, it returns immediately; otherwise, when the panel ID is 'admin', it auto-discovers FieldResource and its pages.

```APIDOC
## register(Panel $panel): void

### Description
Called by Filament when the plugin is registered on a panel. If `shouldRegisterResource()` is falsy, it returns immediately (disabling the admin CRUD). Otherwise, when the panel ID is `admin`, it auto-discovers `FieldResource` and its pages from `src/Filament/Resources` under the `Webkul\CustomFields\Filament\Resources` namespace via `$panel->discoverResources(...)`.

### Method
`register(Panel $panel): void`

### Parameters
- **$panel** (Filament\Panel) - Required - The Filament panel being configured.

### Return Value
- **void** - No return value.

```

--------------------------------

### Protected helper method signatures

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Declares the three protected helper methods used internally by the plugin: pluginDefault, resolveClosure, and resolveOrDefault. These are not intended for direct external use.

```php
protected function pluginDefault(string $key): mixed
protected function resolveClosure(mixed $value): mixed
protected function resolveOrDefault(mixed $value, string $defaultKey): ?string
```

--------------------------------

### loadCustomFields() method

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/concerns-has-custom-fields-eloquent.md

Core routine that queries custom fields, merges codes into fillable and casts into casts. Uses static caches to avoid re-querying. Swallows any exception, so the model works even if the custom_fields table is missing.

```php
protected function loadCustomFields()
{
    try {
        $customFields = $this->getCustomFields();

        $this->mergeFillable(self::$customFillable ??= $customFields->pluck('code')->toArray());

        $this->mergeCasts(self::$customCasts ??= $customFields->select('code', 'type', 'is_multiselect')->get());
    } catch (Exception $e) {
    }
}
```

--------------------------------

### mergeCustomInfolistEntries

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/concerns-has-custom-fields-filament.md

Merges custom infolist entries with base entries. Accepts optional include/exclude arrays to filter custom fields by code.

```APIDOC
## mergeCustomInfolistEntries

### Description
Merges custom infolist entries with base entries. Accepts optional include/exclude arrays to filter custom fields by code.

### Method
PHP method (static)

### Signature
```php
protected static function mergeCustomInfolistEntries(array $baseEntries, array $include = [], array $exclude = []): array
```

### Parameters
- **$baseEntries** (array) - Required - Base infolist entries to merge with custom entries.
- **$include** (array) - Optional - List of custom field codes to include. If non-empty, only fields with these codes are included.
- **$exclude** (array) - Optional - List of custom field codes to exclude. These fields are never included.

### Return Value
- **array** - Merged array of infolist entries.

### Usage Example
```php
static::mergeCustomInfolistEntries([...])
```
```

--------------------------------

### HasCustomFields::mergeCustomTableQueryBuilderConstraints(array $base, array $include = [], array $exclude = [])

Source: https://github.com/aureuserp/custom-fields/blob/master/README.md

Static helper to merge custom query builder constraints into a base array. Accepts include/exclude lists to filter custom fields.

```APIDOC
## HasCustomFields::mergeCustomTableQueryBuilderConstraints(array $base, array $include = [], array $exclude = [])

### Description
Static helper to merge custom query builder constraints into a base array. Accepts include/exclude lists to filter custom fields.

### Method
mergeCustomTableQueryBuilderConstraints

### Parameters
- **$base** (array) - Required - The base array of constraints.
- **$include** (array) - Optional - List of field codes to include (empty means all).
- **$exclude** (array) - Optional - List of field codes to exclude.

### Return Value
- (array) - The merged array of query builder constraints.
```

--------------------------------

### navigationBadge

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/custom-fields-plugin.md

Sets the navigation badge for the custom fields plugin. Accepts a string, closure, or null and returns static for chaining.

```APIDOC
## navigationBadge

### Description
Sets the navigation badge for the custom fields plugin. Accepts a string, closure, or null and returns static for chaining.

### Method
Setter

### Signature
`public function navigationBadge(Closure | string | null $badge): static`

### Parameters
- **$badge** (Closure | string | null) - Required - The navigation badge or a closure returning it.

### Return Value
- **static** - Returns the instance for chaining.

### Getter
`getNavigationBadge(): ?string`

Resolution: Setter value → default, cast to string.
```

--------------------------------

### fill method signature

Source: https://github.com/aureuserp/custom-fields/blob/master/_autodocs/api-reference/concerns-has-custom-fields-eloquent.md

Overrides Eloquent's fill(): calls loadCustomFields() first so custom codes are in $fillable before assignment, then delegates to parent::fill($attributes).

```php
public function fill(array $attributes): static
```
Tokens:
Raw