Blade Font Awesome

https://github.com/owenvoke/blade-fontawesome
Admin
Blade Font Awesome is a Laravel package that makes it easy to use Font Awesome icons in Blade views...
Tokens:19,536
Snippets:366
Trust Score:10
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Array Configuration Example

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/types.md

A concrete example of an array used for icon set configuration.

```php
[
    'width' => 50,
    'height' => 50,
    'role' => 'img',
]
```

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

### Install Kit Package

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Install the specific kit package using the kit code provided by Awesome.me.

```bash
npm install --save @awesome.me/kit-YOUR_KIT_CODE@latest
```

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

### Constructor Usage

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/compile-svgs-action.md

Example of initializing the action with specific directory paths.

```php
$action = new CompileSvgsAction(
    '/workspace/fontawesome/solid',
    '/project/resources/icons/blade-fontawesome/solid'
);
```

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

### Icon Component Examples

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/INDEX.md

Practical examples of using icon components with various HTML attributes.

```blade
<x-fas-star />
<x-fas-star class="w-6 h-6 text-blue-500" />
<x-fab-github id="github-icon" aria-hidden="true" />
<x-fal-heart style="color: red;" />
```

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

### Verify package installation

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Check if the package is correctly installed via Composer.

```bash
composer show owenvoke/blade-fontawesome
```

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

### Install Font Awesome Kit

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/sync-icons-command.md

Installs a Font Awesome kit from npm using the kit ID.

```bash
npm install --save @awesome.me/kit-KIT_CODE@latest
```

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

### Execute Method Usage

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/compile-svgs-action.md

Example of executing the action and handling potential runtime exceptions.

```php
$action = new CompileSvgsAction(
    '/tmp/fontawesome-svgs/solid',
    resource_path('icons/blade-fontawesome/solid')
);

try {
    $action->execute();
} catch (RuntimeException $e) {
    Log::error('SVG processing failed: ' . $e->getMessage());
}
```

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

### Define icon set configuration

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/service-provider.md

Example structure for icon set configuration in the package.

```php
'brands' => ['prefix' => 'fab', 'fallback' => '', 'class' => '', 'attributes' => [...]]
'regular' => ['prefix' => 'far', 'fallback' => '', 'class' => '', 'attributes' => [...]]
'solid' => ['prefix' => 'fas', 'fallback' => '', 'class' => '', 'attributes' => [...]]
```

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

### Install Font Awesome Free

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/sync-icons-command.md

Installs the Font Awesome Free package via npm.

```bash
npm install --save @fortawesome/fontawesome-free
```

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

### Install Font Awesome Pro

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/sync-icons-command.md

Installs the Font Awesome Pro package via npm.

```bash
npm install --save @fortawesome/fontawesome-pro
```

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

### Correct Usage of SyncIconsCommand

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Example of a valid command execution with a kit ID.

```bash
php artisan blade-fontawesome:sync-icons --kit=abc123xyz
```

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

### Sync Command Output Example

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/sync-icons-command.md

Displays the console output after successfully updating Font Awesome SVGs.

```text
Successfully updated Font Awesome SVGs
- From: /project/node_modules/@fortawesome/fontawesome-pro/svgs
- To: /project/resources/icons/blade-fontawesome

Sets copied: duotone, light, solid, brands, regular, thin
```

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

### Recover from Missing Source Path Errors

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Commands to install missing icon packages before retrying the sync.

```bash
# For free icons
npm install --save @fortawesome/fontawesome-free

# For pro icons (requires Font Awesome Pro npm account)
npm install --save @fortawesome/fontawesome-pro

# For kit icons
npm install --save @awesome.me/kit-KIT_CODE@latest

# Then retry sync
php artisan blade-fontawesome:sync-icons
```

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

### Configure Pro icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/INDEX.md

Install the Pro package via npm and sync icons to Laravel before using Pro-specific components.

```bash
# Install pro package
npm install --save @fortawesome/fontawesome-pro

# Sync to Laravel
php artisan blade-fontawesome:sync-icons --pro

# Use in Blade
<x-fad-shield />
<x-fal-heart />
```

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

### CI/CD Exit Code Handling

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Examples of managing command failures during automated deployment using bash.

```bash
#!/bin/bash
set -e  # Exit on any command failure

# Sync icons (will exit on failure)
php artisan blade-fontawesome:sync-icons --free

# Or with specific error handling
if ! php artisan blade-fontawesome:sync-icons --free; then
    echo "Failed to sync Font Awesome icons"
    exit 1
fi
```

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

### Install Symfony var-dumper for debugging

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Use this command to enable Symfony var-dumper output for investigating errors.

```bash
composer require symfony/var-dumper
```

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

### SyncIconsCommand Usage Examples

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/sync-icons-command.md

Various ways to invoke the sync-icons command via the CLI, including flags for pro, free, kits, and custom directories.

```bash
# Sync pro icons (requires Font Awesome Pro npm package)
php artisan blade-fontawesome:sync-icons --pro

# Sync free icons explicitly
php artisan blade-fontawesome:sync-icons --free

# Sync from a Font Awesome kit
php artisan blade-fontawesome:sync-icons --kit=abc123xyz

# Sync from custom directory
php artisan blade-fontawesome:sync-icons /custom/project/root --pro

# Auto-detect (tries pro first, falls back to free)
php artisan blade-fontawesome:sync-icons
```

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

### Verify npm package installation

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Check if the required FontAwesome npm packages are installed in the project.

```bash
npm list @fortawesome/fontawesome-free
npm list @fortawesome/fontawesome-pro  # If using pro
```

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

### Override icon set defaults

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/service-provider.md

Example of overriding default configuration values for an icon set.

