Settings

• Features
• Requirements
• Installation
  • Step 1: Install via Composer
  • Step 2: Register the Plugin
  • Step 3: Publish Config (Optional)
• Usage
  • Editing Settings
  • Using Settings in Your Application
  • Modify Fields Mode
• Configuration
  • Plugin Options
  • Authorization
    • Option 1: Plugin Callback (Recommended)
    • Option 2: Laravel Gate
    • Option 3: Config File
    • Programmatic Control from Other Packages
  • Default Tabs & Settings
  • Supported Field Types
  • Custom Config Example
• Changelog
• Contributing
• Credits
• License

A powerful, tabbed settings management page for your Filament panel that lets you manage all your website settings — general info, social links, SEO, appearance, custom CSS/JS — from one beautiful interface.

#Features

• 📑 Tabbed Interface — Settings organized into 6 default tabs: General, Contact, Social Media, SEO, Appearance, CSS & Scripts
• 🎛️ Smart Field Types — Automatically renders the right input based on setting type: text, textarea, image upload, file upload, color picker, toggle (switch), checkbox
• 🔧 Modify Fields Mode — Permission-gated mode to add new settings, delete existing ones, reorder fields, edit labels, and move settings between tabs
• 🎨 CSS & Scripts — Dedicated tab with side-by-side CSS and JavaScript editors for Header, Body, and Footer sections
• 🔐 Flexible Authorization — Control who can modify fields via plugin callback, Laravel Gate, or config
• 📦 Auto-Seeding — Default settings are automatically seeded on first page load
• ⚡ Cache-Aware — Automatically clears the settings cache after every save
• 🌗 Dark Theme Support — Fully compatible with Filament's dark mode

#Requirements

• PHP 8.2+
• Laravel 10, 11, or 12
• Filament v4 or v5
• damodar-bhattarai/settings package

#Installation

#Step 1: Install via Composer

composer require damodar-bhattarai/filament-settings

This will also install the damodar-bhattarai/settings base package if not already installed. The plugin automatically copies and runs all required migrations on the first page load!

#Step 2: Register the Plugin

Add the plugin to your Filament panel provider (e.g., app/Providers/Filament/AdminPanelProvider.php):

use DamodarBhattarai\FilamentSettings\FilamentSettingsPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        // ... your other configuration
        ->plugins([
            FilamentSettingsPlugin::make(),
        ]);
}

#Step 3: Publish Config (Optional)

php artisan vendor:publish --tag="filament-settings-config"

That's it! Navigate to Settings → App Settings in your panel.

#Usage

#Editing Settings

Simply visit the App Settings page, modify the values across any tab, and click Save Settings. All changes are persisted to the database and the settings cache is automatically cleared.

#Using Settings in Your Application

Retrieve saved settings anywhere in your application using the base package's helpers:

// Get a single setting value
$siteName = settings('site_name');

// Get with a default fallback
$logo = settings('logo', 'default-logo.png');

// Get all settings as a collection
$all = settings();

#Modify Fields Mode

Click the "Modify Fields" button in the page header to enter Modify Mode. This mode is permission-gated and allows you to:

Click "Exit Modify Mode" to return to value-only editing.

#Configuration

#Plugin Options

Customize the plugin behavior using the fluent API:

FilamentSettingsPlugin::make()
    // Navigation
    ->navigationIcon('heroicon-o-cog-6-tooth')
    ->navigationGroup('Settings')
    ->navigationLabel('App Settings')
    ->navigationSort(100)

    // Page
    ->pageTitle('App Settings')
    ->slug('app-settings')

    // Authorization
    ->canModifyFields(true)

#Authorization

Control who can access the Modify Fields mode using one of three methods:

#Option 1: Plugin Callback (Recommended)

Best for role-based access. Works with any permission package (Spatie, Bouncer, etc.):

FilamentSettingsPlugin::make()
    ->canModifyFields(fn () => auth()->user()->hasRole('super_admin'))

#Option 2: Laravel Gate

Define a gate in your AuthServiceProvider or any service provider:

use Illuminate\Support\Facades\Gate;

Gate::define('modify-settings-fields', function ($user) {
    return $user->hasRole('admin');
});

#Option 3: Config File

Set a static boolean in config/filament-settings.php:

'can_modify_fields' => true,

Resolution priority: Plugin callback → Laravel Gate → Config default.

#Programmatic Control from Other Packages

Other packages can control the Modify Fields capability at runtime:

use DamodarBhattarai\FilamentSettings\FilamentSettingsPlugin;

// Disable modify mode
FilamentSettingsPlugin::get()->canModifyFields(false);

// Enable conditionally
FilamentSettingsPlugin::get()->canModifyFields(
    fn () => app('some-package')->allowsSettingsModification()
);

#Default Tabs & Settings

The plugin ships with 6 pre-configured tabs. Customize them in config/filament-settings.php:

You can add, remove, or modify any of these in the config file. Any groups created via the UI are also automatically displayed.

#Supported Field Types

#Custom Config Example

// config/filament-settings.php

'default_settings' => [
    'general' => [
        'label' => 'General',
        'icon' => 'heroicon-o-home',
        'sort' => 1,
        'settings' => [
            [
                'key' => 'site_name',
                'type' => 'text',
                'label' => 'Site Name',
                'value' => 'My Website',
            ],
            [
                'key' => 'maintenance_mode',
                'type' => 'switch',
                'label' => 'Maintenance Mode',
                'value' => false,
            ],
            // Add more settings...
        ],
    ],
    // Add more tabs...
],

#Changelog

Please see CHANGELOG for more information on recent changes.

#Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

#Credits

• Damodar Bhattarai

#License

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