Flux

https://github.com/livewire/flux
Admin
Flux is a robust, hand-crafted UI component library for Livewire applications built with Tailwind...
Tokens:74,647
Snippets:591
Trust Score:9.2
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### ensurePro() method

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/flux.md

Throws an exception if the livewire/flux-pro package is not installed. The example shows both passing and throwing cases.

```php
if (Flux::pro()) {
    Flux::ensurePro(); // passes
} else {
    Flux::ensurePro(); // throws \Exception
}
```

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

### Usage examples for toast()

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/interacts-with-components.md

Shows basic and full-option usage of toast(), including a try/catch example with error-handling-friendly variant.

```php
// Basic toast
Flux::toast('Your changes were saved.', 'Success');

// Full options, with error-handling-friendly variant
try {
    // ... some work ...
    Flux::toast('Saved', duration: 3000, variant: 'success', position: 'top end');
} catch (\Throwable $e) {
    Flux::toast($e->getMessage(), heading: 'Oops', variant: 'danger');
}
```

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

### applyInset usage examples

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/flux.md

Two examples showing how applyInset returns classes for all sides or only selected sides.

```php
Flux::applyInset(true, top: '-mt-2.5', right: '-me-2.5', bottom: '-mb-2.5', left: '-ms-2.5');
// => "-mt-2.5 -me-2.5 -mb-2.5 -ms-2.5"
```

```php
Flux::applyInset('top left', top: '-mt-2.5', right: '-me-2.5', bottom: '-mb-2.5', left: '-ms-2.5');
// => "-mt-2.5 -ms-2.5"
```

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

### Usage example with DateTimeRange

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-time-range.md

Shows how to create a DateTimeRange and use its methods. The range is constructed with explicit start and end datetimes, and the start/end methods return Carbon instances that can be formatted.

```php
use Flux\DateTimeRange;

$range = new DateTimeRange('2024-01-01 09:00', '2024-01-15 17:30');

$range->start()->format('Y-m-d H:i'); // 2024-01-01 09:00
$range->end()->format('Y-m-d H:i');   // 2024-01-15 17:30
$range->hasStart(); // true
$range->hasEnd();   // true
```

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

### GET /flux/editor.css

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the CSS file for the Flux editor. This endpoint requires the livewire/flux-pro package to be installed; otherwise, it returns a 500 error.

```APIDOC
## GET /flux/editor.css

### Description
Serves the CSS file for the Flux editor. This endpoint requires the livewire/flux-pro package to be installed; otherwise, it returns a 500 error.

### Method
GET

### Endpoint
/flux/editor.css

### Response
#### Success Response (200)
- **Content-Type:** text/css
- **Body:** The contents of `flux-pro/dist/editor.css`.

#### Error Response (500)
- **Body:** Exception message: "Flux Pro is required to use the Flux editor."

#### Status Codes
- **200** - File served successfully.
- **304** - Cache hit (not modified).
- **500** - Flux Pro is not installed.
```

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

### Install Flux via Composer

Source: https://github.com/livewire/flux/blob/main/README.md

Run this command from your project's root directory to install the livewire/flux package. Requires Laravel v10.0+, Livewire v3.5.19+, and Tailwind CSS v4.0+.

```bash
composer require livewire/flux
```

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

### GET /flux/flux.js

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the main Flux JavaScript file. If the Pro package is installed, it serves the Pro version; otherwise, it serves the lite version. The optional id query parameter is used as a cache-busting token.

```APIDOC
## GET /flux/flux.js

### Description
Serves the main Flux JavaScript file. If the Pro package is installed, it serves the Pro version; otherwise, it serves the lite version. The optional id query parameter is used as a cache-busting token.

### Method
GET

### Endpoint
/flux/flux.js

### Parameters
#### Query Parameters
- **id** (string) - Optional - Version hash used as a cache-busting token. The served file ignores it.

### Response
#### Success Response (200)
- **Content-Type:** text/javascript
- **Body:** The contents of `flux-pro/dist/flux.js` (if Pro installed) or `flux/dist/flux-lite.min.js` (otherwise).

#### Status Codes
- **200** - File served successfully.
- **304** - Cache hit (not modified).
```

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

### Example flux:publish commands

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/console-commands.md

Shows how to publish all components or specific components with the --force flag.

```bash
# Publish everything
php artisan flux:publish --all

# Publish specific components
php artisan flux:publish button dropdown --force
```

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

### DateRange start() method

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-range.md

Returns the start date of the period as a Carbon instance or null.

```php
public function start(): ?Carbon
```

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

### fluxAppearance() usage example

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/asset-manager.md

Example of calling AssetManager::fluxAppearance to output the appearance style and script.

```php
echo AssetManager::fluxAppearance();
```

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

### GET /flux/editor.min.js

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the minified JavaScript file for the Flux editor. This endpoint requires the livewire/flux-pro package to be installed; otherwise, it returns a 500 error.