```php
// In published config/blade-fontawesome.php
'solid' => [
    'prefix' => 'fas',
    'class' => 'icon-default',  // Added to all solid icons
    'attributes' => ['stroke-width' => 2]
]
```

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

### Verify Kit installation

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Check if the specific Kit package is listed in npm dependencies.

```bash
npm list @awesome.me/kit-YOUR_KIT_CODE
```

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

### Handling SVG Read Exceptions

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Example of catching and logging read-related RuntimeExceptions.

```php
use RuntimeException;
use OwenVoke\BladeFontAwesome\Actions\CompileSvgsAction;

try {
    $action = new CompileSvgsAction($sourceDir, $outputDir);
    $action->execute();
} catch (RuntimeException $e) {
    if (str_contains($e->getMessage(), 'read')) {
        // Handle read failure
        Log::error("SVG read failed: {$e->getMessage()}");
        
        // Verify file permissions
        if (! is_readable($sourceDir)) {
            chmod($sourceDir, 0755);
        }
    }
    throw $e;  // Re-throw for CLI handling
}
```

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

### Handling SVG Write Exceptions

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Example of catching and resolving write-related RuntimeExceptions.

```php
use RuntimeException;
use OwenVoke\BladeFontAwesome\Actions\CompileSvgsAction;

try {
    $action = new CompileSvgsAction($sourceDir, $outputDir);
    $action->execute();
} catch (RuntimeException $e) {
    if (str_contains($e->getMessage(), 'write')) {
        // Handle write failure
        Log::error("SVG write failed: {$e->getMessage()}");
        
        // Ensure output directory exists and is writable
        if (! is_dir($outputDir)) {
            mkdir($outputDir, 0755, true);
        }
        
        if (! is_writable($outputDir)) {
            chmod($outputDir, 0755);
        }
        
        // Retry after fixing permissions
        $action->execute();
    }
}
```

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

### RuntimeException Usage

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/types.md

Examples of throwing exceptions when SVG file operations fail.

```php
throw new RuntimeException('Unable to read SVG file.');
throw new RuntimeException('Unable to write SVG file.');
```

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

### SyncIconsCommand Option Usage

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/types.md

Example of validating a string option within the SyncIconsCommand.

```php
$kitId = $this->option('kit');
if (! is_string($kitId) || empty($kitId)) {
    return self::FAILURE;
}
```

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

### Sync Font Awesome Pro Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/README.md

After installing Font Awesome Pro via npm, run this command to sync the pro icons into your project's resources.

```shell
php artisan blade-fontawesome:sync-icons --pro
```

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

### Disable pro icon sets

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/service-provider.md

Example of disabling a specific icon set in the configuration.

```php
'sharp-regular' => false  // Disables Sharp Regular icons
```

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

### Blade Component Rendering

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/compile-svgs-action.md

Example of rendering a processed SVG component and its resulting HTML output.

```blade
<x-fas-cloud class="w-6 h-6 text-blue-500" />
```

```html
<svg fill="currentColor" class="w-6 h-6 text-blue-500" ...>
```

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

### Install Blade Font Awesome via Composer

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/README.md

Use this command to add the package to your Laravel project.

```shell
composer require owenvoke/blade-fontawesome
```

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

### Sync Font Awesome Kit Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/README.md

After installing a Font Awesome Kit via npm, use this command to sync the kit icons into your project's resources, replacing 'KIT_CODE' with your actual kit code.

```shell
php artisan blade-fontawesome:sync-icons --kit=KIT_CODE
```

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

### Trigger SyncIconsCommand with Invalid Kit Options

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Examples of CLI commands that trigger the invalid kit ID error.

```bash
# No value provided
php artisan blade-fontawesome:sync-icons --kit

# Empty value (invalid)
php artisan blade-fontawesome:sync-icons --kit=
```

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

### Boot method usage note

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/service-provider.md

Note regarding the automatic execution of the boot method and asset publishing.

```php
// Triggered automatically during Laravel boot sequence
// Developers then run:
// php artisan vendor:publish --tag=blade-fontawesome-config
```

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

### Sync Kit Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Sync icons from the configured kit into the local project.

```bash
php artisan blade-fontawesome:sync-icons --kit=YOUR_KIT_CODE
```

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

### Manage assets and cache

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/INDEX.md

Publish assets, configuration files, or manage the icon cache.

```bash
# Publish SVG assets to public directory
php artisan vendor:publish --tag=blade-fontawesome

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

# Cache icons for better performance
php artisan icons:cache

# Clear icon cache
php artisan icons:clear
```

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

### Sync Pro Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Run the artisan command to copy pro icons into the local resources directory.

```bash
php artisan blade-fontawesome:sync-icons --pro
```

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

### Verify and Sync Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Use these commands to check for the existence of icon files and synchronize Pro icons if they are missing.

```bash
# Verify icon exists
ls resources/svg/solid/star.svg

# If missing, run sync for pro icons
php artisan blade-fontawesome:sync-icons --pro
```

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

### Sync icons command

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Run the sync command before deployment to ensure icons are correctly processed.

```bash
php artisan blade-fontawesome:sync-icons
```

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

### Boot service provider method

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/service-provider.md

The boot method signature used after service providers are registered.

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

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

### Customize icon configuration

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/INDEX.md

Define default prefixes, classes, and attributes in the configuration file.

```php
// config/blade-fontawesome.php

'solid' => [
    'prefix' => 'fas',
    'class' => 'my-icon-class',
    'attributes' => ['role' => 'img'],
]
```

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

### Execute Artisan Commands

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/README.md

Run these commands to sync icon sets, publish configuration files, or cache icons.

