PHPackages                             critiq/laravel-head-manifest - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. critiq/laravel-head-manifest

ActiveLibrary[Utility & Helpers](/categories/utility)

critiq/laravel-head-manifest
============================

Define your HTML head attributes in a manifest shared between Laravel and an SPA project so that robots crawling the page have access to up too path-specific metadata without requiring server side rendering on the SPA side

1124PHP

Since Dec 11Pushed 2y ago1 watchersCompare

[ Source](https://github.com/CritiqApp/laravel-head-manifest)[ Packagist](https://packagist.org/packages/critiq/laravel-head-manifest)[ RSS](/packages/critiq-laravel-head-manifest/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependenciesVersions (1)Used By (0)

Laravel Head Manifest
---------------------

[](#laravel-head-manifest)

### Installation

[](#installation)

**Step 1:** Add Laravel Head Manifest to your laravel project

```
composer require critiq/laravel-head-manifest
```

**Step 2:** Add `LaravelHeadManifestServiceProvider` to your app's configured providers

In `app/config/app.php`:

```
 'providers' => [

        ... // Other providers,

        App\Providers\RouteServiceProvider::class,
        + Critiq\LaravelHeadManifest\LaravelHeadManifestServiceProvider::class,
```

**Step 3:** Create your manifest file

In your `public` folder, create `head-manifest.json` with the following base structure:

```
{
    "defaultTitle": "Welcome to Laravel Head Manifest",
    "globalMeta": [],
    "defaultMeta": [],
    "paths": {
        "test/1": {
            "title": "Test1 Title",
            "meta": [
                {
                    "name": "Description",
                    "property": "description",
                    "content": "This is a description"
                }
            ]
        },
        "test/2": {
            "title": "Test2 Title",
            "meta": []
        },
    }

}
```

**Step 4:** In your blade file(s), add the `$metadata` variable

```

        +{!! $metadata !!}

        ... // Rest of blade template
```

Usage
-----

[](#usage)

### Define your path structures

[](#define-your-path-structures)

#### Basic path structure

[](#basic-path-structure)

In the manifest's `paths` values, you may define keys representing a path and an associated object containing the associated path's title and meta objects (more on meta objects later).

```
{
    ... // Rest of manifest
    "paths": {
        "/": {
            "title": "Home",
            "meta": [],
        }
    }
}
```

If you do not specify a `title` in the path object, it will fall back to your manifest's `defaultTitle` value.

#### Metadata structure

[](#metadata-structure)

The metadata structure is a dictionary of attributes which directly translates to the attributes of an HTML `meta` tag

For instance:

```
... // Rest of manifest
"meta": [
    { "name": "description", "content": "This is a sample meta description"}
],
```

Will convert to:

```

```

#### Global Metadata

[](#global-metadata)

Specifying the root `globalMeta` list of metadata objects will always be added. This is useful if you need metadata to exist on every page.

#### Default Metadata

[](#default-metadata)

Specifying the root `defaultMeta` list of metadata objects will only be added if the request path isn't matched, or if a path's `meta` field isn't specified. If you want to omit the default metadata from a path, pass an empty array as the `meta` value.

#### Path variables

[](#path-variables)

Laravel Head Manifest supports variable paths. While defining your path key, prefix a path section with `:` followed by the name of the variable.

Example:

```
{
    ... // Rest of manifest
    "paths": {
        "/page/:pageName": {
            "title": "You're visiting: :pageName",
        }
    }
}
```

If you were to navigate to `/page/cats`, this would match the `/page/:pageName` path and set `pageName` variable to "cats". You may reference this variable in any string within the path object.

#### Match all paths with prefix

[](#match-all-paths-with-prefix)

If you would like to support matching all nested paths from a root path, your may append your path name with a `*`.

Example:

```
{
    ... // Rest of manifest
    "paths": {
        "/admin/*": {
            "title": "Secret admin dashboard",
        }
    }
}
```

Visiting paths such as `/admin`, `/admin/banusers` and `/admin/purge/everything` will all match the defined `/admin/*` path.

### Get resolved path data from the server

[](#get-resolved-path-data-from-the-server)

Laravel Head Manifest includes a simple controller which may be used to resolve a path and return the head data for a specified path (without having to navigate to said path). This is in the form of the `LaravelHeadManifestController`. While there are many ways to use this controller, due to how Laravel's default `RouteServiceProvider` is structured, we recommend the following:

**Step 1:** In `app/Http/Controllers`, create a `HeadManifestController.php` file and define the controller with:

```