```APIDOC
## GET /flux/editor.min.js

### Description
Serves the minified JavaScript file for the Flux editor. This endpoint requires the livewire/flux-pro package to be installed; otherwise, it returns a 500 error.

### Method
GET

### Endpoint
/flux/editor.min.js

### Response
#### Success Response (200)
- **Content-Type:** text/javascript
- **Body:** The contents of `flux-pro/dist/editor.min.js`.

#### Error Response (500)
- **Body:** Exception message: "Flux Pro is required to use the Flux editor."

#### Status Codes
- **200** - File served successfully.
- **304** - Cache hit (not modified).
- **500** - Flux Pro is not installed.
```

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

### DateRange::hasStart()

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-range.md

Checks whether the start date is set.

```APIDOC
## DateRange::hasStart()

### Description
Checks whether the start date is set.

### Method
Method

### Signature
```php
public function hasStart(): bool
```

### Returns
- **bool** - `true` when the start date is not `null`.

### Source
`src/DateRange.php:32`
```

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

### allTime($start) static method implementation

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-range.md

Defines the allTime static method that creates a DateRange from a start date to now, tagged with the AllTime preset. This is the only way to build an AllTime range because fromPreset() throws for AllTime.

```php
public static function allTime($start) {
    $instance = new static(Carbon::parse($start), Carbon::now());

    $instance->preset = DateRangePreset::AllTime;

    return $instance;
}
```

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

### Usage examples for flux:icon

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/console-commands.md

Shows how to import specific icons or run the interactive loop.

```bash
# Import specific icons
php artisan flux:icon arrow-left arrow-right

# Interactive loop
php artisan flux:icon
```

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

### GET /flux/editor.js

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the JavaScript file for the Flux editor. This endpoint requires the livewire/flux-pro package to be installed; otherwise, it returns a 500 error.

```APIDOC
## GET /flux/editor.js

### Description
Serves the JavaScript file for the Flux editor. This endpoint requires the livewire/flux-pro package to be installed; otherwise, it returns a 500 error.

### Method
GET

### Endpoint
/flux/editor.js

### Response
#### Success Response (200)
- **Content-Type:** text/javascript
- **Body:** The contents of `flux-pro/dist/editor.js`.

#### Error Response (500)
- **Body:** Exception message: "Flux Pro is required to use the Flux editor."

#### Status Codes
- **200** - File served successfully.
- **304** - Cache hit (not modified).
- **500** - Flux Pro is not installed.
```

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

### hasStart(): bool method

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-time-range.md

Returns true if the start date is set, false otherwise.

```php
public function hasStart(): bool
{
    return $this->getStartDate() !== null;
}
```

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

### Livewire component property example

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-time-range.md

Shows a DateTimeRange used as a Livewire component property. The component dispatches an event with the start and end datetimes when the period is set.

```php
use Flux\DateTimeRange;

class ReportFilter extends \Livewire\Component
{
    public ?DateTimeRange $period = null;

    public function apply()
    {
        if ($this->period) {
            $this->dispatch('period-updated', from: $this->period->start(), to: $this->period->end());
        }
    }
}
```

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

### fluxJs()

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/asset-manager.md

Serves the full flux.js when Flux Pro is installed, otherwise the lite bundle flux-lite.min.js.

```APIDOC
## GET /flux.js

### Description
Serves the full flux.js when Flux Pro is installed, otherwise the lite bundle flux-lite.min.js.

### Method
GET

### Endpoint
/flux.js

### Parameters
None

### Request Example
GET /flux.js

### Response
#### Success Response (200)
- **Content-Type**: text/javascript
- **Body**: JavaScript file content (flux.js or flux-lite.min.js)

#### Response Example
(JavaScript file content)
```

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

### bootComponents() method

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/interacts-with-components.md

Called from FluxManager::boot(). Installs the modal() component macro by invoking bootModal(). Returns void.

```php
public function bootComponents()
{
    $this->bootModal();
}
```

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

### DateRange::allTime($start)

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-range.md

Creates a DateRange from a given start date to now, tagged with the AllTime preset. This is the only way to build an AllTime range.

```APIDOC
## DateRange::allTime($start)

### Description
Creates a DateRange from a given start date to now, tagged with the AllTime preset. This is the only way to build an AllTime range.

### Method
static

### Signature
`public static function allTime($start): DateRange`

### Parameters
- **$start** (string|Carbon) - Required - Start date, parsed via `Carbon::parse()`.

### Returns
- **DateRange** - A range from `$start` to `Carbon::now()`, tagged with the `AllTime` preset.

### Example
```php
use Flux\DateRange;

$all = DateRange::allTime('2020-01-01');
$all->preset(); // DateRangePreset::AllTime
$all->isNotAllTime(); // false
```
```

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

### GET /flux/flux.min.js

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the minified version of the main Flux JavaScript file. Similar to /flux/flux.js, it serves the Pro or free version depending on the installed package.

```APIDOC
## GET /flux/flux.min.js

### Description
Serves the minified version of the main Flux JavaScript file. Similar to /flux/flux.js, it serves the Pro or free version depending on the installed package.

### Method
GET

### Endpoint
/flux/flux.min.js

### Response
#### Success Response (200)
- **Content-Type:** text/javascript
- **Body:** The contents of `flux-pro/dist/flux.min.js` (if Pro installed) or `flux/dist/flux-lite.min.js` (otherwise).

#### Status Codes
- **200** - File served successfully.
- **304** - Cache hit (not modified).
```

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