```bash
# Sync pro icons
php artisan blade-fontawesome:sync-icons --pro

# Sync kit icons
php artisan blade-fontawesome:sync-icons --kit=abc123

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

# Cache icons
php artisan icons:cache
```

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

### Verify Icon Files

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Shell commands to list registered icon directories and check for pro icon files.

```bash
# List registered icon directories
ls resources/svg/solid/
ls resources/svg/regular/
ls resources/svg/brands/

# Check for pro icons
ls -la resources/icons/blade-fontawesome/
```

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

### Configure Font Awesome Pro Authentication

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Add the registry and authentication token to the project's .npmrc file.

```text
@fortawesome:registry=https://npm.fontawesome.com/
//npm.fontawesome.com/:_authToken=YOUR_TOKEN_HERE
```

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

### Synchronize icons with Artisan

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/INDEX.md

Use various flags to sync icons from different sources or paths.

```bash
php artisan blade-fontawesome:sync-icons
```

```bash
php artisan blade-fontawesome:sync-icons --pro
```

```bash
php artisan blade-fontawesome:sync-icons --free
```

```bash
php artisan blade-fontawesome:sync-icons --kit=abc123xyz
```

```bash
php artisan blade-fontawesome:sync-icons /custom/path --pro
```

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

### Configure Light Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/configuration.md

Defines the configuration for lightweight pro icons using the fal prefix.

```php
'light' => [
    'prefix' => 'fal',
    'fallback' => '',
    'class' => '',
    'attributes' => [
        // 'width' => 50,
        // 'height' => 50,
    ],
]
```

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

### Silent Fallback Logic in Service Provider

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Demonstrates the conditional registration of pro icons versus free icons based on directory existence.

```php
if (is_dir($proIconsPath = resource_path('icons/blade-fontawesome'))) {
    $this->registerProIcons($factory, $proIconsPath, $config);
    return;
}

// Falls back to free icons if pro icons not found
$factory->add('fontawesome-brands', ...);
$factory->add('fontawesome-regular', ...);
$factory->add('fontawesome-solid', ...);
```

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

### Project Directory Structure

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/overview.md

Visual representation of the package file hierarchy and core components.

```text
blade-fontawesome/
├── src/
│   ├── BladeFontAwesomeServiceProvider.php  (Service provider entry point)
│   ├── Actions/
│   │   └── CompileSvgsAction.php           (SVG processing)
│   └── Commands/
│       └── SyncIconsCommand.php            (Icon synchronization CLI)
├── config/
│   ├── blade-fontawesome.php               (Configuration schema)
│   └── generation.php                      (Icon generation config)
├── resources/
│   └── svg/
│       ├── brands/                         (Brand icons)
│       ├── regular/                        (Regular icons)
│       └── solid/                          (Solid icons)
└── tests/
    └── Feature/CompilesIconsTest.php
```

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

### Publish Blade Font Awesome Configuration

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/README.md

Run this command to publish the configuration file for customization.

```shell
php artisan vendor:publish --tag=blade-fontawesome-config
```

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

### Check and set directory permissions

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Verify directory permissions and ensure they are set correctly for the package.

```bash
ls -la resources/icons/
chmod 755 resources/icons/blade-fontawesome
```

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

### Configuration Priority

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/configuration.md

The order of precedence for configuration values.

```text
Runtime config overrides > Published config > Package defaults
```

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

### Verify Pro icons directory

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Check if Pro icons have been correctly copied to the project directory.

```bash
ls resources/icons/blade-fontawesome/
```

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

### Manage Icon Cache

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Commands to pre-compile icon components or clear existing caches.

```bash
php artisan icons:cache
```

```bash
php artisan icons:clear
```

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

### Configure Solid Icon Set

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/configuration.md

Default configuration for the Font Awesome Solid icon set.

```php
'solid' => [
    'prefix' => 'fas',
    'fallback' => '',
    'class' => '',
    'attributes' => [
        // 'width' => 50,
        // 'height' => 50,
    ],
]
```

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

### Source path not found error output

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/sync-icons-command.md

Output displayed when the constructed source path does not exist.

```text
Unable to find Font Awesome SVGs in '{$fullSourcePath}'
```

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

### Cache Icons for Performance

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/README.md

Run this Artisan command to cache icons, which can improve performance when using pro or kit-supplied icons.

```shell
php artisan icons:cache
```

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

### Publish Configuration File

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Publishes the package configuration file to the application's config directory.

```bash
php artisan vendor:publish --tag=blade-fontawesome-config
```

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

### Register configuration method

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/service-provider.md

Internal method signature for merging package configuration.

```php
private function registerConfig(): void
```

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

### Configure Custom Kit Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/configuration.md

Defines the configuration for custom icons sourced from Font Awesome kits.

```php
'custom-icons' => [
    'prefix' => 'fak',
    'fallback' => '',
    'class' => '',
    'attributes' => [
        // 'width' => 50,
        // 'height' => 50,
    ],
]
```

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

### CompileSvgsAction::__construct

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/compile-svgs-action.md

Initializes the action with the source directory containing SVG files and the output directory for processed files.

```APIDOC
## __construct(string $svgDirectory, string $svgOutputDirectory)

### Description
Initializes the action with source and output directory paths.

### Parameters
- **$svgDirectory** (string) - Required - Absolute path to directory containing source SVG files
- **$svgOutputDirectory** (string) - Required - Absolute path to directory where processed SVGs are written

### Example
```php
$action = new CompileSvgsAction(
    '/workspace/fontawesome/solid',
    '/project/resources/icons/blade-fontawesome/solid'
);
```
```

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

### Configure Thin Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/configuration.md

Defines the configuration for extra-thin pro icons using the fat prefix.

