Light Switch

https://github.com/awcodes/light-switch
Admin
Light Switch is a plugin that provides theme switching capabilities (light/dark/system) for Filament...
Tokens:21,671
Snippets:310
Trust Score:9.6
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Light Switch Plugin Configuration Example

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/architecture-and-integration.md

Demonstrates how to configure the LightSwitchPlugin by setting its position and enabling it on specific routes. This is typically done during panel setup.

```php
LightSwitchPlugin::make()
    .position(Alignment::BottomCenter)
    .enabledOn(['auth.login'])
```

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

### Full Light Switch Plugin Configuration Example

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/configuration.md

An example demonstrating how to register and configure the Light Switch plugin within a Filament panel, setting both position and enabled routes.

```php
use Filament\Panel;
use Awcodes\LightSwitch\LightSwitchPlugin;
use Awcodes\LightSwitch\Enums\Alignment;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            LightSwitchPlugin::make()
                ->position(Alignment::BottomCenter)
                ->enabledOn([
                    'auth.email',
                    'auth.login',
                    'auth.password',
                    'auth.profile',
                    'auth.register',
                ]),
        ]);
}
```

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

### Install Light Switch via Composer

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/installation-and-setup.md

Use Composer to install the light-switch package.

```bash
composer require awcodes/light-switch
```

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

### Method Chaining Example

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Demonstrates fluent method chaining for configuring the Light Switch Plugin. Most configuration methods return 'static' to enable this pattern.

```php
$plugin = LightSwitchPlugin::make()
    ->position(Alignment::BottomCenter)     // Returns static
    ->enabledOn(['auth.login'])             // Returns static
    // Can continue chaining
;
```

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

### Complete Light Switch Configuration with Chaining

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/usage-examples.md

Example demonstrating a comprehensive configuration of the Light Switch plugin, including position and enabled routes, alongside other panel settings.

```php
use Filament\Panel;
use Awcodes\LightSwitch\LightSwitchPlugin;
use Awcodes\LightSwitch\Enums\Alignment;

public function panel(Panel $panel): Panel
{
    return $panel
        ->default()
        ->id('admin')
        ->path('admin')
        ->login()
        ->colors([
            'primary' => Color::Blue,
        ])
        ->darkMode()  // Enable dark mode on the panel
        ->plugins([
            LightSwitchPlugin::make()
                ->position(Alignment::BottomCenter)
                ->enabledOn([
                    'auth.login',
                    'auth.password',
                    'auth.register',
                    'auth.email',
                ]),
        ]);
}
```

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

### Configure Light Switch for Multi-Panel Setup

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/usage-examples.md

Configure the Light Switch plugin independently for different Filament panels within the same application.

```php
// Admin panel
public function panel(Panel $panel): Panel
{
    return $panel
        ->id('admin')
        ->path('admin')
        ->plugins([
            LightSwitchPlugin::make()
                ->position(Alignment::TopRight)
                ->enabledOn(['auth.login']),
        ]);
}

// App panel
public function appPanel(Panel $panel): Panel
{
    return $panel
        ->id('app')
        ->path('app')
        ->plugins([
            LightSwitchPlugin::make()
                ->position(Alignment::BottomLeft)
                ->enabledOn(['auth.login', 'auth.register']),
        ]);
}
```

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

### Configure Filament Panel with Optional Dark Mode

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/usage-examples.md

The recommended setup for the light switch plugin is when dark mode is enabled but not forced, allowing users to toggle their preference.

```php
public function panel(Panel $panel): Panel
{
    return $panel
        ->darkMode(true)  // Enable but don't force
        ->plugins([
            LightSwitchPlugin::make()
                ->position(Alignment::TopRight),
        ]);
}
```

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

### Get Light Switch Plugin Instance and State Programmatically

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/usage-examples.md

Retrieve the plugin instance to check its current position, enabled routes, and whether the switcher should be displayed on the current page.

```php
use Awcodes\LightSwitch\LightSwitchPlugin;

// Get the registered plugin
$plugin = LightSwitchPlugin::get();

// Get the position
$position = $plugin->getPosition();
if ($position === Alignment::BottomCenter) {
    // Handle bottom-center position
}

// Get enabled routes
$routes = $plugin->isEnabledOn();
if ($routes === null) {
    // Using default routes
} else {
    // Using custom routes
    foreach ($routes as $route) {
        // Process route
    }
}

// Check if switcher should show on current page
if ($plugin->shouldShowSwitcher()) {
    // Switcher is visible on this page
}
```

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

### Listen for Theme Changes

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/views-and-components.md

An example of how to listen for the custom 'theme-changed' event dispatched by the switcher component to react to theme updates in your application.

```javascript
document.addEventListener('theme-changed', (event) => {
    console.log('Theme switched to:', event.detail);
});
```

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

### Get Light Switch Plugin Position

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-plugin.md

Retrieves the configured position of the theme switcher. Defaults to `Alignment::TopRight` if not set.

```php
$position = LightSwitchPlugin::make()
    ->position(Alignment::BottomLeft)
    ->getPosition();
// Result: Alignment::BottomLeft
```

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

### Retrieve Registered Plugin

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Use the static `get()` method to retrieve a previously registered plugin instance. This is useful for accessing plugin functionality after initialization.

```php
LightSwitchPlugin::get()
```

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

### Get Configured Position of Theme Switcher

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Retrieves the configured position of the theme switcher. Returns an Alignment enum instance. Defaults to Alignment::TopRight if position not explicitly set. To get the string value, use ->getPosition()->value.