### DateRangePreset::dates(?Carbon $start = null)

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-range.md

Computes the start and end Carbon instances for the preset. The $start parameter is used only by the AllTime case as the range start. Returns an array of two Carbon instances [start, end] relative to Carbon::now().

```APIDOC
## DateRangePreset::dates(?Carbon $start = null)

### Description
Computes the start and end Carbon instances for the preset. The `$start` parameter is used only by the `AllTime` case as the range start. Returns an array of two Carbon instances `[start, end]` relative to `Carbon::now()`.

### Method
`dates`

### Parameters
- `$start` (?Carbon) - Optional - Used only by the `AllTime` case as the range start.

### Returns
- `array{0: Carbon, 1: Carbon}` - `[start, end]` Carbon instances computed relative to `Carbon::now()`.

### Source
`src/DateRangePreset.php:38`
```

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

### DateRange hasStart() method

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-range.md

Returns true if the start date is not null.

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

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

### pro() method

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/flux.md

Returns true when Composer reports livewire/flux-pro as installed, false otherwise.

```php
public function pro()
```

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

### Usage example for modals()

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/interacts-with-components.md

Shows how to close all open modals using the modals() method.

```php
Flux::modals()->close(); // close all modals
```

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

### scripts() usage example

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/asset-manager.md

Example of calling AssetManager::scripts with a nonce option, producing a script tag with nonce attribute.

```php
echo AssetManager::scripts(['nonce' => 'abc']); // <script src="/flux/flux.min.js?id=c60bf509" data-navigate-once nonce="abc"></script>
```

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

### GET /flux/flux.min.js

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the minified Flux JS bundle.

```APIDOC
## GET /flux/flux.min.js

### Description
Serves the minified Flux JS bundle.

### Method
GET

### Endpoint
/flux/flux.min.js

### Response
#### Success Response (200)
- **Content-Type**: Per-route (JavaScript)
- **Expires**: +1 year (RFC 7231 HTTP date, GMT)
- **Cache-Control**: public, max-age=31536000
- **Last-Modified**: HTTP date of filemtime($file)
- **Content-Encoding**: br when the served file ends with .br

#### Response Example
(File body)

#### Conditional Response (304)
If the request sends an If-Modified-Since header whose parsed timestamp equals the file's mtime, the server returns HTTP 304 with Expires and Cache-Control headers (no body).
```

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

### fluxJs() method implementation

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/asset-manager.md

Serves the full flux.js when Flux Pro is installed, otherwise the lite bundle flux-lite.min.js, with content type text/javascript.

```php
public function fluxJs() {
    return Flux::pro()
        ? $this->pretendResponseIsFile(__DIR__.'/../../flux-pro/dist/flux.js', 'text/javascript')
        : $this->pretendResponseIsFile(__DIR__.'/../../flux/dist/flux-lite.min.js', 'text/javascript');
}
```

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

### phoneMinJs() method

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/asset-manager.md

Returns the phone.min.js file as a response. Throws an exception if Flux Pro is not installed.

```php
public function phoneMinJs() {
    if (! Flux::pro()) throw new \Exception('Flux Pro is required to use the Flux phone input.');

    return $this->pretendResponseIsFile(__DIR__.'/../../flux-pro/dist/phone.min.js', 'text/javascript');
}
```

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

### phoneUtilsJs() method

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/asset-manager.md

Returns the phone-utils.js file as a response. Throws an exception if Flux Pro is not installed.

```php
public function phoneUtilsJs() {
    if (! Flux::pro()) throw new \Exception('Flux Pro is required to use the Flux phone input.');

    return $this->pretendResponseIsFile(__DIR__.'/../../flux-pro/dist/phone-utils.js', 'text/javascript');
}
```

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

### AllTime preset via fromPreset throwing exception

Source: https://github.com/livewire/flux/blob/main/_autodocs/errors.md

Throws an exception when DateRange::fromPreset(DateRangePreset::AllTime) is called because it requires a start date. Message: 'All time date range is not supported via this constructor because it requires a start date. Please use the ::allTime($start) constructor instead.' Source: src/DateRange.php:52-63.

```php
if ($preset === DateRangePreset::AllTime) {
    throw new \Exception('All time date range is not supported via this constructor because it requires a start date. Please use the ::allTime($start) constructor instead.');
}
```

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

### phoneJs() method implementation

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/asset-manager.md

Serves flux-pro/dist/phone.js with content type text/javascript, throwing an exception if Flux Pro is not installed.

```php
public function phoneJs() {
    if (! Flux::pro()) throw new \Exception('Flux Pro is required to use the Flux phone input.');

    return $this->pretendResponseIsFile(__DIR__.'/../../flux-pro/dist/phone.js', 'text/javascript');
}
```

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

### GET /flux/flux.js

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the full Flux JS bundle (Pro) or the lite bundle (free).

