litstack/meta

Maintainers

Details

github.com/litstack/meta

Source

Issues

Installs: 5 117

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 1

v2.0.7 2024-05-13 09:39 UTC

Requires

Requires (Dev)

MIT 16efe923601581f4e1fe4be8da13959141a24878

  • jannescb <jannes.woop@aw-studio.de>
  • lennartcb <lennart.carbe.woop@gmail.com>

This package is auto-updated.

Last update: 2024-11-13 10:52:18 UTC

README

Edit default meta-fields inside your crud-models and forms and receive them in your blade templates.

Installation

The package can be installed via composer and will autoregister.

composer require litstack/meta

You can now publish and migrate the migration for your meta model:

php artisan vendor:publish --provider="Litstack\Meta\MetaServiceProvider" --tag=migrations
php artisan migrate

Usage

Start by perparing your Crud-Model by using the HasMeta Trait and implement the metaable Contract:

use Litstack\Meta\Metaable;
use Litstack\Meta\Traits\HasMeta;

class Post extends Model implements Metaable
{
    use HasMeta;
}

In order to display the form in litstack edit your model-config:

public function show() 
{
    $page->card(function($form) {
        $form->seo();
    });
}

To display the meta-fields in your template, simply use the <x-lit-meta /> component and pass it the metaFields of your model.

@extends('app')

@section('meta')
    <x-lit-meta :for="$post" />
@endsection

And in your main template:

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    @yield('meta')
</head>

Default Values / Customizing / Overriding

If you want to use meta attributes directly from model attributes you can specify them in metaAttributes in your config. You may as well override the meta methods like metaAuthor to return dynamic meta attributes:

class Post extends Model implements Metaable
{
    use HasMeta;

    protected $metaAttributes = [
        'author' => 'author.name',
        'image'  => 'header_image',
    ];

    public function getHeaderImageAttribute()
    {
        // ...
    }

    public function metaTitle(): ?string
    {
        // Return a prefix:
        return "Awesome Blog: " . parent::metaTitle();
    }
}

You may set default attributes by setting defaultMetaAttributes or add a method defaultMeta... method:

class Post extends Model implements Metaable
{
    use HasMeta;

    protected $defaultMetaAttribute = [
        'description' => 'description',
    ];

    public function defaultMetaTitle()
    {

    }
}