https://github.com/joserick/laravel-livewire-discover
Automatically discover and load/register multiple/different class namespaces for Livewire components.
https://github.com/joserick/laravel-livewire-discover
laravel laravel-package livewire livewire-components livewire-laravel livewire3 namespace
Last synced: 9 months ago
JSON representation
Automatically discover and load/register multiple/different class namespaces for Livewire components.
- Host: GitHub
- URL: https://github.com/joserick/laravel-livewire-discover
- Owner: joserick
- License: gpl-3.0
- Created: 2024-01-25T16:20:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-07T19:16:46.000Z (over 1 year ago)
- Last Synced: 2025-08-01T11:07:25.404Z (10 months ago)
- Topics: laravel, laravel-package, livewire, livewire-components, livewire-laravel, livewire3, namespace
- Language: PHP
- Homepage:
- Size: 134 KB
- Stars: 27
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Livewire Discover
  
> Notice: [Migration to v1.0](https://github.com/joserick/laravel-livewire-discover#migration-to-v1) || [I need previous version (v0.3)](https://github.com/joserick/laravel-livewire-discover#i-need-for-v0.3.2)
Automatically discover and load/register multiple/different class namespaces for Livewire components.
## Installation
You can add the package via composer:
``` bash
composer require joserick/laravel-livewire-discover
```
And then install the package with artisan:
```bash
php artisan livewire-discover:install
```
## Enjoying this package? [](https://www.buymeacoffee.com/joserick)
## Config
Add to *LivewireDiscoverServiceProvider.php*
``` php
public function boot(): void
{
// Load multiples namespace for Livewire components.
Livewire::discovers([
'my-components' => 'Namespaces\\Livewire',
'new-components' => 'User\\Repository\\Livewire',
]);
// Or individually
Livewire::discover('my-components', 'Namespaces\\Livewire');
Livewire::discover('new-components', 'User\\Repository\\Livewire');
}
```
Or if you like, use "componentNamespace" function as in [Blade Templates](https://laravel.com/docs/blade#clipText-53)
``` php
public function boot(): void
{
// Load multiples namespace for Livewire components.
Livewire::componentNamespace('Namespaces\\Livewire', 'my-components');
Livewire::componentNamespace('User\\Repository\\Livewire', 'new-components');
// ...
}
```
Or use the config: *'config/livewire-discover.php'*
``` php
// Load the namespace to Livewire components.
'class_namespaces' => [
// 'prefix' => 'class\\namespace',
'my-components' => 'Namespaces\\Livewire',
'new-components' => 'User\\Repository\\Livewire',
],
```
## Use
Call Livewire Components:
``` html
```
Or use form Routes:
``` php
// Load Livewire Component from Route
use Namespaces\Livewire\Devices;
use User\Repository\Livewire\DevicesTable;
Route::get('/devices', Devices::class); // resolve name my-components.devices
Route::get('/devices_table', DevicesTable::class); // resolve name new-components.devices-table
```
"Obviously" you need to install the "layout" first for the Routes
```bash
php artisan livewire:layout
```
## Extra
### Displays the list of loaded namespaces (prefix, aliases and paths)
If you want to check if all the namespaces are loading correctly you can run:
```bash
php artisan livewire-discover:list
```
Which will show you a table with all the information:
```bash
Livewire-Discover namespaces list:
Prefix: 'my-components' (Namespaces\\Livewire)
There is no "class path" defined for the config for prefix 'my-components'
Getting the "class path" from the composer autoload file
+-----------------------+-----------------------------------------------+
| Alias | Paths |
+-------------------------------------------+---------------------------+
| my-components.devices | /var/www/html/namespaces/livewire/devices.php |
+-----------------------+-----------------------------------------------+
```
### Create your components quickly
You can create the files automatically using the following Artisan command. In the process it will ask you for the prefix to use.
```bash
php artisan livewire-discover:make RegisterAdmin
# Or
php artisan make:livewire-discover RegisterAdmin
```
If you prefer kebab-cased names, you can use them as well:
```bash
php artisan livewire-discover:make register-admin
```
You may use namespace syntax or dot-notation to create your components in sub-directories. For example, the following commands will create a `RegisterAdmin` component in the `Auth` sub-directory:
```bash
php artisan livewire-discover:make Auth\\RegisterAdmin
php artisan livewire-discover:make auth.register-admin
```
Also if you don't want it to constantly ask you which prefix to select you can pass it directly with the `--prefix` attribute
### Manually configure the 'classpath' for component creation and listing
When automatically created components through the `artisan livewire-discover:make` this obtains the directory path based on 'Composer Autoload File' If for some reason it is not possible to do this, you can manually configure the path, adding it as the third parameter:
``` php
Livewire::discover(
'my-components',
'Namespaces\\Livewire',
app_path('/Path/Livewire') // <-- Components directory path
);
```
Now when you create the component it will be created in the path you have specified.
### Config 'view path' for component creation
Do you also want it to create the `view` at a specific route? Just add the view route and it will automatically create it, simple as that:
``` php
Livewire::discover(
'my-components',
'Namespaces\\Livewire',
app_path('/Path/Livewire')
resource_path('/views/path/livewire'), <-- Components views path
);
```
Remember that these are examples, you can specify any path within your project and it will create it.
## Migration to v1
### Rename Config File
The configuration file name has changed from `laravel-livewire-discover.php` to simply `livewire-discover-php`
### Attributes Reversed
Replace `Livewire::discover` for `Livewire::componentNamespace` since the attributes in v1 are reversed but the `componentNamespace` function maintains the structure of previous versions.
``` php
Livewire::discover('Namespaces\\Livewire', 'my-components');
```
to
``` php
Livewire::componentNamespace('Namespaces\\Livewire', 'my-components');
```
or in any case to maintain the use of the `discover()` function you can invert the parameters.
### Dot-Notation
Change in concatenation of prefixes with class name, previously it was concatenated using the "-" notation, now the dot-notation is used, so it must be changed in all calls to Livewire-Discover components
``` html
```
to
``` html
```
## I need for v0.3.2
```
composer require joserick/laravel-livewire-discover:0.3.2
```
## License
The GNU Public License (GPLv3). Please see [License File](https://github.com/joserick/laravel-livewire-discover/blob/master/LICENSE) for more information.