```APIDOC
## GET /flux/flux.js

### Description
Serves the full Flux JS bundle (Pro) or the lite bundle (free).

### Method
GET

### Endpoint
/flux/flux.js

### Response
#### Success Response (200)
- **Content-Type**: Per-route (JavaScript)
- **Expires**: +1 year (RFC 7231 HTTP date, GMT)
- **Cache-Control**: public, max-age=31536000
- **Last-Modified**: HTTP date of filemtime($file)
- **Content-Encoding**: br when the served file ends with .br

#### Response Example
(File body)

#### Conditional Response (304)
If the request sends an If-Modified-Since header whose parsed timestamp equals the file's mtime, the server returns HTTP 304 with Expires and Cache-Control headers (no body).
```

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

### ensurePro() method throwing exception when license not activated

Source: https://github.com/livewire/flux/blob/main/_autodocs/errors.md

Throws an exception when Flux Pro is not activated. Triggered when pro() returns false because Composer does not report livewire/flux-pro installed. Message: 'Your install of Flux is not activated. Visit https://fluxui.dev/pricing to purchase a license key.' Source: src/FluxManager.php:30-35.

```php
public function ensurePro()
{
    if (! $this->pro()) {
        throw new \Exception('Your install of Flux is not activated. Visit https://fluxui.dev/pricing to purchase a license key.');
    }
}
```

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

### FluxManager::pro()

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/flux.md

Returns true when Composer reports livewire/flux-pro as installed, false otherwise.

```APIDOC
## FluxManager::pro()

### Description
Returns `true` when Composer reports `livewire/flux-pro` as installed (via `Composer\InstalledVersions::isInstalled`), `false` otherwise.

### Method
`pro`

### Returns
- `bool` - `true` when `livewire/flux-pro` is installed, `false` otherwise.

### Source
`src/FluxManager.php:37`
```

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

### Catching exception from DateRange::fromPreset and using allTime()

Source: https://github.com/livewire/flux/blob/main/_autodocs/errors.md

Shows how to catch the exception from DateRange::fromPreset(DateRangePreset::AllTime) and use DateRange::allTime($start) instead.

```php
try {
    $range = DateRange::fromPreset(DateRangePreset::AllTime);
} catch (\Exception $e) {
    // use DateRange::allTime($start) instead
    $range = DateRange::allTime('2020-01-01');
}
```

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

### GET /flux/phone-utils.js

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the Flux Pro phone utilities script.

```APIDOC
## GET /flux/phone-utils.js

### Description
Serves the Flux Pro phone utilities script.

### Method
GET

### Endpoint
/flux/phone-utils.js

### Response
#### Success Response (200)
- **Content-Type**: Per-route (JavaScript)
- **Expires**: +1 year (RFC 7231 HTTP date, GMT)
- **Cache-Control**: public, max-age=31536000
- **Last-Modified**: HTTP date of filemtime($file)
- **Content-Encoding**: br when the served file ends with .br

#### Response Example
(File body)

#### Conditional Response (304)
If the request sends an If-Modified-Since header whose parsed timestamp equals the file's mtime, the server returns HTTP 304 with Expires and Cache-Control headers (no body).
```

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

### GET /flux/phone.min.js

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the minified phone input JavaScript bundle (flux-pro/dist/phone.min.js). Requires Flux Pro; otherwise returns a 500 error.

```APIDOC
## GET /flux/phone.min.js

### Description
Serves the minified phone input JavaScript bundle `flux-pro/dist/phone.min.js`. Requires Flux Pro; otherwise returns a 500 error.

### Method
GET

### Endpoint
/flux/phone.min.js

### Response
#### Success Response (200)
- **Content-Type:** `text/javascript`
- **Body:** The JavaScript file content.

#### Error Response (500)
- **Description:** Thrown when Flux Pro is not installed.
- **Body:** `\Exception("Flux Pro is required to use the Flux phone input.")`

### Status Codes
- `200` - Success
- `304` - Not Modified
- `500` - Flux Pro required
```

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

### GET /flux/editor.js

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the Flux Pro editor script.

```APIDOC
## GET /flux/editor.js

### Description
Serves the Flux Pro editor script.

### Method
GET

### Endpoint
/flux/editor.js

### Response
#### Success Response (200)
- **Content-Type**: Per-route (JavaScript)
- **Expires**: +1 year (RFC 7231 HTTP date, GMT)
- **Cache-Control**: public, max-age=31536000
- **Last-Modified**: HTTP date of filemtime($file)
- **Content-Encoding**: br when the served file ends with .br

#### Response Example
(File body)

#### Conditional Response (304)
If the request sends an If-Modified-Since header whose parsed timestamp equals the file's mtime, the server returns HTTP 304 with Expires and Cache-Control headers (no body).
```

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

### bootMacros() method

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/flux-service-provider.md

Adds two macros: getCurrentComponentData on the view factory and pluck on ComponentAttributeBag. The pluck macro gets an attribute, removes it, and returns its value or default.

```php
public function bootMacros()
{
    app('view')::macro('getCurrentComponentData', function () {
        return $this->currentComponentData;
    });

    ComponentAttributeBag::macro('pluck', function ($key, $default = null) {
        $result = $this->get($key);

        unset($this->attributes[$key]);

        return $result ?? $default;
    });
}
```

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

