Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: about 1 month 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 (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-18T18:59:16.000Z (about 2 months ago)
- Last Synced: 2024-10-01T09:23:35.808Z (about 1 month ago)
- Topics: laravel, laravel-package, livewire, livewire-components, livewire-laravel, livewire3, namespace
- Language: PHP
- Homepage:
- Size: 85 KB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
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 install the package via composer:
``` bash
composer require joserick/laravel-livewire-discover
```
## Enjoying this package? [](https://www.buymeacoffee.com/joserick)
## Config
Add to *AppServiceProvider.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/laravel-livewire-discover.php'*
``` bash
php artisan vendor:publish --tag livewire-discover-config
```
``` 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
```
## Config path for component creation
If you would like to automatically create components in a specific directory based on the prefix, you can configure it in the following way:
``` php
public function boot(): void
{
Livewire::discover('my-components', 'Namespaces\\Livewire', '/path/livewire');
}
```
## Creating components
You can create the files automatically using the following Artisan command. In the process it will ask you for the prefix to use, don't forget to put the path in the prefix settings.
```bash
php artisan make:livewire-discover RegisterAdmin
```
If you prefer kebab-cased names, you can use them as well:
```bash
php artisan make:livewire-discover 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 make:livewire-discover Auth\\RegisterAdmin
php artisan make:livewire-discover auth.register-admin
```
## Migration to v1
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.
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.