Getting Started

Cagilo is distributed through the Composer package manager and automatically registers components in your application. To install, you need to run the following command in your Laravel project:

composer require cagilo/cagilo


Most of the configuration is done through the cagilo.php config file. Even though by default this isn't needed, if you'd like to adjust anything to this config file, you can publish it with the following command:

php artisan vendor:publish --tag=cagilo


Even though all components come enabled out-of-the-box, you may want to load only the components you need in your app for performance reasons. To do so, first publish the config file, then remove the components you don't need from the components settings.

You can also choose to use different names for components. Simply adjust the name for a component and reference it with a new name. For example, let's rename the alert component to notice:


return [
    'components' => [
        'notice' => Components\Alert::class,

Now, you can reference it in your Blade views as:

<x-notice type="success" />