### GET /flux/phone.js

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the Flux Pro phone input script.

```APIDOC
## GET /flux/phone.js

### Description
Serves the Flux Pro phone input script.

### Method
GET

### Endpoint
/flux/phone.js

### Response
#### Success Response (200)
- **Content-Type**: Per-route (JavaScript)
- **Expires**: +1 year (RFC 7231 HTTP date, GMT)
- **Cache-Control**: public, max-age=31536000
- **Last-Modified**: HTTP date of filemtime($file)
- **Content-Encoding**: br when the served file ends with .br

#### Response Example
(File body)

#### Conditional Response (304)
If the request sends an If-Modified-Since header whose parsed timestamp equals the file's mtime, the server returns HTTP 304 with Expires and Cache-Control headers (no body).
```

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

### GET /flux/editor.min.js

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the Flux Pro editor script (minified).

```APIDOC
## GET /flux/editor.min.js

### Description
Serves the Flux Pro editor script (minified).

### Method
GET

### Endpoint
/flux/editor.min.js

### Response
#### Success Response (200)
- **Content-Type**: Per-route (JavaScript)
- **Expires**: +1 year (RFC 7231 HTTP date, GMT)
- **Cache-Control**: public, max-age=31536000
- **Last-Modified**: HTTP date of filemtime($file)
- **Content-Encoding**: br when the served file ends with .br

#### Response Example
(File body)

#### Conditional Response (304)
If the request sends an If-Modified-Since header whose parsed timestamp equals the file's mtime, the server returns HTTP 304 with Expires and Cache-Control headers (no body).
```

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

### GET /flux/editor.css

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the Flux Pro editor stylesheet.

```APIDOC
## GET /flux/editor.css

### Description
Serves the Flux Pro editor stylesheet.

### Method
GET

### Endpoint
/flux/editor.css

### Response
#### Success Response (200)
- **Content-Type**: Per-route (CSS)
- **Expires**: +1 year (RFC 7231 HTTP date, GMT)
- **Cache-Control**: public, max-age=31536000
- **Last-Modified**: HTTP date of filemtime($file)
- **Content-Encoding**: br when the served file ends with .br

#### Response Example
(File body)

#### Conditional Response (304)
If the request sends an If-Modified-Since header whose parsed timestamp equals the file's mtime, the server returns HTTP 304 with Expires and Cache-Control headers (no body).
```

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

### editorMinJs() method implementation

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/asset-manager.md

Serves flux-pro/dist/editor.min.js with content type text/javascript, throwing an exception if Flux Pro is not installed.

```php
public function editorMinJs() {
    if (! Flux::pro()) throw new \Exception('Flux Pro is required to use the Flux editor.');

    return $this->pretendResponseIsFile(__DIR__.'/../../flux-pro/dist/editor.min.js', 'text/javascript');
}
```

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

### editorJs() method implementation

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/asset-manager.md

Serves flux-pro/dist/editor.js with content type text/javascript, throwing an exception if Flux Pro is not installed.

```php
public function editorJs() {
    if (! Flux::pro()) throw new \Exception('Flux Pro is required to use the Flux editor.');

    return $this->pretendResponseIsFile(__DIR__.'/../../flux-pro/dist/editor.js', 'text/javascript');
}
```

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

### FluxManager::ensurePro()

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/flux.md

Throws an exception if the livewire/flux-pro package is not installed. Use to enforce pro features.

```APIDOC
## FluxManager::ensurePro()

### Description
Throws an exception when the `livewire/flux-pro` package is not installed. Use to enforce pro features.

### Method
`ensurePro`

### Returns
- `void`

### Throws
- `\Exception` - When `livewire/flux-pro` is not installed. Message: `'Your install of Flux is not activated. Visit https://fluxui.dev/pricing to purchase a license key.'`

### Source
`src/FluxManager.php:30`

### Example
```php
if (Flux::pro()) {
    Flux::ensurePro(); // passes
} else {
    Flux::ensurePro(); // throws \Exception
}
```
```

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

### GET /flux/phone.min.js

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the Flux Pro phone input script (minified).

```APIDOC
## GET /flux/phone.min.js

### Description
Serves the Flux Pro phone input script (minified).

### Method
GET

### Endpoint
/flux/phone.min.js

### Response
#### Success Response (200)
- **Content-Type**: Per-route (JavaScript)
- **Expires**: +1 year (RFC 7231 HTTP date, GMT)
- **Cache-Control**: public, max-age=31536000
- **Last-Modified**: HTTP date of filemtime($file)
- **Content-Encoding**: br when the served file ends with .br

#### Response Example
(File body)

#### Conditional Response (304)
If the request sends an If-Modified-Since header whose parsed timestamp equals the file's mtime, the server returns HTTP 304 with Expires and Cache-Control headers (no body).
```

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

### GET /flux/phone.js

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the phone input JavaScript bundle (flux-pro/dist/phone.js). Requires Flux Pro; otherwise returns a 500 error.

