aon2003 / laravel-page-titles
A simple package that makes it easier to set a page title in a Laravel application.
Requires
- php: ^8.1
- illuminate/contracts: ^9.0
- spatie/laravel-package-tools: ^1.13.0
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^6.0
- nunomaduro/larastan: ^2.0.1
- orchestra/testbench: ^7.0
- pestphp/pest: ^1.21
- pestphp/pest-plugin-laravel: ^1.1
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpunit/phpunit: ^9.5
- spatie/laravel-ray: ^1.26
This package is auto-updated.
Last update: 2024-11-08 14:06:19 UTC
README
This simple package has only one purpose: compacting the job of setting page titles to a single file.
It makes available a global variable $page_title
in all blade templates and views using a Middleware.
Support us
Installation
You can install the package via composer:
composer require aon2003/laravel-page-titles
Next, you need to publish a config file and a language file:
php artisan vendor:publish --tag="laravel-page-titles"
Lastly, you need to add the custom middleware to your web's middleware group in your app/Http/Kernel.php
file.
'web' => [ ... \Aon2003\PageTitles\Middleware\PageTitles::class, ],
Usage
For the library to work all your routes MUST be named.
After the installation a global variable $page_title
will be available in all blade components.
It will contain the name of the current route,
which will be used to match a title that you can configure in the translation file: lang/en/page_titles.php
.
By default, the page_titles.php
file contains only two default page titles for route names 'index' and 'home'.
return [ 'index' => env('APP_NAME', 'Home Page'), 'home' => env('APP_NAME', 'Home Page'), ];
You can add your custom titles by adding lines in this file like this:
return [ ... '{route_name}' => '{page_title}', ];
Then, in your blade files you should add the following line so the titles are displayed:
<title>{{ __($page_title) }}</title>
Page titles with Variables
If you want to be able to pass variables to your page titles, you should pass them as an array to the view,
add numbered placeholders to the title in the language files
and change the <title>
tag in the blade files:
page_titles.php
:
return [ ... 'index' => 'Hello, :0!', ];
Controller
:
function index() { $page_props = ['Alex']; return view('{page}', compact('page_props')); }
{page}.blade.php
:
<title>{{ __($page_title, $page_params ?? []) }}</title>
The resulting page title should be: Hello, Alex!
Translations file name
If you want, you could use different translation file name.
The only thing you should do for it to work is to rename the translation files and change the translation_file_name
variable
in the page_titles.php
config file to the file name you want to use.
page_titles.php
:
return [ /* |-------------------------------------------------------------------------- | Translation File Name |-------------------------------------------------------------------------- | | Used to find the page titles translations. | If you change the translation file name, you MUST change this variable, too! | */ 'translation_file_name' => 'page-titles', ];
Internationalization
If your project supports internationalization, you can simply add more {language_code}/page_title.php
files to your lang
folder.
For more information check out the official Laravel docs.
Changelog
Please see CHANGELOG for more information on what has changed recently.
Credits
License
The MIT License (MIT). Please see License File for more information.