```php
$position = LightSwitchPlugin::get()->getPosition();

if ($position === Alignment::TopRight) {
    // Position is top-right
}

// Get string value
$cssValue = $position->value;  // 'top-right'
```

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

### Get Enabled Routes

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Call the `isEnabledOn()` method on a plugin instance to retrieve the array of routes where the switcher is configured to be enabled.

```php
$plugin->isEnabledOn()
```

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

### Get Current Switcher Position

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Call the `getPosition()` method on a plugin instance to retrieve the currently set alignment for the switcher.

```php
$plugin->getPosition()
```

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

### Disable Light Switch on Specific Routes

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Configure the Light Switch plugin to be enabled only on specified routes, effectively disabling it on all others. This example shows enabling it only for the login route.

```php
LightSwitchPlugin::make()
    ->enabledOn(['auth.login'])
    // Hidden on auth.register, auth.password, etc.
```

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

### Get Configured Switcher Position

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/configuration.md

Retrieve the currently configured position of the theme switcher using the `getPosition` getter method. Returns `Alignment::TopRight` if not explicitly set.

```php
$position = LightSwitchPlugin::get()->getPosition();
if ($position === Alignment::BottomCenter) {
    // Position is bottom-center
}
```

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

### Get Enabled Routes for Switcher

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/configuration.md

Retrieve the array of routes on which the switcher is enabled using the `isEnabledOn` getter method. Returns `null` if no routes were explicitly configured.

```php
$routes = LightSwitchPlugin::get()->isEnabledOn();
if ($routes === null) {
    // Using default routes
}
```

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

### Retrieve Enabled Routes for Theme Switcher

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Retrieves the array of routes the switcher is enabled on. Returns null if enabledOn() was not called (defaults are used instead). To get the effective routes (including defaults), use shouldShowSwitcher() for current route checks.

```php
$routes = LightSwitchPlugin::get()->isEnabledOn();

if ($routes === null) {
    // Using default routes: ['auth.login', 'auth.password', 'auth.register']
} else {
    // Using custom routes
    foreach ($routes as $route) {
        // $route: 'auth.login', 'auth.email', etc.
    }
}
```

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

### Get Registered LightSwitchPlugin Instance

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Retrieves the registered plugin instance from Filament's container. Must be called after the plugin is registered with a panel. Internally calls filament(app(static::class)->getId()).

```php
$plugin = LightSwitchPlugin::get();
$position = $plugin->getPosition();
```

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

### Get LightSwitchPlugin Instance ID

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Returns the unique identifier for this plugin within Filament. Used internally by Filament for plugin registration and required by the Plugin contract. Always returns 'awcodes/light-switch'.

```php
$id = LightSwitchPlugin::make()->getId();
// Result: 'awcodes/light-switch'
```

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

### Create Plugin Instance

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Use the static `make()` method to create an instance of the LightSwitchPlugin. This is the primary way to initialize the plugin.

```php
LightSwitchPlugin::make()
```

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

### File Organization - Views

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Illustrates the directory structure for the project's views, including the main switcher view and button components.

```text
resources/views/
├── switcher.blade.php             # Main switcher container
└── components/
    └── button.blade.php           # Theme button component
```

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

### boot

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-plugin.md

Called when the plugin is booted. Currently a no-op but reserved for future plugin initialization logic.

```APIDOC
## boot

### Description
Called when the plugin is booted. Currently a no-op but reserved for future plugin initialization logic.

### Method
`boot`

### Parameters
#### Path Parameters
- **panel** (`Panel`) - Required - The Filament Panel instance

### Returns
`void`
```

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

### Fluent Chaining of Configuration Methods

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/configuration.md

Illustrates the fluent interface support where configuration methods return `static`, allowing for method chaining to set multiple options.

```php
$plugin = LightSwitchPlugin::make()
    ->position(Alignment::TopLeft)
    ->enabledOn(['auth.login', 'auth.register']);
```

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

### LightSwitchPlugin::make()

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-plugin.md

Factory method to create a new instance of the LightSwitchPlugin. This is the primary way to instantiate the plugin for configuration.

```APIDOC
## LightSwitchPlugin::make()

### Description
Factory method to create a new instance of the plugin.

### Method
static `make`

### Parameters
No parameters.

### Returns
`static` - A new instance of `LightSwitchPlugin`.

### Example
```php
use Awcodes\LightSwitch\LightSwitchPlugin;

$plugin = LightSwitchPlugin::make();
```
```

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

### LightSwitchPlugin::boot

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Called during the plugin boot phase. This method is currently a no-op and is reserved for future plugin initialization.

```APIDOC
## LightSwitchPlugin::boot

### Description
Called during the plugin boot phase. Currently a no-op reserved for future plugin initialization.

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

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```php
// This method is called by the Filament plugin system and does not require manual invocation.
```

### Response
#### Success Response
`void` - This method does not return a value.

#### Response Example
```json
// No response body as the return type is void.
```
```

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

### Create New LightSwitchPlugin Instance

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Factory method to create a new plugin instance. Internally uses app(static::class) for dependency injection. Returns a fresh instance each time and must be called before registering with a panel.

```php
use Awcodes\LightSwitch\LightSwitchPlugin;

$plugin = LightSwitchPlugin::make();

// Configure and use
$plugin = LightSwitchPlugin::make()
    ->position(Alignment::BottomCenter)
    ->enabledOn(['auth.login']);
```

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

### Create New LightSwitchPlugin Instance

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-plugin.md

Use this factory method to create a new instance of the plugin. No parameters are required.

```php
use Awcodes\LightSwitch\LightSwitchPlugin;

$plugin = LightSwitchPlugin::make();
```

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

