Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/laravel-view-components
A better way to connect data with view rendering in Laravel
https://github.com/spatie/laravel-view-components
components html laravel rendering
Last synced: about 1 month ago
JSON representation
A better way to connect data with view rendering in Laravel
- Host: GitHub
- URL: https://github.com/spatie/laravel-view-components
- Owner: spatie
- License: mit
- Archived: true
- Created: 2018-05-23T10:40:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-24T08:46:08.000Z (almost 5 years ago)
- Last Synced: 2024-11-06T04:19:07.533Z (about 2 months ago)
- Topics: components, html, laravel, rendering
- Language: PHP
- Homepage: https://spatie.be/open-source/packages
- Size: 46.9 KB
- Stars: 238
- Watchers: 6
- Forks: 23
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
**THIS PACKAGE HAS BEEN ABANDONED**
# A better way to connect data with view rendering in Laravel
[](https://packagist.org/packages/spatie/laravel-view-components)
[](https://github.styleci.io/repos/134554591)
[](https://scrutinizer-ci.com/g/spatie/laravel-view-components)
[](https://packagist.org/packages/spatie/laravel-view-components)
View components are a way to help organize logic tied to view, similar to [view composers](https://laravel.com/docs/5.6/views#view-composers).
```php
namespace App\Http\ViewComponents;
use Illuminate\Http\Request;
use Illuminate\Contracts\Support\Htmlable;
class NavigationComponent implements Htmlable
{
/** \Illuminate\Http\Request */
private $request;
/** @var string */
private $backgroundColor;
public function __construct(Request $request, string $backgroundColor)
{
$this->request = $request;
$this->backgroundColor = $backgroundColor;
}
public function toHtml(): string
{
return view('components.navigation', [
'activeUrl' => $this->request->url(),
'backgroundColor' => $this->backgroundColor,
]);
}
}
```
```blade
@render('navigationComponent', ['backgroundColor' => 'black'])
```
A view component can be anything that implements Laravel's `Htmlable` contract, so you don't necessarily need to use Blade views to render the component. This is useful for wrapping third party HTML packages, like [spatie/laravel-menu](https://github.com/spatie/laravel-menu).
```php
namespace App\Http\ViewComponents;
use Illuminate\Contracts\Support\Htmlable;
use Illuminate\Contracts\Auth\Guard;
use Spatie\Menu\Laravel\Menu;
class MainMenuComponent implements Htmlable
{
/** @var \Illuminate\Contracts\Auth\Guard */
private $guard;
/** @var string */
private $class;
public function __construct(Guard $guard, string $class = null)
{
$this->guard = $guard;
$this->class = $class;
}
public function toHtml(): string
{
$menu = Menu::new()
->addClass($this->class)
->url('/', 'Home')
->url('/projects', 'Projects');
if ($this->guard->check()) {
$menu->url('/admin', 'Adminland');
}
return $menu;
}
}
```
```blade
@render('mainMenuComponent', ['class' => 'background-green'])
```
The benefit over view composers is that data and rendering logic are explicitly tied together in components instead of being connected afterwards. They also allow you to seamlessly combine properties and dependency injection.
This package is based on *[Introducing View Components in Laravel, an alternative to View Composers](https://laravel-news.com/introducing-view-components-on-laravel-an-alternative-to-view-composers)* by [Jeff Ochoa](https://twitter.com/@Jeffer_8a).
## Support us
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
```bash
composer require spatie/laravel-view-components
```
No additional setup necessary. Laravel will automatically discover and register the service provider.
Optionally you can publish the config file with:
```bash
php artisan vendor:publish --provider="Spatie\ViewComponents\ViewComponentsServiceProvider" --tag="config"
```
This is the default content of the file that will be published at `config/view-components`:
```php
return [
/*
* The root namespace where components reside. Components can be referenced
* with camelCase & dot notation.
*
* Example: 'root_namespace' => App\Http\ViewComponents::class
*
* `@render('myComponent')
* => `App\Http\ViewComponents\MyComponent`
*/
'root_namespace' => 'App\Http\ViewComponents',
/*
* Register alternative namespaces here, similar to custom view paths.
*
* Example: 'navigation' => App\Services\Navigation::class,
*
* `@render('navigation::mainMenu')`
* => `App\Services\Navigation\MainMenu`
*/
'namespaces' => [
// 'navigation' => App\Services\Navigation::class,
],
];
```
## Usage
### The `@render` directive
The `@render` Blade directive accepts two arguments: the first is the view component's path or class name, the second is an extra set of properties (optional).
You can choose between referencing the component via a path or a class name.
```blade
@render('myComponent')
@render(App\Http\ViewComponents\MyComponent::class)
```
Parameters will be injected in the view components `__construct` method. The component is instantiated with Laravel's container, so parameters that aren't provided by render will be automatically injected.
```php
use Illuminate\Http\Request;
class MyComponent implements Htmlable
{
public function __construct(Request $request, string $color)
{
$this->request = $request;
$this->color = $color;
}
// ...
}
```
```blade
@render('myComponent', ['color' => 'red'])
```
In the above example, `$color` is explicitly set, and a `$request` object will be injected by Laravel.
### Configuration
#### The root namespace
By configuring `root_namespace`, you can define where the bulk of your view components are located. By default, this is in `App\Http\ViewComponents`.
```
app/
Http/
ViewComponents/
MyComponent.php
Nested/
NestedComponent.php
```
The above components can be rendered with `@render('myComponent')` and `@render('nested.nestedComponent')`.
#### Additional namespaces
You can register additional namespaces in the `namespaces` configuration, similar to view paths.
``` php
return [
'namespaces' => [
'navigation' => App\Services\Navigation::class,
],
];
```
```
app/
Services/
Navigation/
Menu.php
```
The above `Menu` component can now be rendered with `@render('navigation::menu')`.
### Testing
``` bash
composer test
```
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Sebastian De Deyne](https://github.com/sebastiandedeyne)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.