polashmahmud/inertia-toast

Inertia Toast

Simple, zero-boilerplate toast notifications for Laravel + Inertia.js (Vue) using vue-sonner.

It ships with:

• Laravel middleware that exposes flash messages to Inertia
• A tiny Vue plugin that auto-mounts the Toaster and listens to Inertia navigations
• A publishable config to customize position, theme, and behavior

Installation

1. Install the package

composer require polashmahmud/inertia-toast:^2.0.1

2. Install the client dependency

npm install vue-sonner

3. Add the plugin in your Vue app (auto-mounts Toaster)

resources/js/app.ts

import "vue-sonner/style.css";
import notification from "@inertia-toast/plugins";

createInertiaApp({
  // ...
  setup({ el, App, props, plugin }) {
    createApp({ render: () => h(App, props) })
      .use(plugin)
      .use(notification)
      .mount(el);
  },
});

You do NOT need to render <Toaster /> yourself—the plugin does it for you.

4. Vite alias

vite.config.ts

import path from "path";

export default defineConfig({
  resolve: {
    alias: {
      "@inertia-toast": path.resolve(
        __dirname,
        "vendor/polashmahmud/inertia-toast/resources/js"
      ),
    },
  },
});

Optionally, add a TypeScript path mapping for better editor DX in tsconfig.json:

{
  "compilerOptions": {
    "paths": {
      "@inertia-toast/*": ["./vendor/polashmahmud/inertia-toast/resources/js/*"]
    }
  }
}

5. Publish the config

php artisan vendor:publish --tag="inertia-toast-config"

This creates config/inertia-toast.php where you can tweak:

return [
    'position' => 'bottom-right', // top-left | top-center | top-right | bottom-left | bottom-center | bottom-right
    'closeButton' => true,
    'expand' => false,
    'theme' => 'system',          // light | dark | system
    'richColors' => true,
    'toastOptions' => [
        'style' => [],
        'class' => '',
        'descriptionClass' => '',
    ],
];

Usage

From your controller or route, flash to the session. The plugin automatically shows a toast after the Inertia visit finishes.

Minimal (string body):

return back()->with('success', 'That worked nicely');

With description (indexed array):

return back()->with('warning', ['That worked nicely', 'Please check again']);

With description (associative array):

return back()->with('error', [
        'message' => 'Something went wrong!',
        'description' => 'Please try again after 5 seconds.',
]);

Supported types: success, error, warning, info.

Custom Styling

You can customize the appearance of the toast notifications by modifying the toastOptions in config/inertia-toast.php.

'toastOptions' => [
    'style' => [
        'background' => '#fda4af',
    ],
    'class' => 'bg-red-500 text-white',
    'descriptionClass' => 'text-red-100',
],

Using Tailwind CSS

If you want to use Tailwind CSS classes in the class or descriptionClass options, you must ensure that Tailwind scans your configuration file. Add the config file path to the content array in your tailwind.config.js:

module.exports = {
  content: [
    "./resources/**/*.blade.php",
    "./resources/**/*.js",
    "./resources/**/*.vue",
    "./config/inertia-toast.php", // Add this line
  ],
  // ...
};

Troubleshooting

• Changed config but UI didn’t update?
  • Run: php artisan optimize:clear
  • Hard refresh the browser (Disable cache in DevTools)
  • Ensure the provider is registered and alias resolves

License

MIT