```APIDOC
## GET /flux/phone.js

### Description
Serves the phone input JavaScript bundle `flux-pro/dist/phone.js`. Requires Flux Pro; otherwise returns a 500 error.

### Method
GET

### Endpoint
/flux/phone.js

### Response
#### Success Response (200)
- **Content-Type:** `text/javascript`
- **Body:** The JavaScript file content.

#### Error Response (500)
- **Description:** Thrown when Flux Pro is not installed.
- **Body:** `\Exception("Flux Pro is required to use the Flux phone input.")`

### Status Codes
- `200` - Success
- `304` - Not Modified
- `500` - Flux Pro required
```

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

### GET /flux/phone-utils.js

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves the phone utility JavaScript bundle (flux-pro/dist/phone-utils.js). Requires Flux Pro; otherwise returns a 500 error.

```APIDOC
## GET /flux/phone-utils.js

### Description
Serves the phone utility JavaScript bundle `flux-pro/dist/phone-utils.js`. Requires Flux Pro; otherwise returns a 500 error.

### Method
GET

### Endpoint
/flux/phone-utils.js

### Response
#### Success Response (200)
- **Content-Type:** `text/javascript`
- **Body:** The JavaScript file content.

#### Error Response (500)
- **Description:** Thrown when Flux Pro is not installed.
- **Body:** `\Exception("Flux Pro is required to use the Flux phone input.")`

### Status Codes
- `200` - Success
- `304` - Not Modified
- `500` - Flux Pro required
```

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

### flagUrl() usage example

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/asset-manager.md

Shows how to call Flux::flagUrl('US') to get a URL like https://example.test/flux/flags/US?id=abc123.

```php
$url = Flux::flagUrl('US'); // e.g. https://example.test/flux/flags/US?id=abc123
```

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

### Usage example for modal()

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/interacts-with-components.md

Shows how to call the modal() method from a Blade view or component class to show or close a modal by name.

```php
// In a blade view / component class:
Flux::modal('settings')->show();
Flux::modal('settings')->close();
```

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

### DateRange::start()

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-range.md

Returns the period start date as a Carbon instance, or null if unset.

```APIDOC
## DateRange::start()

### Description
Returns the period start date as a Carbon instance, or null if unset.

### Method
Method

### Signature
```php
public function start(): ?Carbon
```

### Returns
- **?Carbon** - The period start date via `getStartDate()`, or `null` when unset.

### Source
`src/DateRange.php:17`
```

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

### DateRange::today()

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-range.md

Creates a DateRange for the current day, from start to end of day.

```APIDOC
## DateRange::today()

### Description
Creates a DateRange for the current day, from start to end of day.

### Method
static

### Signature
`public static function today(): DateRange`

### Returns
- **DateRange** - A range from start to end of current day.

### Example
```php
use Flux\DateRange;

$range = DateRange::today();
```
```

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

### editorCss() method implementation

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/asset-manager.md

Serves flux-pro/dist/editor.css with content type text/css, throwing an exception if Flux Pro is not installed.

```php
public function editorCss() {
    if (! Flux::pro()) throw new \Exception('Flux Pro is required to use the Flux editor.');

    return $this->pretendResponseIsFile(__DIR__.'/../../flux-pro/dist/editor.css', 'text/css');
}
```

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

### boot() method

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/flux.md

Subscribes to Livewire's flush-state event and calls bootComponents(). Called automatically from FluxServiceProvider::boot().

```php
public function boot()
```

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

### Handling AllTime preset exception and using allTime()

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-range.md

Demonstrates that fromPreset() throws an exception for AllTime and shows the correct usage of allTime() to create an AllTime range. Includes the exact error message.

```php
use Flux\DateRange;
use Flux\DateRangePreset;

// AllTime requires the explicit-start constructor
try {
    DateRange::fromPreset(DateRangePreset::AllTime); // throws \Exception
} catch (\Exception $e) {
    echo $e->getMessage();
    // "All time date range is not supported via this constructor because it requires a start date. Please use the ::allTime($start) constructor instead."
}

$all = DateRange::allTime('2020-01-01');
$all->preset();            // DateRangePreset::AllTime
$all->isNotAllTime();      // false
```

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

### label() usage examples

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-range.md

Shows how to call label() on DateRangePreset cases. Last30Days returns 'Last 30 Days' and AllTime returns 'All Time'.

```php
DateRangePreset::Last30Days->label(); // 'Last 30 Days'
DateRangePreset::AllTime->label();    // 'All Time'
```

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

### boot() method signature

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/flux-service-provider.md

The boot() method is called after all providers are registered. It returns void and is defined in src/FluxServiceProvider.php at line 34.

```php
public function boot(): void
```

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

### boot() method signature

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/asset-manager.md

Declares the static boot() method that instantiates the class and calls registerAssetDirective() and registerAssetRoutes().

```php
static function boot()
```

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

### Flux tag syntax example

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/flux-tag-compiler.md

Shows the supported tag syntax for Flux components, including self-closing tags, nested namespaces, and components with attributes and content.

