DOCS
DOCS

Version

Theme

Core Concepts - Plugins

Build a standalone plugin

Preface

Please read the docs on panel plugin development and the getting started guide before continuing.

Overview

In this walkthrough, we'll build a simple plugin that adds a new form component that can be used in forms. This also means it will be available to users in their panels.

You can find the final code for this plugin at https://github.com/awcodes/headings.

Step 1: Create the plugin

First, we'll create the plugin using the steps outlined in the getting started guide.

Step 2: Clean up

Next, we'll clean up the plugin to remove the boilerplate code we don't need. This will seem like a lot, but since this is a simple plugin, we can remove a lot of the boilerplate code.

Remove the following directories and files:

  1. bin
  2. config
  3. database
  4. src/Commands
  5. src/Facades
  6. stubs
  7. tailwind.config.js

Now we can clean up our composer.json file to remove unneeded options.

"autoload": {
    "psr-4": {
        // We can remove the database factories
        "Awcodes\\Headings\\Database\\Factories\\": "database/factories/"
    }
},
"extra": {
    "laravel": {
        // We can remove the facade
        "aliases": {
            "Headings": "Awcodes\\Headings\\Facades\\ClockWidget"
        }
    }
},

Normally, Filament v3 recommends that users style their plugins with a custom filament theme, but for the sake of example let's provide our own stylesheet that can be loaded asynchronously using the new x-load features in Filament v3. So, let's update our package.json file to include cssnano, postcss, postcss-cli and postcss-nesting to build our stylesheet.

{
    "private": true,
    "scripts": {
        "build": "postcss resources/css/index.css -o resources/dist/headings.css"
    },
    "devDependencies": {
        "cssnano": "^6.0.1",
        "postcss": "^8.4.27",
        "postcss-cli": "^10.1.0",
        "postcss-nesting": "^13.0.0"
    }
}

Then we need to install our dependencies.

npm install

We will also need to update our postcss.config.js file to configure postcss.

module.exports = {
    plugins: [
        require('postcss-nesting')(),
        require('cssnano')({
            preset: 'default',
        }),
    ],
};

You may also remove the testing directories and files, but we'll leave them in for now, although we won't be using them for this example, and we highly recommend that you write tests for your plugins.

Step 3: Setting up the provider

Now that we have our plugin cleaned up, we can start adding our code. The boilerplate in the src/HeadingsServiceProvider.php file has a lot going on so, let's delete everything and start from scratch.

We need to be able to register our stylesheet with the Filament Asset Manager so that we can load it on demand in our blade view. To do this, we'll need to add the following to the packageBooted method in our service provider.

Note the loadedOnRequest() method. This is important, because it tells Filament to only load the stylesheet when it's needed.

namespace Awcodes\Headings;
 
use Filament\Support\Assets\Css;
use Filament\Support\Facades\FilamentAsset;
use Spatie\LaravelPackageTools\Package;
use Spatie\LaravelPackageTools\PackageServiceProvider;
 
class HeadingsServiceProvider extends PackageServiceProvider
{
    public static string $name = 'headings';
 
    public function configurePackage(Package $package): void
    {
        $package->name(static::$name)
            ->hasViews();
    }
 
    public function packageBooted(): void
    {
        FilamentAsset::register([
            Css::make('headings', __DIR__ . '/../resources/dist/headings.css')->loadedOnRequest(),
        ], 'awcodes/headings');
    }
}

Step 4: Creating our component

Next, we'll need to create our component. Create a new file at src/Heading.php and add the following code.

namespace Awcodes\Headings;
 
use Closure;
use Filament\Forms\Components\Component;
use Filament\Support\Colors\Color;
use Filament\Support\Concerns\HasColor;
 
class Heading extends Component
{
    use HasColor;
 
    protected string | int $level = 2;
 
    protected string | Closure $content = '';
 
    protected string $view = 'headings::heading';
 
    final public function __construct(string | int $level)
    {
        $this->level($level);
    }
 
    public static function make(string | int $level): static
    {
        return app(static::class, ['level' => $level]);
    }
 
    protected function setUp(): void
    {
        parent::setUp();
 
        $this->dehydrated(false);
    }
 
    public function content(string | Closure $content): static
    {
        $this->content = $content;
 
        return $this;
    }
 
    public function level(string | int $level): static
    {
        $this->level = $level;
 
        return $this;
    }
 
    public function getColor(): array
    {
        return $this->evaluate($this->color) ?? Color::Amber;
    }
 
    public function getContent(): string
    {
        return $this->evaluate($this->content);
    }
 
    public function getLevel(): string
    {
        return is_int($this->level) ? 'h' . $this->level : $this->level;
    }
}

Step 5: Rendering our component

Next, we'll need to create the view for our component. Create a new file at resources/views/heading.blade.php and add the following code.

We are using x-load to asynchronously load stylesheet, so it's only loaded when necessary. You can learn more about this in the Core Concepts section of the docs.

@php
    $level = $getLevel();
    $color = $getColor();
@endphp
 
<{{ $level }}
    x-data
    x-load-css="[@js(\Filament\Support\Facades\FilamentAsset::getStyleHref('headings', package: 'awcodes/headings'))]"
    {{
        $attributes
            ->class([
                'headings-component',
                match ($color) {
                    'gray' => 'text-gray-600 dark:text-gray-400',
                    default => 'text-custom-500',
                },
            ])
            ->style([
                \Filament\Support\get_color_css_variables($color, [500]) => $color !== 'gray',
            ])
    }}
>
    {{ $getContent() }}
</{{ $level }}>

Step 6: Adding some styles

Next, let's provide some custom styling for our field. We'll add the following to resources/css/index.css. And run npm run build to compile our css.

.headings-component {
    &:is(h1, h2, h3, h4, h5, h6) {
         font-weight: 700;
         letter-spacing: -.025em;
         line-height: 1.1;
     }
 
    &h1 {
         font-size: 2rem;
     }
 
    &h2 {
         font-size: 1.75rem;
     }
 
    &h3 {
         font-size: 1.5rem;
     }
 
    &h4 {
         font-size: 1.25rem;
     }
 
    &h5,
    &h6 {
         font-size: 1rem;
     }
}

Then we need to build our stylesheet.

npm run build

Step 7: Update your README

You'll want to update your README.md file to include instructions on how to install your plugin and any other information you want to share with users, Like how to use it in their projects. For example:

use Awcodes\Headings\Heading;
 
Heading::make(2)
    ->content('Product Information')
    ->color(Color::Lime),

And, that's it, our users can now install our plugin and use it in their projects.

Edit on GitHub

Still need help? Join our Discord community or open a GitHub discussion

Previous
Build a panel plugin
Next
Overview
Your logo here? 💖