Download the PHP package jdw5/surge-toast without Composer
On this page you can find all versions of the php package jdw5/surge-toast. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jdw5/surge-toast
More information about jdw5/surge-toast
Files in jdw5/surge-toast
Package surge-toast
Short Description A Vue 3 + Inertia plugin to render headless toast components.
License MIT
Informations about the package surge-toast
Surge Toast
Server-side counterpart to surge-toast-client
for Vue/Inertia. It provides a global macro to flash data to the session, with the client library automatically hooked up to receive router events from InertiaJs.
Installation
Install the package via composer:
To provide the link to the frontend, ensure you have a middleware for sharing props on all requests via Inertia. The starter kits will have this installed as HandleInertiaRequests
middleware. Copy the following to the share
function in this middleware, or equivalent:
This will share all toast messages to your frontend under the property toast
. To use the client library, use the plugin in the app.js
file after installing. See the documentation for the Javascript library here
Usage
The package provides a global way to flash data to the session, via the structure of ToastData
. ToastData accepts the following parameters:
You can call the method from a controller through the following ways
Or any combination of this. This will flash a message to the session with the type
provided, or will use the default
type if not specified
You can also shortcut the types using the following methods:
Which will set the type for you. You can also chain with the duration
and title
methods:
License
The MIT License (MIT). Please see License File for more information.