```php
'thin' => [
    'prefix' => 'fat',
    'fallback' => '',
    'class' => '',
    'attributes' => [
        // 'width' => 50,
        // 'height' => 50,
    ],
]
```

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

### Reset Configuration and Cache

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Clear configuration and icon caches or republish the configuration file to resolve issues with attributes or classes not applying correctly.

```bash
# Clear config cache
php artisan config:clear

# Republish config if needed
php artisan vendor:publish --tag=blade-fontawesome-config

# Clear icon cache
php artisan icons:clear
```

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

### Configure Duotone Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/configuration.md

Defines the configuration for two-color pro icons using the fad prefix.

```php
'duotone' => [
    'prefix' => 'fad',
    'fallback' => '',
    'class' => '',
    'attributes' => [
        // 'width' => 50,
        // 'height' => 50,
    ],
]
```

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

### Constructor Definition

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/compile-svgs-action.md

The constructor requires absolute paths for both the source and output directories.

```php
public function __construct(string $svgDirectory, string $svgOutputDirectory)
```

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

### Command Handle Return Implementation

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/types.md

Demonstrates returning success or failure codes from a command handle method.

```php
public function handle(): int
{
    // ... operation ...
    return self::SUCCESS;  // Returns 0
    return self::FAILURE;  // Returns 1
}
```

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

### Register pro icons method

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/service-provider.md

Internal method signature for registering pro icon sets.

```php
private function registerProIcons(
    Factory $factory,
    string $proIconsPath,
    ConfigRepository $config
): void
```

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

### Configure Sharp Icon Variants

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/configuration.md

Defines configuration arrays for various sharp geometric icon weights.

```php
'sharp-regular' => [
    'prefix' => 'far:sharp',
    'fallback' => '',
    'class' => '',
    'attributes' => [],
]
```

```php
'sharp-light' => [
    'prefix' => 'fal:sharp',
    'fallback' => '',
    'class' => '',
    'attributes' => [],
]
```

```php
'sharp-solid' => [
    'prefix' => 'fas:sharp',
    'fallback' => '',
    'class' => '',
    'attributes' => [],
]
```

```php
'sharp-duotone-solid' => [
    'prefix' => 'fad:sharp',
    'fallback' => '',
    'class' => '',
    'attributes' => [],
]
```

```php
'sharp-thin' => [
    'prefix' => 'fat:sharp',
    'fallback' => '',
    'class' => '',
    'attributes' => [],
]
```

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

### Verify icon existence

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Check the local directory to ensure the specific icon file exists.

```bash
ls resources/svg/solid/  # Look for star.svg
```

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

### Configure Regular Icon Set

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/configuration.md

Default configuration for the Font Awesome Regular icon set.

```php
'regular' => [
    'prefix' => 'far',
    'fallback' => '',
    'class' => '',
    'attributes' => [
        // 'width' => 50,
        // 'height' => 50,
    ],
]
```

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

### Sync Kit icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Synchronize icons using the specific Kit ID.

```bash
php artisan blade-fontawesome:sync-icons --kit=correct-id
```

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

### SyncIconsCommand Method Signatures

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/types.md

Method signatures for the command handling and configuration.

```php
public function handle(): int
protected function configure(): void
```

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

### Registering an icon set with the Factory

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Use the Factory class to register a new icon set by defining its path, prefix, and default attributes.

```php
use BladeUI\\\Icons\\\Factory;

$factory = app(Factory::class);

$factory->add('fontawesome-solid', [
    'path' => 'resources/svg/solid',
    'prefix' => 'fas',
    'class' => '',
    'attributes' => [],
    'fallback' => '',
]);
```

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

### Factory Configuration Array Structure

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/types.md

The expected structure for icon set configuration arrays passed to the factory.

```php
[
    'path' => '/absolute/path/to/icons',
    'prefix' => 'icon-name',
    'fallback' => 'fallback-icon',
    'class' => 'default-classes',
    'attributes' => ['attr' => 'value'],
]
```

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

### Configure command aliases

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/sync-icons-command.md

Sets command aliases for backwards compatibility.

```php
protected function configure(): void
```

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

### Handle SyncIconsCommand Exit Code in Shell

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Demonstrates how to check the command's exit status in a shell script.

```bash
# Check exit code in shell script
php artisan blade-fontawesome:sync-icons --kit=my-kit-id
if [ $? -ne 0 ]; then
    echo "Icon sync failed"
    exit 1
fi
```

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

### Run Project Tests

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/README.md

Execute the test suite for the Blade Font Awesome package using Composer.

```shell
composer test
```

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

### Combine component classes

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/configuration.md

Demonstrates how configured default classes merge with classes provided on the component instance.

```blade
<!-- Config has class: 'w-5 h-5' -->
<x-fas-star class="text-blue-500" />
<!-- Renders with both classes: w-5 h-5 text-blue-500 -->
```

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

### Factory Configuration Structure

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/types.md

The expected array structure for factory configuration accepted by Factory.add().

```php
[
    'path' => 'string',             // Icon directory path
    'prefix' => 'string',           // Component prefix
    'fallback' => 'string',         // Fallback icon
    'class' => 'string',            // Default classes
    'attributes' => array,          // Default attributes
]
```

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

### Configure Brand Icon Set

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/configuration.md

Default configuration for the Font Awesome Brands icon set.

```php
'brands' => [
    'prefix' => 'fab',
    'fallback' => '',
    'class' => '',
    'attributes' => [
        // 'width' => 50,
        // 'height' => 50,
    ],
]
```

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

### SyncIconsCommand Integration

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/compile-svgs-action.md