### Run All Plugin Tests

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Execute all tests for the Light Switch plugin using Composer. This command runs unit, feature, and other test suites.

```bash
# Run all tests
composer test
```

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

### View Namespace Usage

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-service-provider.md

Demonstrates how to reference views using the 'light-switch' namespace in Blade or code.

```php
// In Blade views or code:
view('light-switch::switcher')
<x-light-switch::button />
```

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

### Boot Light Switch Plugin

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-plugin.md

Called when the plugin is booted. Currently a no-op but reserved for future plugin initialization logic.

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

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

### Light Switch Runtime Theme Switching with Alpine.js

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/architecture-and-integration.md

Illustrates the client-side logic for theme switching using Alpine.js and localStorage. This involves updating a reactive property, dispatching an event, and persisting the theme choice.

```javascript
Alpine.js: theme = 'dark' (updates reactive property)
$watch triggers: $dispatch('theme-changed', theme)
localStorage.setItem('theme', value)
```

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

### Publish Views Command

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-service-provider.md

Command to publish the package's views to the application's resources directory.

```bash
php artisan vendor:publish --tag=light-switch-views
```

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

### LightSwitchServiceProvider::configurePackage

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Configures the Laravel package for discovery and asset publishing. This method is automatically called by Spatie package tools during the service provider boot phase.

```APIDOC
## LightSwitchServiceProvider::configurePackage

### Description
Configures the Laravel package for discovery and asset publishing. This method is automatically called by Spatie package tools during the service provider boot phase.

### Method
`public function configurePackage(Package $package): void`

### Parameters
#### Parameters
- **package** (`Package`) - Required - The Spatie package configuration object

### Returns
`void`

### Throws
Nothing
```

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

### Run Specific Test Suites

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Execute specific test suites for the Light Switch plugin using Composer commands. This includes running only unit tests, linting, or refactoring checks.

```bash
# Run unit tests only
composer test:unit

# Run linting
composer test:lint

# Run rector checks
composer test:refactor
```

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

### LightSwitchServiceProvider Configuration

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/installation-and-setup.md

The LightSwitchServiceProvider configures the package name, view namespace, and view publishing for the plugin.

```php
class LightSwitchServiceProvider extends PackageServiceProvider
{
    public static string $name = 'light-switch';
    public static string $viewNamespace = 'light-switch';

    public function configurePackage(Package $package): void
    {
        $package->name(static::$name)
            ->hasViews();
    }
}
```

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

### LightSwitchPlugin::make

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Factory method to create a new plugin instance. This method should be called before registering the plugin with a panel.

```APIDOC
## LightSwitchPlugin::make

### Description
Factory method to create a new plugin instance. This method should be called before registering the plugin with a panel.

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

### Parameters
None

### Request Example
```php
use Awcodes\LightSwitch\LightSwitchPlugin;
use Awcodes\LightSwitch\Enums\Alignment;

$plugin = LightSwitchPlugin::make();

// Configure and use
$plugin = LightSwitchPlugin::make()
    ->position(Alignment::BottomCenter)
    ->enabledOn(['auth.login']);
```

### Response
#### Success Response
`static` - A new instance of LightSwitchPlugin.

#### Response Example
```json
// Returns a new plugin instance, no specific JSON response.
```
```

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

### Plugin Contract Implementation

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/architecture-and-integration.md

This snippet shows the basic class structure for a Filament plugin implementing the Plugin contract. Ensure you implement the required methods: getId, register, and boot.

```php
class LightSwitchPlugin implements Plugin
```

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

### Using Alignment Enum in LightSwitchPlugin

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/alignment-enum.md

Demonstrates how to set the position of the Light Switch plugin using the Alignment enum cases.

```php
LightSwitchPlugin::make()->position(Alignment::TopLeft);
```

```php
LightSwitchPlugin::make()->position(Alignment::TopCenter);
```

```php
LightSwitchPlugin::make()->position(Alignment::TopRight);
```

```php
LightSwitchPlugin::make()->position(Alignment::BottomLeft);
```

```php
LightSwitchPlugin::make()->position(Alignment::BottomCenter);
```

```php
LightSwitchPlugin::make()->position(Alignment::BottomRight);
```

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

### LightSwitchPlugin::enabledOn

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Configures which routes should display the theme switcher. It accepts an array of route names and uses partial matching.

```APIDOC
## LightSwitchPlugin::enabledOn

### Description
Configures which routes should display the theme switcher. It accepts an array of route names and uses partial matching.

### Method
`public function enabledOn(array $routes): static`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **routes** (array) - Required - Array of route name strings. Uses `Str::contains()` for matching, allowing partial route names.

### Request Example
```php
use Awcodes\LightSwitch\LightSwitchPlugin;

LightSwitchPlugin::make()
    ->enabledOn([
        'auth.email',
        'auth.login',
        'auth.password',
        'auth.register',
    ]);
```

### Response
#### Success Response
`static` - The plugin instance for method chaining.

#### Response Example
```json
// Returns the plugin instance for chaining, no specific JSON response.
```
```

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

### Configure Enabled Routes for Theme Switcher

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Configures which routes should display the theme switcher. Uses Str::contains() for matching, allowing partial route names. If not called, defaults to ['auth.login', 'auth.password', 'auth.register']. Route matching is case-sensitive.

```php
LightSwitchPlugin::make()
    ->enabledOn([
        'auth.email',
        'auth.login',
        'auth.password',
        'auth.register',
    ])
```

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

### File Organization - Test Coverage

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Details the directory structure for unit and integration tests, including fixtures.

