Laravel Views

If you have previously published Blade components for customization, you must re-publish them to ensure you have the latest internal component structures. Run the following command to update your published components:

php artisan vendor:publish --tag=views --provider='LaravelViews\LaravelViewsServiceProvider'

The package uses Laravel's container to bind specific implementations to core data contracts. If you are implementing these interfaces, the following default implementations are bound:

• LaravelViews\Data\Contracts\Searchable $\rightarrow$ LaravelViews\Data\TableViewSearchData
• LaravelViews\Data\Contracts\Filterable $\rightarrow$ LaravelViews\Data\TableViewFilterData
• LaravelViews\Data\Contracts\Sortable $\rightarrow$ LaravelViews\Data\TableViewSortData

To customize the package's assets, views, or configuration, use the Laravel vendor:publish command. The package provides three distinct publishable tags:

1. public: Publishes JavaScript, CSS, and Tailwind assets to your public/vendor/laravel-views.js directory.
2. config: Publishes the package configuration file to config/laravel-views.php.
3. views: Publishes component and view templates to your resources/views/vendor/laravel-views/ directory, allowing you to override the default UI.

# Publish configuration
php artisan vendor:publish --tag=config

# Publish public assets (JS/CSS)
php artisan vendor:publish --tag=public

# Publish view templates for customization
php artisan vendor:publish --tag=views

The LaravelViews\UI\Variants class allows you to fluently select a UI component and a specific visual variant. This selection is used to resolve configuration values (like CSS classes) from the laravel-views configuration file.

Available component methods include:

• button($variant): Selects the buttons component.
• alert($variant): Selects the alerts component.
• paginator($variant): Selects the paginator component.
• badge($variant): Selects the badges component.
• img($variant): Selects the images component.
• featherIcon($variant): Selects the icons component.

Each method accepts an optional $variant string.

use LaravelViews\\UI\Variants;

// Example: Selecting a success alert variant
$variants = (new Variants())->alert('success');

The package registers several Blade components using the lv- prefix.

Anonymous Components: Components are registered with the pattern lv-{component-name}. These are mapped from the package's internal component list.

Class-based Components:

• lv-layout: The main layout component.
• lv-dynamic-component: A dynamic component handler (DynamicComponent).

The LaravelViews\UI\Header class is used to define the properties of a column header in a table view. You can specify the display title, the field used for sorting, and the column width.

To start configuring a header, use the title() method, which initializes a new instance. Subsequent configuration methods like sortBy() and width() can be chained to the instance.

use LaravelViews\UI\Header;

$header = Header::title('User Name')
    ->sortBy('name')
    ->width('200px');

The getFilterValues method retrieves the filters parameter from the query string. It specifically handles boolean filters by iterating through the filter array and casting string values (e.g., 'true' or 'false') into actual boolean types using filter_var with FILTER_VALIDATE_BOOLEAN. If no filters are found, it returns the provided $currentValue.

// Assuming $queryStringData is an instance of QueryStringData
$filters = $queryStringData->getFilterValues($currentValue);

The getValue method allows you to retrieve any specific field from the query string. It takes the field name and a default value to return if the field is missing from the request.

// Assuming $queryStringData is an instance of QueryStringData
$value = $queryStringData->getValue('my_param', 'default_value');

The package provides two Blade directives to easily include the necessary scripts and styles in your application layouts:

• @laravelViewsScripts($options): Renders the required JavaScript.
• @laravelViewsStyles($options): Renders the required CSS.

The Variants class provides helper methods to retrieve human-readable titles and Feather icon names specifically for the alert component variants.

Alert Variants Mapping:

Note: These methods only work if an alert component has been selected via the alert() method.

$variants = (new Variants())->alert('success');

echo $variants->title(); // Outputs: Success
echo $variants->icon();  // Outputs: check