Iterates through icon set directories to execute the CompileSvgsAction on each set.

```php
foreach (new DirectoryIterator($destinationPath) as $directory) {
    if ($directory->isDot() || ! $directory->isDir()) {
        continue;
    }

    (new CompileSvgsAction(
        $directory->getPathname(),
        $directory->getPathname()
    ))->execute();
}
```

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

### Adding Icon Sets to Factory

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/integration.md

Defines the configuration for an icon set, including the path to SVG files and the component prefix.

```php
$factory->add('fontawesome-solid', [
    'path' => '/path/to/svg/directory',
    'prefix' => 'fas',
    'class' => '',
    'attributes' => [],
    'fallback' => '',
]);
```

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

### Detect Pro Icons and Fallback Logic

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/integration.md

Logic used to determine whether to register pro icons from the local resource path or fall back to free icons.

```php
if (is_dir($proIconsPath = resource_path('icons/blade-fontawesome'))) {
    // Use pro icons
    $this->registerProIcons($factory, $proIconsPath, $config);
    return;  // Skip free icons
}

// Use free icons as fallback
$factory->add('fontawesome-solid', ...);
```

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

### Package Default Configuration Structure

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/integration.md

The default configuration array structure defined in the package's config file.

```php
[
    'brands' => ['prefix' => 'fab', 'fallback' => '', 'class' => '', 'attributes' => []],
    'regular' => ['prefix' => 'far', ...],
    'solid' => ['prefix' => 'fas', ...],
    // ... pro sets ...
]
```

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

### Define icon generation rules

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/configuration.md

Configure source and destination paths for icon sets within the generation configuration file.

```php
return [
    [
        'source' => __DIR__.'/../node_modules/@fortawesome/fontawesome-free/svgs/regular',
        'destination' => __DIR__.'/../resources/svg/regular',
        'after' => $svgNormalization,
        'safe' => true,
    ],
    // ... more sets
];
```

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

### Render Kit Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Use the fak prefix to render icons from a custom kit.

```blade
<!-- Custom kit icons use the 'fak' prefix by default -->
<x-fak-custom-logo />
<x-fak-my-icon />
```

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

### Handle RuntimeException in command context

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Wrap execution logic in a try-catch block to handle RuntimeException and return failure codes.

```php
public function handle(): int
{
    try {
        (new CompileSvgsAction($source, $dest))->execute();
    } catch (RuntimeException $e) {
        $this->error($e->getMessage());
        return self::FAILURE;
    }
}
```

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

### Clear All Caches

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Commands to clear configuration, icon, and application caches to resolve rendering issues.

```bash
php artisan config:clear
php artisan icons:clear
php artisan cache:clear
```

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

### Configure Default Icon Classes

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Define default CSS classes in the configuration array to be applied to all icons within a specific set.

```php
'solid' => [
    'prefix' => 'fas',
    'class' => 'inline-block',  // Applied to all fas-* icons
]
```

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

### Optimize Icon Performance

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Enable icon caching to improve performance when working with large icon sets.

```bash
# Enable icon cache
php artisan icons:cache

# Optional: clear old caches
php artisan icons:clear && php artisan icons:cache
```

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

### Render Pro Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Use specific prefixes for duotone, light, thin, and sharp icon variants.

```blade
<!-- Duotone icons -->
<x-fad-shield />

<!-- Light icons -->
<x-fal-heart />

<!-- Thin icons -->
<x-fat-star />

<!-- Sharp variants -->
<x-fas:sharp-square />
<x-fal:sharp-circle />
```

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

### Package Dependencies

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/INDEX.md

Required PHP and Laravel package versions for the project.

```json
{
  "require": {
    "php": "^8.3",
    "blade-ui-kit/blade-icons": "^1.10",
    "illuminate/support": "^12.0|^13.0"
  }
}
```

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

### ConfigRepository Usage

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/types.md

Retrieving configuration values from the Laravel container.

```php
/** @var ConfigRepository $config */
$config = $container->make(ConfigRepository::class);
$config->get('blade-fontawesome.solid', [])
```

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

### BladeFontAwesomeServiceProvider Method Signatures

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/types.md

Method signatures for the service provider registration and booting processes.

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

private function registerConfig(): void
private function registerProIcons(
    Factory $factory,
    string $proIconsPath,
    ConfigRepository $config
): void
```

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

### Register Icon Set with Factory

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/integration.md

Registering an icon set by merging the path with the specific configuration retrieved from the application settings.

```php
$factory->add('fontawesome-solid', array_merge(
    ['path' => $path],
    $config->get('blade-fontawesome.solid', [])
));
```

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

### Registering Icon Sets with Factory

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/integration.md

Uses callAfterResolving to ensure the Blade Icons factory is available before registering icon sets.

```php
$this->callAfterResolving(Factory::class, function (Factory $factory, Container $container) {
    // Register icon sets with Factory
});
```

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

### Clear application cache

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Clear configuration and icon caches to resolve rendering issues.

```bash
php artisan config:clear
php artisan icons:clear
```

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

### SyncIconsCommand handle Method

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/sync-icons-command.md

The primary execution method for the command, returning an integer exit code.

```php
public function handle(): int
```

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

### Command Option Return Type

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/types.md

The option method returns a string, boolean, or null depending on whether the option is provided as a value, a flag, or omitted.

```text
string|bool|null
```

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

### Recover from Copy Operation Failures

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Steps to resolve permission or environment issues preventing file copies.

```bash
# Ensure destination directory is writable
chmod 755 resources/icons

# Create destination directory if missing
mkdir -p resources/icons/blade-fontawesome

# Verify disk space
df -h