```text
tests/src/
├── Unit/PluginTest.php            # Plugin unit tests
├── Feature/IntegrationTest.php     # Integration tests
├── Feature/DebugTest.php           # Debug tests
└── Fixtures/
    └── Providers/AdminPanelProvider.php
```

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

### File Organization - Source Code

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Shows the directory structure for the main plugin source code, including the plugin class, service provider, and enums.

```text
src/
├── LightSwitchPlugin.php          # Main plugin class
├── LightSwitchServiceProvider.php  # Package service provider
└── Enums/
    └── Alignment.php              # Position enum
```

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

### Enable Switcher with Partial Route Matching

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/configuration.md

Demonstrates how the `enabledOn` method uses partial string matching with `Str::contains()`, allowing a single string to match multiple routes.

```php
// This configuration will show switcher on:
// - admin.auth.email
// - app.auth.email  
// - auth.email (exact match)
->enabledOn(['auth.email'])
```

```php
// This will match only the specific route:
->enabledOn(['admin.auth.login'])
```

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

### Setting and Accessing Switcher Position

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/types.md

Demonstrates how to set the theme switcher's position using the Alignment enum and access its value. Ensure the LightSwitchPlugin is instantiated before setting the position.

```php
use Awcodes\LightSwitch\Enums\Alignment;
use Awcodes\LightSwitch\LightSwitchPlugin;

$plugin = LightSwitchPlugin::make()
    ->position(Alignment::BottomCenter);

// Access the enum value
$position = $plugin->getPosition();
$cssValue = $position->value; // 'bottom-center'
```

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

### Configure Light Switch for Filament Panels

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Configure the Light Switch plugin's position independently for different Filament panels. This allows for tailored placement in admin and app panels.

```php
// Admin panel
->plugins([
    LightSwitchPlugin::make()->position(Alignment::TopRight),
])

// App panel
->plugins([
    LightSwitchPlugin::make()->position(Alignment::BottomLeft),
])
```

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

### Package Name Property

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-service-provider.md

Defines the static package name used for discovery and resource resolution.

```php
public static string $name = 'light-switch';
```

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

### LightSwitchPlugin::get()

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-plugin.md

Retrieves the registered plugin instance from Filament's container. Use this to access an already registered plugin.

```APIDOC
## LightSwitchPlugin::get()

### Description
Retrieves the registered plugin instance from Filament's container.

### Method
static `get`

### Parameters
No parameters.

### Returns
`static` - The registered plugin instance.

### Example
```php
$plugin = LightSwitchPlugin::get();
```
```

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

### Check Enabled Routes for Light Switch Plugin

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-plugin.md

Retrieves the array of routes the switcher is enabled on. Returns `null` if not explicitly set.

```php
$routes = LightSwitchPlugin::make()
    ->enabledOn(['auth.login', 'auth.register'])
    ->isEnabledOn();
// Result: ['auth.login', 'auth.register']
```

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

### Configure Enabled Routes for Light Switch Plugin

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-plugin.md

Use `enabledOn` to restrict the theme switcher's visibility to specific route names. It supports partial route matching.

```php
use Awcodes\LightSwitch\LightSwitchPlugin;

$plugin = LightSwitchPlugin::make()
    ->enabledOn([
        'auth.email',
        'auth.login',
        'auth.password',
        'auth.register',
    ]);
```

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

### Button Component Usage

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/views-and-components.md

Demonstrates how to use the button component for light, dark, and system themes in the switcher view.

```blade
<x-light-switch::button
    icon="heroicon-m-sun"
    theme="light"
/>

<x-light-switch::button
    icon="heroicon-m-moon"
    theme="dark"
/>

<x-light-switch::button
    icon="heroicon-m-computer-desktop"
    theme="system"
/>

```

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

### Access Plugin Instance and Position in View

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/architecture-and-integration.md

Retrieves the Light Switch plugin instance and its configured position within the Filament panel. This is used to conditionally render the switcher UI.

```php
$plugin = filament('awcodes/light-switch');
$alignment = $plugin->getPosition()->value;
```

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

### Theme Preference Storage

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/views-and-components.md

Demonstrates reading and writing the user's theme preference to localStorage. This ensures the choice persists across sessions.

```javascript
localStorage.getItem('theme')  // Read on init
localStorage.setItem('theme', value) // Filament saves when changed
```

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

### Light Switch Source Code Structure

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/INDEX.md

Overview of the directory structure for the Light Switch plugin's source code, indicating which files are documented in specific API reference files.

```text
Light Switch Source (src/)
├── LightSwitchPlugin.php          ← Documented in api-reference/light-switch-plugin.md
├── LightSwitchServiceProvider.php  ← Documented in api-reference/light-switch-service-provider.php
└── Enums/
    └── Alignment.php              ← Documented in api-reference/alignment-enum.md, types.md

Light Switch Views (resources/views/)
├── switcher.blade.php             ← Documented in views-and-components.md
└── components/
    └── button.blade.php           ← Documented in views-and-components.md
```

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

### Position Light Switch at Bottom-Center

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Set the Light Switch plugin's position to the bottom-center of the screen. Ensure the Alignment enum is imported.

```php
use Awcodes\LightSwitch\Enums\Alignment;

LightSwitchPlugin::make()
    ->position(Alignment::BottomCenter)
```

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

### Configure Package Method

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-service-provider.md

Configures the Laravel package, including setting the package name and registering views. This method is called automatically during service provider boot.

```php
public function configurePackage(Package $package): void
{
    // Called automatically by Laravel
    // Typically in your panel provider:
    use Awcodes\LightSwitch\LightSwitchPlugin;

    $panel->plugins([
        LightSwitchPlugin::make(),
    ]);
    // The service provider is auto-discovered and configurePackage() is called
}
```

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