```blade
<flux:button>Save</flux:button>
<flux:icon icon="arrow-left" />
<flux:dropdown.menu.item>Edit</flux:dropdown.menu.item>
<flux:modal name="settings">
    {{-- ... --}}
</flux:modal>
```

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

### attributesAfter usage example

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/flux.md

Example usage of Flux::attributesAfter to extract attributes prefixed with 'icon:'.

```php
$iconAttrs = Flux::attributesAfter('icon:', $attributes);
```

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

### componentExists usage example

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/flux.md

Example usage of Flux::componentExists to conditionally render a flux icon component.

```php
if (Flux::componentExists('icon.arrow-left')) {
    // <flux:icon icon="arrow-left" />
}
```

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

### Boot sequence orchestration

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/flux-service-provider.md

This code shows the boot() method's orchestration: it calls several internal boot methods, registers Livewire property synthesizers, boots the AssetManager, boots the Flux manager, and registers console commands.

```php
$this->bootComponentPath();
$this->bootFallbackBlazeDirectivesIfBlazeIsNotInstalled();
$this->bootTagCompiler();
$this->bootMacros();

app('livewire')->propertySynthesizer(DateRangeSynth::class);
app('livewire')->propertySynthesizer(DateTimeRangeSynth::class);

AssetManager::boot();

app('flux')->boot();

$this->bootCommands();
```

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

### unwrapForValidation($target) static method

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/livewire-synths.md

Returns the array representation of the target for validation. Returns array with keys 'start' and 'end' in Y-m-d\TH:i format. Source: src/DateTimeRangeSynth.php:21.

```php
static function unwrapForValidation($target) {
    return static::toArray($target);
}
```

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

### dates() method signature

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-range.md

Signature of the dates() method. It accepts an optional Carbon $start parameter used only by the AllTime case as the range start. Returns an array of two Carbon instances [start, end] computed relative to Carbon::now().

```php
public function dates(?Carbon $start = null)
```

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

### flux:activate usage examples

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/console-commands.md

Shows how to run the flux:activate command interactively and non-interactively. The interactive version prompts for missing arguments, while the non-interactive version passes email and key directly.

```bash
# Interactive
php artisan flux:activate

# Non-interactive
php artisan flux:activate you@example.com LICENSEKEY
```

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

### forwardedAttributes usage example

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/flux.md

Example usage of Flux::forwardedAttributes to extract attributes like 'type', 'href', and 'as' into variables.

```php
@php
extract(Flux::forwardedAttributes($attributes, ['type', 'href', 'as']));
@endphp
```

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

### Using modal() macro inside a Livewire component

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/interacts-with-components.md

Example of calling the modal() macro from within a Livewire component class method to show or close a modal by name.

```php
// Inside a Livewire component class method:
public function openSettings()
{
    $this->modal('settings')->show();
}

public function closeSettings()
{
    $this->modal('settings')->close();
}
```

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

### unset() method for DateRangeSynth

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/livewire-synths.md

Clears a key from a DateRange by rebuilding it: 'start' sets start to null, 'end' sets end to null, and 'preset' resets to the original range. Returns void.

```php
function unset(&$target, $key) {
    $target = match ($key) {
        'start' => new DateRange(null, $target->end()),
        'end' => new DateRange($target->start(), null),
        'preset' => new DateRange($target->start(), $target->end()),
    };
}
```

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

### DateRangePreset::dates()

Source: https://github.com/livewire/flux/blob/main/_autodocs/types.md

Computes the start and end Carbon dates for a given preset. The method accepts an optional start date, which is only used by the AllTime preset. Calling dates() on the Custom preset throws an UnhandledMatchError.

```APIDOC
## DateRangePreset::dates()

### Description
Computes the [start, end] Carbon date pair for the preset. The optional $start parameter is only used by the AllTime preset. Calling this method on the Custom preset throws an UnhandledMatchError.

### Method
PHP method

### Signature
`dates(?Carbon $start = null): array{0: Carbon, 1: Carbon}`

### Parameters
- **$start** (Carbon|null) - Optional - The start date used only by the AllTime preset.

### Return Value
- **array{0: Carbon, 1: Carbon}** - An array containing the start and end Carbon dates.

### Exceptions
- **UnhandledMatchError** - Thrown when called on the Custom preset.

### Example
```php
$preset = DateRangePreset::Last7Days;
[$start, $end] = $preset->dates();
```
```

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

### fluxMinJs() method implementation

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/asset-manager.md

Serves minified flux.min.js (Pro) or flux-lite.min.js (free), with content type text/javascript.

```php
public function fluxMinJs() {
    return Flux::pro()
        ? $this->pretendResponseIsFile(__DIR__.'/../../flux-pro/dist/flux.min.js', 'text/javascript')
        : $this->pretendResponseIsFile(__DIR__.'/../../flux/dist/flux-lite.min.js', 'text/javascript');
}
```

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

### Publish Flux Components for Customization

Source: https://github.com/livewire/flux/blob/main/README.md

Run this command to publish blade files for customization. You'll be prompted to select components, or use --all to publish everything.

```bash
php artisan flux:publish
```

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

### set() method for DateRangeSynth

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/livewire-synths.md

