Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benjpaddock/livewire-urls
Get the previous and current url in Livewire.
https://github.com/benjpaddock/livewire-urls
Last synced: 3 days ago
JSON representation
Get the previous and current url in Livewire.
- Host: GitHub
- URL: https://github.com/benjpaddock/livewire-urls
- Owner: benjpaddock
- License: mit
- Created: 2024-08-22T18:11:53.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-22T18:49:00.000Z (5 months ago)
- Last Synced: 2024-11-11T03:23:53.788Z (2 months ago)
- Language: PHP
- Homepage:
- Size: 455 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Get the current and previous url in Livewire.
This package gives you a simple way to **retrieve the current and previous URL** in Livewire.
Unfortunately, Laravel or Livewire **cannot handle** this for you, since Livewire also makes requests to your server when a user interacts with your webpage. This means that the usual methods like `URL()->current()` **point to an internal Livewire** route, instead of the **"real route" your user is on**.
This package provides you with a middleware and **helper methods to determine which URL is currently being used**.
## Installation
You can install the package via composer:
```bash
composer require ralphjsmit/livewire-urls
```
Next, you should add `\RalphJSmit\Livewire\Urls\Middleware\LivewireUrlsMiddleware::class,` to your Http `Kernel.php`, in the `web` key of the `$middlewareGroups` property.
## Usage
### Current url
```php
use RalphJSmit\Livewire\Urls\Facades\Url;
$currentUrl = Url::current();
```
### Current route
```php
$currentRouteName = Url::currentRoute();
```
The `Url::currentRoute()` returns `null` when the user is on a route without a name.
### Previous url
```php
$previousUrl = Url::previous();
```
The `Url::previous()`-method returns `null` when there isn't a previous route available.
### Previous route
```php
$previousRouteName = Url::previousRoute();
```
The `Url::previousRoute()` returns `null` when there isn't a previous route or if the previous route wasn't a named route.
### Last recorded url
You can use the `Url::lastRecorded()` method to get the last url from the history that is _different_ from the current url.
For example:
1. User visits page A
2. User visits page B
3. User visits page B
The `Url::lastRecorded()` would give you the url of page A. The function returns `null` when there isn't an other url found, apart from the current session.
```php
$lastRecordedUrl = Url::lastRecorded();
```
### Last recorded route
You can use the `Url::lastRecordedRoute()` method to get the last route from the history that is _different_ from the current url/route.
```php
$lastRecordedRoute = Url::lastRecordedRoute();
```
The `Url::lastRecordedRoute()` would give you the route of page A from the previous example, **if page A is on a named route**. Otherwise, it would return `null`. The function also returns `null` when there isn't an other url found, apart from the current session.
## General
🐞 If you spot a bug, please submit a detailed issue and I'll try to fix it as soon as possible.
🔐 If you discover a vulnerability, please review [our security policy](../../security/policy).
🙌 If you want to contribute, please submit a pull request. All PRs will be fully credited. If you're unsure whether I'd accept your idea, feel free to contact me!
🙋♂️ [Ralph J. Smit](https://ralphjsmit.com)