### Theme Persistence - Reading from Local Storage

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Demonstrates how to read the saved theme preference from the browser's localStorage on page load.

```javascript
localStorage.getItem('theme')  // Read on page load
```

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

### Configure Package Method

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Configures the Laravel package for discovery and asset publishing. This method is called automatically during Laravel's service provider boot phase.

```php
public function configurePackage(Package $package): void
```

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

### Dynamic Button Styling

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/views-and-components.md

Illustrates the Alpine.js binding for dynamically applying CSS classes based on the current theme state.

```javascript
x-bind:class="
    theme === @js($theme)
        ? 'bg-gray-50 text-primary-500 dark:bg-white/5 dark:text-primary-400'
        : 'text-gray-400 hover:text-gray-500 focus:text-gray-500 dark:text-gray-500 dark:hover:text-gray-400 dark:focus:text-gray-400'
"

```

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

### Configure Light Switch Plugin

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Customize the Light Switch plugin's position and enable it on specific pages. This allows for fine-grained control over its appearance and behavior.

```php
use Awcodes\LightSwitch\Enums\Alignment;

LightSwitchPlugin::make()
    ->position(Alignment::BottomCenter)
    ->enabledOn([
        'auth.login',
        'auth.register',
    ])
```

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

### Configuring LightSwitchPlugin Position

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/alignment-enum.md

Sets the theme switcher position using an Alignment enum case and retrieves the configured position.

```php
use Awcodes\LightSwitch\LightSwitchPlugin;
use Awcodes\LightSwitch\Enums\Alignment;

$plugin = LightSwitchPlugin::make()
    ->position(Alignment::BottomCenter);

// Get the configured position
$current = $plugin->getPosition();  // Returns: Alignment::BottomCenter
```

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

### Default LightSwitchPlugin Position

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/alignment-enum.md

Illustrates that if no position is explicitly set, the Light Switch plugin defaults to Alignment::TopRight.

```php
$plugin = LightSwitchPlugin::make();
// No position set

$position = $plugin->getPosition();  // Returns: Alignment::TopRight
```

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

### Configure Light Switch Position

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/usage-examples.md

Configure the position of the light switch. Defaults to top-right and shows on auth.login, auth.password, auth.register.

```php
use Awcodes\LightSwitch\LightSwitchPlugin;

LightSwitchPlugin::make()
    // Defaults to top-right, shows on auth.login, auth.password, auth.register
```

```php
use Awcodes\LightSwitch\LightSwitchPlugin;
use Awcodes\LightSwitch\Enums\Alignment;

LightSwitchPlugin::make()
    ->position(Alignment::BottomCenter)
```

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

### Configure Filament Panel with Dark Mode Disabled

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/usage-examples.md

When dark mode is explicitly disabled in the Filament panel configuration, the light switch switcher will not be displayed.

```php
public function panel(Panel $panel): Panel
{
    return $panel
        ->darkMode(false)  // Disable dark mode
        ->plugins([
            LightSwitchPlugin::make(),
        ]);
}
```

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

### Check if Switcher Should Display

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Use the `shouldShowSwitcher()` method to determine if the light switcher is currently visible based on the page's route and plugin configuration.

```php
$plugin->shouldShowSwitcher()
```

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

### Configure Light Switch Position

Source: https://github.com/awcodes/light-switch/blob/3.x/README.md

Customize the position of the theme switcher on authentication pages by using the `position()` method with an `Alignment` enum case.

```php
use Awcodes\LightSwitch\LightSwitchPlugin;
use Awcodes\LightSwitch\Enums\Alignment;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            LightSwitchPlugin::make()
                ->position(Alignment::BottomCenter),
        ]);
}
```

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

### View Namespace Property

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-service-provider.md

Defines the static namespace for view and component resolution. Views are referenced using this namespace.

```php
public static string $viewNamespace = 'light-switch';
```

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

### Button Template Structure

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/views-and-components.md

Outlines the HTML structure of the button component, including dynamic styling, click handlers, and icon rendering.

```html
<button
    aria-label="{{ $label }}"
    type="button"
    x-bind:class="..."           <!-- Dynamic styling -->
    x-on:click="(theme = ...)"   <!-- Click handler -->
    x-tooltip="{...}"             <!-- Tooltip directive -->
    class="flex justify-center..." <!-- Static classes -->
>
    <x-filament::icon ... />      <!-- Filament icon -->
</button>

```

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

### Tooltip Integration for Button

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/views-and-components.md

Shows how to use Alpine.js's tooltip directive to display a localized label on hover, respecting the current theme.

```javascript
x-tooltip="{
    content: @js($label),
    theme: $store.theme,
}"

```

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

### Tooltip for Theme Name

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/views-and-components.md

Displays a tooltip on hover showing the theme name. The tooltip content is dynamically set using JavaScript.

```php
x-tooltip={
    content: @js($label),
    theme: $store.theme,
}
```

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

### Theme Persistence - Saving to Local Storage

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Shows how to save the selected theme value to the browser's localStorage when the theme is changed.

```javascript
localStorage.setItem('theme', value) // Saved when changed
```

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

### Enable Switcher on Specific Routes

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/configuration.md

Restrict the switcher's visibility to a defined list of routes using partial string matching. Provide an array of route name strings.

```php
LightSwitchPlugin::make()
    ->enabledOn([
        'auth.email',
        'auth.login',
        'auth.password',
        'auth.profile',
        'auth.register',
    ])
```

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

