Filament Backgrounds

https://github.com/swisnl/filament-backgrounds
Admin
A curated list of free-to-use images to customize Filament auth pages, with options to use your own...
Tokens:1,444
Snippets:8
Trust Score:8.8
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Filament Backgrounds Package

Source: https://github.com/swisnl/filament-backgrounds/blob/main/README.md

Installs the filament-backgrounds package using Composer.

```bash
composer require swisnl/filament-backgrounds
```

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

### Running Tests

Source: https://github.com/swisnl/filament-backgrounds/blob/main/README.md

This command executes the test suite for the Filament Backgrounds package using Composer.

```bash
composer test
```

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

### Custom Image Provider Implementation

Source: https://github.com/swisnl/filament-backgrounds/blob/main/README.md

Demonstrates how to create a custom image provider by implementing the `ProvidesImages` interface. This involves defining the `make` and `getImage` methods. The `getImage` method should return an `Image` object containing the CSS `background-image` property and attribution text.

```php
<?php

use Swis\Filament\Backgrounds\Contracts\ProvidesImages;
use Swis\Filament\Backgrounds\Image;

class MyImageProvider implements ProvidesImages
{
    public static function make(): static
    {
        return app(static::class);
    }

    public function getImage(): Image
    {
        return new Image(
            'url("[link to photo]")',
            'Photo by ...'
        );
    }
}
```

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

### Publish Default Images

Source: https://github.com/swisnl/filament-backgrounds/blob/main/README.md

Publishes the default curated list of images to your project.

```bash
php artisan filament-backgrounds:install
```

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

### Add FilamentBackgroundsPlugin to Panel

Source: https://github.com/swisnl/filament-backgrounds/blob/main/README.md

Registers the FilamentBackgroundsPlugin in your Filament panel configuration.

```php
use Swis\Filament\Backgrounds\FilamentBackgroundsPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentBackgroundsPlugin::make(),
        ])
}
```

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

### Use Custom Images

Source: https://github.com/swisnl/filament-backgrounds/blob/main/README.md

Configures the plugin to use your own images stored in a specified directory.

```php
use Swis\Filament\Backgrounds\FilamentBackgroundsPlugin;
use Swis\Filament\Backgrounds\ImageProviders\MyImages;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentBackgroundsPlugin::make()
                ->imageProvider(
                    MyImages::make()
                        ->directory('images/backgrounds')
                ),
        ])
}
```

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

### Set Cache Time

Source: https://github.com/swisnl/filament-backgrounds/blob/main/README.md

Configures the cache time in seconds for image providers, useful for API-based providers.

```php
use Swis\Filament\Backgrounds\FilamentBackgroundsPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentBackgroundsPlugin::make()
                ->remember(900),
        ])
}
```

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

### Disable Attribution

Source: https://github.com/swisnl/filament-backgrounds/blob/main/README.md

Disables the display of image attribution on the auth pages. Note: This may violate license terms.

```php
use Swis\Filament\Backgrounds\FilamentBackgroundsPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentBackgroundsPlugin::make()
                ->showAttribution(false),
        ])
}
```
Tokens:
Raw