Mutates a DateRange by reference based on the key: 'start' creates a new DateRange with the given value as start, 'end' parses the value and applies endOfDay(), and 'preset' handles the AllTime preset specially. Returns void.

```php
function set(&$target, $key, $value) {
    $target = match ($key) {
        'start' => new DateRange($value, $target->end()),
        'end' => new DateRange($target->start(), Carbon::parse($value)->endOfDay()),
        'preset' => $value === DateRangePreset::AllTime->value
            ? DateRange::allTime($target->start())
            : DateRange::fromPreset(DateRangePreset::from($value)),
    };
}
```

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

### GET /flux/flags/{country}

Source: https://github.com/livewire/flux/blob/main/_autodocs/endpoints.md

Serves a country flag SVG.

```APIDOC
## GET /flux/flags/{country}

### Description
Serves a country flag SVG.

### Method
GET

### Endpoint
/flux/flags/{country}

### Parameters
#### Path Parameters
- **country** (string) - Required - The country code for the flag.

### Response
#### Success Response (200)
- **Content-Type**: Per-route (SVG)
- **Expires**: +1 year (RFC 7231 HTTP date, GMT)
- **Cache-Control**: public, max-age=31536000
- **Last-Modified**: HTTP date of filemtime($file)
- **Content-Encoding**: br when the served file ends with .br
- **X-Content-Type-Options**: nosniff

#### Response Example
(File body)

#### Conditional Response (304)
If the request sends an If-Modified-Since header whose parsed timestamp equals the file's mtime, the server returns HTTP 304 with Expires and Cache-Control headers (no body).
```

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

### bootTagCompiler() method

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/flux-service-provider.md

Creates a FluxTagCompiler, binds it as 'flux.compiler', and registers it as a Blade precompiler to rewrite <flux:...> tags before normal compilation.

```php
public function bootTagCompiler()
{
    $compiler = new FluxTagCompiler(
        app('blade.compiler')->getClassComponentAliases(),
        app('blade.compiler')->getClassComponentNamespaces(),
        app('blade.compiler')
    );

    app()->bind('flux.compiler', fn () => $compiler);

    app('blade.compiler')->precompiler(function ($in) use ($compiler) {
        return $compiler->compile($in);
    });
}
```

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

### DateTimeRange::hasStart

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-time-range.md

Checks whether the period has a start datetime set.

```APIDOC
## DateTimeRange::hasStart

### Description
Checks whether the period has a start datetime set.

### Method
hasStart

### Signature
public function hasStart(): bool

### Returns
- **bool** - True if the start date is not null, false otherwise.

### Source
src/DateTimeRange.php:25
```

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

### Activate Flux Pro License

Source: https://github.com/livewire/flux/blob/main/README.md

Run this command to activate a Flux Pro license. You will be prompted for your email and license key.

```bash
php artisan flux:activate
```

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

### DateTimeRange::start

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-time-range.md

Returns the start datetime of the period, or null if unset.

```APIDOC
## DateTimeRange::start

### Description
Returns the start datetime of the period, or null if unset.

### Method
start

### Signature
public function start(): ?Carbon

### Returns
- **?Carbon** - The period start datetime, or null when unset.

### Source
src/DateTimeRange.php:15
```

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

### Container and facade wiring in register()

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/flux-service-provider.md

This code snippet shows the container and facade wiring performed in the register() method. It aliases the FluxManager to the 'flux' key, registers a singleton, and adds a global facade alias.

```php
$this->app->alias(FluxManager::class, 'flux');
$this->app->singleton(FluxManager::class);
AliasLoader::getInstance()->alias('Flux', \Flux\Flux::class);
```

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

### DateRange::yearToDate()

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-range.md

Creates a DateRange from start of year to end of today.

```APIDOC
## DateRange::yearToDate()

### Description
Creates a DateRange from start of year to end of today.

### Method
static

### Signature
`public static function yearToDate(): DateRange`

### Returns
- **DateRange** - A range from start of year to end of today.

### Example
```php
use Flux\DateRange;

$range = DateRange::yearToDate();
```
```

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

### Guarding with Flux::pro() before calling ensurePro()

Source: https://github.com/livewire/flux/blob/main/_autodocs/errors.md

Shows how to guard with Flux::pro() first and catch the exception from ensurePro(). Renders an 'upgrade' UI instead of calling the Pro-only API when not activated.

```php
if (! Flux::pro()) {
    // render an "upgrade" UI instead of calling the Pro-only API
    return;
}
try {
    Flux::ensurePro();
} catch (\Exception $e) {
    report($e);
}
```

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

### DateRange::nextYear()

Source: https://github.com/livewire/flux/blob/main/_autodocs/api-reference/date-range.md

Creates a DateRange for the next year, from start to end of year.

```APIDOC
## DateRange::nextYear()

### Description
Creates a DateRange for the next year, from start to end of year.

### Method
static

### Signature
`public static function nextYear(): DateRange`

### Returns
- **DateRange** - A range from start to end of next year.

### Example
```php
use Flux\DateRange;

$range = DateRange::nextYear();
```
```
Tokens:
Raw