### position

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Configures the position of the theme switcher on the page. Accepts an Alignment enum case.

```APIDOC
## position

### Description
Configures the position of the theme switcher on the page.

### Method
`public function position(Alignment $position): static`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **position** (`Awcodes\LightSwitch\Enums\Alignment`) - Required - An alignment enum case from `Awcodes\LightSwitch\Enums\Alignment`

### Returns
- `static` — The plugin instance for method chaining

### Throws
Nothing

### Valid Values:
- `Alignment::TopLeft`
- `Alignment::TopCenter`
- `Alignment::TopRight`
- `Alignment::BottomLeft`
- `Alignment::BottomCenter`
- `Alignment::BottomRight`

### Default:
`Alignment::TopRight`

### Example:
```php
use Awcodes\LightSwitch\LightSwitchPlugin;
use Awcodes\LightSwitch\Enums\Alignment;

LightSwitchPlugin::make()
    ->position(Alignment::BottomCenter)
```
```

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

### Configure Filament Panel with Forced Dark Mode

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/usage-examples.md

If dark mode is forced on the Filament panel, the light switch switcher will not appear as there is no need for user selection.

```php
public function panel(Panel $panel): Panel
{
    return $panel
        ->darkMode(true)
        ->forceDarkModeForced()  // Force dark mode always
        ->plugins([
            LightSwitchPlugin::make(),
        ]);
}
```

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

### Set Light Switch Plugin Alignment

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/usage-examples.md

Configure the alignment of the Light Switch plugin using the `Alignment` enum. The default position is TopRight.

```php
use Awcodes\LightSwitch\Enums\Alignment;
use Awcodes\LightSwitch\LightSwitchPlugin;

// Top row
LightSwitchPlugin::make()->position(Alignment::TopLeft);    // ↖
LightSwitchPlugin::make()->position(Alignment::TopCenter);  // ↑
LightSwitchPlugin::make()->position(Alignment::TopRight);   // ↗ (default)

// Bottom row
LightSwitchPlugin::make()->position(Alignment::BottomLeft);   // ↙
LightSwitchPlugin::make()->position(Alignment::BottomCenter); // ↓
LightSwitchPlugin::make()->position(Alignment::BottomRight);  // ↘
```

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

### Dynamic Container Classes

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/views-and-components.md

Generates CSS classes for the switcher container based on the `$alignment` variable, controlling its position and alignment on the screen.

```php
@class([
    'fixed w-full flex p-4 z-40 auth-theme-switcher',
    'top-0' => str_contains($alignment, 'top'),
    'bottom-0' => str_contains($alignment, 'bottom'),
    'justify-start' => str_contains($alignment, 'left'),
    'justify-end' => str_contains($alignment, 'right'),
    'justify-center' => str_contains($alignment, 'center'),
])
```

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

### Determine if Theme Switcher Should Display

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Checks if the theme switcher should be visible on the current page based on route name. Route matching is case-sensitive.

```php
public function shouldShowSwitcher(): bool
```

```php
// In a route named 'admin.auth.login'
if (LightSwitchPlugin::get()->shouldShowSwitcher()) {
    // Switcher is enabled for this route
}

// With custom routes
LightSwitchPlugin::make()
    ->enabledOn(['auth.register'])
    ->shouldShowSwitcher(); // true only on auth.register routes
```

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

### Iterating Over Alignment Enum Cases

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/alignment-enum.md

Shows how to iterate through all available Alignment enum cases to access their names and values.

```php
foreach (Alignment::cases() as $position) {
    echo $position->name;    // TopLeft, TopCenter, etc.
    echo $position->value;   // top-left, top-center, etc.
}
```

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

### Set Enabled Routes

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/README.md

Use the static `enabledOn()` method to specify an array of routes where the switcher should be active. If not set, it defaults to specific authentication routes.

```php
LightSwitchPlugin::enabledOn(['route.name.one', 'route.name.two'])
```

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

### Check if Switcher Should Show

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/configuration.md

Determine if the switcher should be displayed on the current request using the `shouldShowSwitcher` method. Checks Filament's dark mode settings and route enablement.

```php
// In a Blade view with access to the plugin
@if (LightSwitchPlugin::get()->shouldShowSwitcher()) @endif
```

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

### Retrieve Registered LightSwitchPlugin Instance

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-plugin.md

This method retrieves the plugin instance already registered within Filament's container. No parameters are required.

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

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

### LightSwitchPlugin::getPosition

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Retrieves the configured position of the theme switcher. Defaults to `Alignment::TopRight` if not explicitly set.

```APIDOC
## LightSwitchPlugin::getPosition

### Description
Retrieves the configured position of the theme switcher. Defaults to `Alignment::TopRight` if not explicitly set.

### Method
`public function getPosition(): Alignment`

### Parameters
None

### Request Example
```php
use Awcodes\LightSwitch\LightSwitchPlugin;
use Awcodes\LightSwitch\Enums\Alignment;

$position = LightSwitchPlugin::get()->getPosition();

if ($position === Alignment::TopRight) {
    // Position is top-right
}

// Get string value
$cssValue = $position->value;  // 'top-right'
```

### Response
#### Success Response
`Alignment` - The position enum case.

#### Response Example
```json
{
  "position": "top-right" 
}
```
```

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

### Alpine.js Theme Management

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/views-and-components.md

Manages the theme state using Alpine.js, reading from localStorage or Filament's default, and dispatching a 'theme-changed' event on initialization and changes.

