rodrigopedra/laravel-history-navigation

History navigation inspired by JavaScript's History API

v1.2.0 2023-02-17 13:29 UTC

Requires

• php: ^8.1
• illuminate/auth: ^10.0
• illuminate/contracts: ^10.0
• illuminate/http: ^10.0
• illuminate/routing: ^10.0
• illuminate/support: ^10.0
• jakeasmith/http_build_url: ^1.0.1

MIT

• Rodrigo Pedra Brum

• laravel
• history
• History navigation

README

History navigation inspired by the browser's History API

composer require rodrigopedra/laravel-history-navigation

• Version 1.0.0 supports Laravel 10.x (and as such, requires PHP 8.1)
• Version 0.9.x supports Laravel from version 6.x through 9.x

Introduction

This package aims to mimic the browser's History API.

It tries to automatically track the navigation history, and provides two global helpers to allow redirecting a user back on history.

The idea was to provide back history navigation to applications which do deep navigation, such as drill-down data dashboards, and doesn't always have a clear back path.

Usage

On a view you can use the navigate_back() helper as the href of a a back link/button:

<a href="{{ navigate_back('/') }}">Go back</a>

The parameter is a default destination, in case the history is empty.

There is also the navigate_default() helper. It will check if a use_default query parameter is present in the request, if so it will try to redirect to the default route defined as its parameter. If the query parameter is not present it will defer to navigate_back().

Configuration

You can publish the configuration by running

php artisan vendor:publish --provider=RodrigoPedra\\HistoryNavigation\\HistoryNavigationServiceProvider

You should now have a file called navigate-back.php under your config folder. Below are the default values:

<?php

return [
    'default-url' => '/',
    'history-limit' => 50,
    'skip-patterns' => [],
    'query' => [
        'remove-empty' => true,
        'ignore-parameters' => ['page'],
    ],
];

Caveats

This package relies on the user's session, as such if a user has multiple tabs or windows opened and navigates within the same application, it will not work as expected as it will mix the different tabs/windows navigation history.

This package was developed with a very specific scenario in mind, for an intranet application that ran within a single window browser wrapper (similar to electron).

Nowadays, I do not recommend its adoption on new projects, and advise on using the browser's native History API.