# Retry sync
php artisan blade-fontawesome:sync-icons --pro
```

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

### Icon Component Syntax

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/INDEX.md

Standard syntax for rendering Font Awesome icons as Blade components.

```blade
<x-{prefix}-{icon-name} [attributes] />
```

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

### Visualize configuration merging flow

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

A representation of how configuration settings are merged from the package config through the service provider into the Blade Icons factory.

```text
config/blade-fontawesome.php:
  'solid' => [
      'prefix' => 'fas',
      'class' => 'my-class',
      'attributes' => ['role' => 'img']
  ]
    ↓
BladeFontAwesomeServiceProvider::register():
  array_merge(
      ['path' => 'resources/svg/solid'],
      config('blade-fontawesome.solid')
  )
    ↓
Factory Configuration:
  [
      'path' => 'resources/svg/solid',
      'prefix' => 'fas',
      'class' => 'my-class',
      'attributes' => ['role' => 'img']
  ]
    ↓
<x-fas-star /> renders with class and role applied
```

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

### Register method usage note

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/service-provider.md

Note regarding the automatic execution of the register method.

```php
// Automatically called by Laravel during bootstrap
// In your application's provider registration, this runs automatically
// if 'owenvoke/blade-fontawesome' is in composer.json extra.laravel.providers
```

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

### Cache icons command

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Cache icons when using pro or kit versions to improve performance.

```bash
php artisan icons:cache
```

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

### Set Fallback Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Configure a default icon to display when a requested icon is not found.

```php
'solid' => [
    'prefix' => 'fas',
    'fallback' => 'question',  // Uses fas-question if icon not found
    'class' => '',
    'attributes' => [],
],
```

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

### Publish Raw SVG Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/README.md

Use this command to publish all SVG icons to the public vendor directory for use with the `<img>` tag.

```shell
php artisan vendor:publish --tag=blade-fontawesome --force
```

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

### Check npm authentication

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Verify the current npm user to ensure access to private packages.

```bash
npm whoami
```

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

### Class Definition

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/compile-svgs-action.md

The base class definition for CompileSvgsAction.

```php
class CompileSvgsAction
```

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

### Render Basic Icons in Blade

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/README.md

Use standard Blade components to render free FontAwesome icons.

```blade
<x-fas-star />
<x-far-heart />
<x-fab-github />
```

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

### Using Multiple Icon Sets in Blade

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Demonstrates using different Font Awesome icon styles simultaneously via Blade components.

```blade
<!-- All three work together -->
<x-fas-star />     <!-- Solid -->
<x-far-star />     <!-- Regular -->
<x-fab-github />   <!-- Brands -->

<!-- Pro icons (if available) -->
<x-fad-shield />   <!-- Duotone -->
<x-fal-heart />    <!-- Light -->
```

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

### Invalid Kit ID error output

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/sync-icons-command.md

Output displayed when the --kit option is missing a value.

```text
You must provide a kit id when using the --kit option
```

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

### Render Brand Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Use the fab prefix for brand logos. Sizing can be controlled via CSS classes.

```blade
<!-- Render brand logos -->
<x-fab-github />
<x-fab-twitter />
<x-fab-facebook />

<!-- With sizing -->
<x-fab-github class="w-8 h-8" />
```

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

### Render Pro and Sharp Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/README.md

Access premium icon sets and sharp variants using specific component prefixes.

```blade
<x-fad-shield />      <!-- Duotone -->
<x-fal-heart />       <!-- Light -->
<x-fas:sharp-star />  <!-- Sharp Solid -->
```

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

### Parameter Table Format

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/README.md

Standardized Markdown table structure used for documenting method parameters.

```markdown
| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
```

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

### CompileSvgsAction Method Signatures

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/types.md

Constructor and execution method signatures for the SVG compilation action.

```php
public function __construct(string $svgDirectory, string $svgOutputDirectory)
public function execute(): void
```

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

### Pro Icons Auto-Detection

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/configuration.md

Logic used during the service provider registration phase to detect and register pro icons.

```php
if (is_dir($proIconsPath = resource_path('icons/blade-fontawesome'))) {
    $this->registerProIcons($factory, $proIconsPath, $config);
    return;
}
```

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

### Add Default Attributes

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Define default HTML attributes for all icons in a set.

```php
'brands' => [
    'prefix' => 'fab',
    'class' => '',
    'attributes' => [
        'width' => 24,
        'height' => 24,
        'role' => 'img',
        'aria-hidden' => 'true',
    ],
],
```

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

### Test Icon Rendering

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Blade template snippet to verify if a specific icon renders correctly.

```blade
<!-- Try rendering a known icon -->
<x-fas-star />