```javascript
x-data="{
    theme: null,

    init: function () {
        this.theme = localStorage.getItem('theme') 
                  || @js(filament()->getDefaultThemeMode()->value)

        $dispatch('theme-changed', theme)

        $watch('theme', (theme) => {
            $dispatch('theme-changed', theme)
        })
    },
}"
```

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

### getPosition

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-plugin.md

Retrieves the configured position of the theme switcher.

```APIDOC
## getPosition

### Description
Retrieves the configured position of the theme switcher.

### Method
`public function getPosition(): Alignment`

### Parameters
#### Path Parameters
No path parameters.

#### Query Parameters
No query parameters.

#### Request Body
No request body.

### Parameters
#### No parameters

### Returns
- `Alignment` — The position enum case. Defaults to `Alignment::TopRight` if not set.

### Example
```php
$position = LightSwitchPlugin::make()
    ->position(Alignment::BottomLeft)
    ->getPosition();
// Result: Alignment::BottomLeft
```
```

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

### Deriving Button Label

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/views-and-components.md

Shows how to retrieve the localized label for the button based on the theme using Filament's translation system.

```php
$label = __("filament-panels::layout.actions.theme_switcher.{$theme}.label");

```

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

### register

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-plugin.md

Registers the Light Switch plugin with a Filament Panel. It hooks the theme switcher view into the panel's body end render hook.

```APIDOC
## register

### Description
Registers the Light Switch plugin with a Filament Panel. It hooks the theme switcher view into the panel's body end render hook.

### Method
`register`

### Parameters
#### Path Parameters
- **panel** (`Panel`) - Required - The Filament Panel instance

### Returns
`void`
```

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

### Configure Theme Switcher Position

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Sets the alignment of the theme switcher on the page. Use an enum case from `Awcodes\LightSwitch\Enums\Alignment`.

```php
public function position(Alignment $position): static
```

```php
use Awcodes\LightSwitch\LightSwitchPlugin;
use Awcodes\LightSwitch\Enums\Alignment;

LightSwitchPlugin::make()
    ->position(Alignment::BottomCenter)
```

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

### Add Plugin Views to Theme CSS

Source: https://github.com/awcodes/light-switch/blob/3.x/README.md

After setting up a custom theme, include the plugin's views in your theme's CSS file or your application's main CSS file.

```css
@source '../../../../vendor/awcodes/light-switch/resources/**/*.blade.php';
```

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

### register

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Called when the plugin is registered with a Filament Panel. Injects the render hook.

```APIDOC
## register

### Description
Called when the plugin is registered with a Filament Panel. Injects the render hook.

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

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **panel** (`Panel`) - Required - The Filament Panel instance

### Returns
- `void`

### Throws
Nothing

### Notes:
- Called automatically by Filament during plugin registration
- Registers a render hook for `'panels::body.end'`
- The hook renders the `'light-switch::switcher'` view

### Internal Actions:
1. Calls `$panel->renderHook()` with hook name `'panels::body.end'`
2. Registers closure that returns `view('light-switch::switcher')`
3. View is rendered on every page load, but visibility is controlled within the view
```

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

### Check Light Switch Plugin State in Blade Templates

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/usage-examples.md

Use Blade directives to access the plugin instance and conditionally render content based on its position or visibility.

```blade
@php
    $plugin = LightSwitchPlugin::get();
@endphp

@if ($plugin->getPosition() === Alignment::TopRight)
    <!-- Plugin is positioned top-right -->
@endif

@if ($plugin->shouldShowSwitcher())
    <!-- Switcher is being displayed -->
@endif
```

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

### Alignment Enum Cases

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/alignment-enum.md

Defines the possible positions for the theme switcher. Each case has a string value representing its position.

```php
case TopLeft = 'top-left';
```

```php
case TopCenter = 'top-center';
```

```php
case TopRight = 'top-right';
```

```php
case BottomLeft = 'bottom-left';
```

```php
case BottomCenter = 'bottom-center';
```

```php
case BottomRight = 'bottom-right';
```

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

### shouldShowSwitcher

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Determines whether the theme switcher should display on the current page.

```APIDOC
## shouldShowSwitcher

### Description
Determines whether the theme switcher should display on the current page.

### Method
`public function shouldShowSwitcher(): bool`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
None

### Returns
- `bool` — `true` if switcher should display, `false` otherwise

### Throws
Nothing

### Logic:
Checks if the current route name (via `request()->route()->getName()`) contains any string from:
- Explicitly configured routes (from `enabledOn()`)
- OR default routes: `['auth.login', 'auth.password', 'auth.register']`

Uses `Str::contains()` for matching.

### Notes:
- Requires a route to be set on the request
- Used internally by the Blade template
- Route matching is case-sensitive

### Example:
```php
// In a route named 'admin.auth.login'
if (LightSwitchPlugin::get()->shouldShowSwitcher()) {
    // Switcher is enabled for this route
}

// With custom routes
LightSwitchPlugin::make()
    ->enabledOn(['auth.register'])
    ->shouldShowSwitcher(); // true only on auth.register routes
```
```

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

### Register Light Switch Plugin with Filament Panel

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Injects the render hook for the theme switcher when the plugin is registered with a Filament Panel. This method is called automatically by Filament.

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

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

### position

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-plugin.md

Sets the position of the theme switcher on the page. Supports nine positions (top/bottom, left/center/right).

```APIDOC
## position

### Description
Sets the position of the theme switcher on the page. Supports nine positions (top/bottom, left/center/right).

### Method
`position`

### Parameters
#### Path Parameters
- **position** (`Alignment`) - Required - An `Alignment` enum case specifying the switcher position

### Returns
`static` - The plugin instance for method chaining

### Example
```php
use Awcodes\LightSwitch\LightSwitchPlugin;
use Awcodes\LightSwitch\Enums\Alignment;

