simtabi/larabell

Sweetalert and Toaster notifications for Laravel livewire with support for tailwind and bootstrap

dev-master 2023-03-13 19:54 UTC

This package is auto-updated.

Last update: 2024-09-26 03:26:12 UTC


README

banner

Larabell

A Laravel Livewire library to help you integrate SweetAlert and Toasts on yor applications.

Installation

composer require simtabi/larabell

How to use

1. Add LarabellServiceProvider in config/app.php

    ...
    \Simtabi\Larabell\LarabellServiceProvider::class
    ...

2. Include javascript

    ...
    // place this directive in the header
    @larabellCss

    // no need to call this, as it has already been called when you call @larabellScripts
    @larabellInit
    ...

3. Extra config file

Publish the configs: php artisan vendor:publish --tag=larabell:assets. Publish the configs: php artisan vendor:publish --tag=larabell:config. Publish the configs: php artisan vendor:publish --tag=larabell:views.

See available configuration

Building toasts and sweetalerts

To make it easy to build toasts and sweetalerts, we have implemented chained methods to help you with building

Sweetalert

In your component add Toast trait. Then call toast method whenever you want.

use Simtabi\Larabell\HasLarabell;
use Livewire\Component;

class MyComponent extends Component
{
    use HasLarabell;

    public function save() {
        $this->fireSwalNotification();
    }

}

sweetalert parameters:

  • title
  • icon: success, error, warning, info, question - default is info
  • timeout: in milliseconds, default is 5000

Toast

This is the normal sweetalert modal. In your component add Fire trait. Then call fire method whenever you want.

use Simtabi\Larabell\HasLarabell;
use Livewire\Component;

class MyComponent extends Component
{
    use HasLarabell;

    public function save() {
        $this->fireToastNotification();
    }

}

toast parameters:

Refer to the documentation online at: https://github.com/kamranahmedse/jquery-toast-plugin

Credits