<!-- Check if it renders the SVG or throws error -->
```

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

### Add Default Classes

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Apply default CSS classes to all icons within a specific set.

```php
'solid' => [
    'prefix' => 'fas',
    'class' => 'inline-block',  // Added to all solid icons
    'attributes' => [],
],
```

```blade
<x-fas-star class="text-blue-500" />
<!-- Renders with both classes: inline-block text-blue-500 -->
```

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

### Duotone Icons (Pro)

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Renders duotone icons which support primary and secondary color styling.

```blade
<!-- Duotone icons render with primary and secondary colors -->
<x-fad-shield class="text-blue-500" />
<!-- Primary color: blue-500 -->
<!-- Secondary color: lighter blue (controlled by icon's two-color design) -->
```

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

### Register service provider method

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/service-provider.md

The register method signature used during the service container registration phase.

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

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

### Navigation Menu with Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Renders a dynamic navigation menu with conditional icon display.

```blade
<nav class="flex gap-4">
    @foreach($menuItems as $item)
        <a href="{{ $item['url'] }}" class="flex items-center gap-2">
            @if($item['icon'])
                <x-fas-{{ $item['icon'] }} class="w-5 h-5" />
            @endif
            {{ $item['label'] }}
        </a>
    @endforeach
</nav>
```

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

### Copy operation failed error output

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/sync-icons-command.md

Output displayed when the file copy operation fails.

```text
Unable to copy Font Awesome SVGs from '{$fullSourcePath}' to '{$destinationPath}'
```

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

### Icon Rendering Test Validation

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Validates successful icon compilation using snapshot testing.

```php
it('compiles a single anonymous component', function () {
    $result = svg('fas-plus')->toHtml();
    expect($result)->toMatchSnapshot();
});
```

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

### Merge Package Configuration

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/integration.md

Merging the package configuration with the published application configuration during the service provider registration.

```php
$this->mergeConfigFrom(
    __DIR__.'/../config/blade-fontawesome.php',
    'blade-fontawesome'
);
```

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

### Publish SVG Assets

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Publishes raw SVG files to the public directory for direct usage.

```bash
php artisan vendor:publish --tag=blade-fontawesome --force
```

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

### Sharp Icons (Pro)

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Displays sharp variant icons using specific component prefixes.

```blade
<!-- Sharp icons have geometric, angular designs -->
<x-fas:sharp-heart class="w-6 h-6" />
<x-fal:sharp-star class="w-6 h-6" />
<x-fad:sharp-shield class="w-6 h-6" />
```

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

### Render Solid Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Use the fas prefix for solid icons. Supports standard HTML attributes like class and style.

```blade
<!-- Render a solid icon -->
<x-fas-star />

<!-- With CSS classes -->
<x-fas-star class="w-6 h-6 text-yellow-500" />

<!-- With inline styles -->
<x-fas-star style="color: gold; font-size: 24px;" />
```

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

### Check Registered Icon Sets

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Debug script to inspect the currently registered icon sets via the Blade Icons factory.

```php
use BladeUI\Icons\Factory;

$factory = app(Factory::class);
$sets = config('blade-icons');  // All registered sets
dd($sets);
```

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

### SVG Preprocessing Transformation

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Demonstrates the transformation applied to Font Awesome SVGs to ensure compatibility with Blade Icons.

```svg
<svg height="1em" width="1em" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
```

```svg
<svg fill="currentColor" width="1em" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
```

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

### Factory Add Method Signature

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/types.md

The method signature for registering icon sets with the Blade Icons system.

```php
public function add(string $set, array $config): void
```

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

### Render Icons Programmatically

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Access the Blade Icons Factory to retrieve and render icons manually in PHP.

```php
use BladeUI\Icons\Factory;

$factory = app(Factory::class);
$svg = $factory->get('solid-star');  // Get SVG by set and icon name
echo $svg;  // Outputs SVG HTML
```

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

### Disable Icon Sets

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/configuration.md

Set an icon set key to false in the configuration to prevent it from being registered.

```php
'sharp-regular' => false,  // Disables Sharp Regular icons
'light' => false,          // Disables Light icons
```

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

### Render Regular Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Use the far prefix for regular icons. Attributes like role and aria-label can be added for accessibility.

```blade
<!-- Render a regular icon -->
<x-far-heart />

<!-- Combine with other attributes -->
<x-far-heart class="text-red-500" role="img" aria-label="Like" />
```

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

### Define BladeFontAwesomeServiceProvider class

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/service-provider.md

The main service provider class definition.

```php
final class BladeFontAwesomeServiceProvider extends ServiceProvider
```

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

### Array Configuration Type Alias

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/types.md

Represents the structure for icon set configuration arrays.

```php
array<string, mixed>  // Icon set configuration
```

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

### Validate Source Path Existence

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Checks if the source directory for Font Awesome SVGs exists and is accessible.

```php
if (! is_dir($fullSourcePath)) {
    $this->warn("Unable to find Font Awesome SVGs in '{$fullSourcePath}'");
    return self::FAILURE;
}
```

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

### Use SVG Directives

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Render icons using the @svg directive as an alternative to component syntax.

```blade
@svg('fas-star', 'w-6 h-6', ['id' => 'icon'])
```

```blade
<x-fas-star class="w-6 h-6" id="icon" />
```

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

### Use the @svg Directive

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

An alternative to Blade components for rendering icons. Supports string-based classes or an array of attributes.

```blade
<!-- Using the svg directive -->
@svg('fas-star')

<!-- With classes -->
@svg('fas-star', 'w-6 h-6 text-yellow-500')

<!-- With attributes array -->
@svg('fas-star', ['class' => 'w-6 h-6', 'id' => 'my-icon'])
```

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

### Register Custom Icon Sets

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Register additional icon directories using the Blade Icons Factory.

```php
use BladeUI\Icons\Factory;

app(Factory::class)->add('custom-icons', [
    'path' => resource_path('svg/custom'),
    'prefix' => 'icon',
]);

// Then use: <x-icon-myicon />
```

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

### Register Icon Set with Factory

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/configuration.md

Manually register an icon set with the Blade Icons Factory using merged configuration options.

```php
$factory->add('fontawesome-solid', array_merge(
    ['path' => __DIR__.'/../resources/svg/solid'],
    $config->get('blade-fontawesome.solid', [])
));
```

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

### Integer Type Aliases

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/types.md

Constants used for command exit status codes.

```php
self::SUCCESS  // int 0
self::FAILURE  // int 1
```

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

### Command Exit Codes

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/types.md

Standard integer constants used to indicate command success or failure.

```php
self::SUCCESS = 0
self::FAILURE = 1
```

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

### Disable Icon Sets

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Disable specific icon sets to reduce bundle size.

```php
'sharp-regular' => false,     // Disabled
'light' => false,             // Disabled
'duotone' => false,           // Disabled

// These remain active:
'solid' => [...],
'regular' => [...],
'brands' => [...],
```

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

### Registering Icon Sets with the Factory

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Registers free and pro icon sets with the Blade Icons factory, defining paths and prefixes for each style.

```php
// Free icon sets (always registered)
$factory->add('fontawesome-brands', [
    'path' => 'resources/svg/brands',
    'prefix' => 'fab',
    ...config for brands
]);

$factory->add('fontawesome-regular', [
    'path' => 'resources/svg/regular',
    'prefix' => 'far',
    ...config for regular
]);

$factory->add('fontawesome-solid', [
    'path' => 'resources/svg/solid',
    'prefix' => 'fas',
    ...config for solid
]);

// Pro icon sets (registered if resources/icons/blade-fontawesome exists)
$factory->add('fontawesome-duotone', [
    'path' => 'resources/icons/blade-fontawesome/duotone',
    'prefix' => 'fad',
    ...config for duotone
]);

// ... more pro sets ...
```

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

### Button with Icon

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Integrates an icon into a standard button component.

```blade
<button class="flex items-center gap-2 px-4 py-2 bg-blue-500 text-white rounded">
    <x-fas-download class="w-4 h-4" />
    Download Report
</button>
```

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

### CompileSvgsAction::execute

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/compile-svgs-action.md

Processes all SVG files in the source directory by modifying their content and writing them to the output directory.

```APIDOC
## execute()

### Description
Processes all SVG files in the source directory by modifying their content and writing them to the output directory. Each SVG is modified to use `fill="currentColor"` and height attributes are removed.

### Throws
- `RuntimeException` - If SVG file cannot be read
- `RuntimeException` - If processed SVG file cannot be written

### Example
```php
$action = new CompileSvgsAction(
    '/tmp/fontawesome-svgs/solid',
    resource_path('icons/blade-fontawesome/solid')
);

try {
    $action->execute();
} catch (RuntimeException $e) {
    Log::error('SVG processing failed: ' . $e->getMessage());
}
```
```

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

### Register Custom Icon Set Configuration

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/integration.md

Add custom icon sets to the blade-fontawesome.php configuration file to define prefixes, paths, and default attributes.

```php
'my-icons' => [
    'prefix' => 'myicon',
    'path' => resource_path('svg/custom'),
    'class' => '',
    'attributes' => [],
]
```

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

### SyncIconsCommand Signature

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/sync-icons-command.md

The command signature defining the available arguments and options for the sync-icons command.

```bash
blade-fontawesome:sync-icons
    {directory? : The root directory containing the node_modules directory}
    {--free : Use the fontawesome-free npm package}
    {--pro : Use the fontawesome-pro npm package}
    {--kit= : The Font Awesome kit id to use (these can be free or pro)}
```

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

### Execute Method Definition

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/compile-svgs-action.md

The execute method processes all SVGs in the source directory.

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

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

### Validate Kit ID in SyncIconsCommand

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Checks if the provided kit ID is a non-empty string before proceeding with synchronization.

```php
$kitId = $this->option('kit');

if (! is_string($kitId) || empty($kitId)) {
    $this->warn('You must provide a kit id when using the --kit option');
    return self::FAILURE;
}
```

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

### Accessible Icon with Label

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Configures an icon for accessibility using ARIA attributes.

```blade
<button aria-label="Close menu">
    <x-fas-times class="w-6 h-6" role="img" aria-hidden="true" />
</button>
```

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

### Throwing SVG Read Exception

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Exception signature for read failures.

```php
throw new RuntimeException('Unable to read SVG file.');
```

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

### Throwing SVG Write Exception

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/errors.md

Exception signature for write failures.

```php
throw new RuntimeException('Unable to write SVG file.');
```

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

### Customize Icon Prefixes

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/usage-guide.md

Modify icon set prefixes in the configuration file and update Blade component usage accordingly.

```php
// config/blade-fontawesome.php

'solid' => [
    'prefix' => 'icon',  // Change from 'fas' to 'icon'
    'fallback' => '',
    'class' => '',
    'attributes' => [],
],

'brands' => [
    'prefix' => 'brand',  // Change from 'fab' to 'brand'
    'fallback' => '',
    'class' => '',
    'attributes' => [],
],
```

```blade
<x-icon-star />      <!-- Instead of <x-fas-star /> -->
<x-brand-github />   <!-- Instead of <x-fab-github /> -->
```

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

### Apply Styling to Icons

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/README.md

Pass CSS classes directly to the icon component to control size and color.

```blade
<x-fas-star class="w-6 h-6 text-yellow-500" />
```

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

### SyncIconsCommand Class Definition

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/api-reference/sync-icons-command.md

The class definition for the SyncIconsCommand, which extends the base Laravel Command class.

```php
final class SyncIconsCommand extends Command
```

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

### Extend SVG Processing Pipeline

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/integration.md

Create a custom class extending CompileSvgsAction to inject additional processing logic into the SVG compilation pipeline.

```php
class CustomSvgProcessor extends CompileSvgsAction
{
    public function execute(): void
    {
        parent::execute();
        // Additional processing
    }
}
```

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

### Render Icons with Default Classes

Source: https://github.com/owenvoke/blade-fontawesome/blob/main/_autodocs/blade-icons-integration.md

Display icons in Blade templates, where default classes are automatically merged with any additional classes provided.

```blade
<x-fas-star />  <!-- Renders with class="inline-block" -->
<x-fas-star class="text-blue-500" />  <!-- Renders with both classes -->
```
Tokens:
Raw