$plugin = LightSwitchPlugin::make()
    ->position(Alignment::BottomCenter);
```
```

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

### Visibility Conditions for Switcher

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/views-and-components.md

The theme switcher is rendered only when dark mode is enabled in Filament, not forced, and the current route matches the routes configured in the plugin.

```php
filament()->hasDarkMode() &&           // Dark mode enabled
(! filament()->hasDarkModeForced()) && // Dark mode not forced
$plugin->shouldShowSwitcher()          // Current route matches enabled routes
```

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

### Match Multiple Patterns with enabledOn()

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/usage-examples.md

Provide an array of strings to `enabledOn()` to match multiple route patterns. Supports exact segments and partial containment.

```php
LightSwitchPlugin::make()
    ->enabledOn([
        'auth.login',      // Any auth.login route
        'auth.password',   // Any auth.password route
        '.register'        // Any route containing .register
    ])
```

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

### shouldShowSwitcher

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-plugin.md

Determines whether the theme switcher should be displayed on the current page by checking if the current route matches the enabled routes. If no routes are explicitly enabled, it defaults to a predefined list.

```APIDOC
## shouldShowSwitcher

### Description
Determines whether the theme switcher should be displayed on the current page. Checks if the current route matches the enabled routes. If no routes are explicitly enabled, defaults to `['auth.login', 'auth.password', 'auth.register']`.

### Method
```php
public function shouldShowSwitcher(): bool
```

### Parameters
No parameters

### Returns
`bool` — `true` if the switcher should be shown, `false` otherwise

### Example
```php
// In a route named 'auth.login'
$show = LightSwitchPlugin::get()->shouldShowSwitcher();
// Result: true

// When enabledOn is configured
LightSwitchPlugin::make()
    ->enabledOn(['auth.register'])
    ->shouldShowSwitcher(); // Returns true only on auth.register routes
```
```

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

### Set Switcher Position

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/configuration.md

Configure the placement of the theme switcher on auth pages using the `position` method. Accepts an Alignment enum case.

```php
use Awcodes\LightSwitch\LightSwitchPlugin;
use Awcodes\LightSwitch\Enums\Alignment;

LightSwitchPlugin::make()
    ->position(Alignment::BottomCenter)
```

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

### Comparing Alignment Enum Cases

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/alignment-enum.md

Compares the current theme switcher position with specific Alignment enum cases using identity operators.

```php
$position = LightSwitchPlugin::get()->getPosition();

if ($position === Alignment::TopRight) {
    // Position is top-right
}

if ($position === Alignment::BottomCenter) {
    // Position is bottom-center
}

// Check for multiple positions
if (in_array($position, [Alignment::TopLeft, Alignment::TopCenter, Alignment::TopRight])) {
    // Switcher is at the top
}
```

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

### Filament Icon Rendering

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/views-and-components.md

Demonstrates the usage of Filament's icon component to render theme-specific icons with custom aliases.

```blade
<x-filament::icon
    :alias="'panels::theme-switcher.' . $theme . '-button'"
    :icon="$icon"
    class="h-5 w-5"
/>

```

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

### Register Light Switch Plugin

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-plugin.md

Called when the plugin is registered with a Filament Panel. Hooks the theme switcher view into the panel's body end render hook.

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

```php
// Called automatically by Filament during plugin registration
$panel->plugins([
    LightSwitchPlugin::make(),
]);
// The switcher view is automatically injected at the end of the panel body
```

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

### LightSwitchPlugin::get

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/method-reference.md

Retrieves the registered plugin instance from Filament's container. This method must be called after the plugin has been registered.

```APIDOC
## LightSwitchPlugin::get

### Description
Retrieves the registered plugin instance from Filament's container. This method must be called after the plugin has been registered.

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

### Parameters
None

### Request Example
```php
use Awcodes\LightSwitch\LightSwitchPlugin;

$plugin = LightSwitchPlugin::get();
$position = $plugin->getPosition();
```

### Response
#### Success Response
`static` - The registered LightSwitchPlugin instance.

#### Response Example
```json
// Returns the plugin instance, no specific JSON response.
```
```

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

### Register Light Switch Plugin in Filament Panel

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/installation-and-setup.md

Register the LightSwitchPlugin in your Filament panel configuration, typically within the panel provider class.

```php
use Filament\Panel;
use Awcodes\LightSwitch\LightSwitchPlugin;

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

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

### Route Name Matching for Visibility

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/architecture-and-integration.md

Determines if the current route name contains any of the specified enabled routes. This logic is forgiving and allows for partial matches.

```php
Str::of(request()->route()->getName())
    ->contains($this->isEnabledOn() ?? [
        'auth.login',
        'auth.password',
        'auth.register',
    ])
```

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

### Composer Package Registration

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/api-reference/light-switch-service-provider.md

Configuration in composer.json to ensure the service provider is automatically registered via Laravel's package discovery.

```json
"extra": {
    "laravel": {
        "providers": [
            "Awcodes\\LightSwitch\\LightSwitchServiceProvider"
        ]
    }
}
```

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

### Inject Render Hook for Theme Switcher

Source: https://github.com/awcodes/light-switch/blob/3.x/_autodocs/architecture-and-integration.md

This code snippet shows how the plugin injects its view into the Filament panel's body. The `panels::body.end` hook ensures the switcher UI is rendered at the end of the page body.

```php
$panel->renderHook(
    name: 'panels::body.end',
    hook: fn (): View => view('light-switch::switcher')
);
```
Tokens:
Raw