kristories/dashkit

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

Spatie's laravel-dashboard toollkit

0.0.1 2020-05-01 18:21 UTC

This package is auto-updated.

Last update: 2021-09-29 02:23:15 UTC


README

Packagist Packagist Packagist

Spatie's laravel-dashboard toollkit

Installation

Install via composer

composer require kristories/dashkit

After installing Dashkit, publish its assets using the dashkit:install Artisan command:

php artisan dashkit:install

Dashkit exposes a dashboard at /dashkit.

Configuration

After publishing Dashkit's assets, its primary configuration file will be located at config/dashkit.php.

Dashkit also publishes laravel-dashboard and Livewire assets.

Usage

Make a tile

php artisan dashkit:make-tile MyTile

This command generates :

app/Http/Livewire/MyTile.php

namespace App\Http\Livewire;

use Livewire\Component;

class MyTile extends Component
{
    /** @var string */
    public $position;

    public function mount(string $position)
    {
        $this->position = $position;
    }

    public function render()
    {
        return view('tiles.my_tile');
    }
}

resources/views/tiles/my_tile.blade.php

<x-dashboard-tile :position="$position">
    <h1>Hi, I'm a tile!</h1>
</x-dashboard-tile>

Adding tiles

Dashkit has a main view that can be changed via dashkit.php configuration file.

Inside the x-dashboard tag, you can add your tile, or use any of the available tiles.

<x-dashboard>
    <livewire:my-tile position="a1"/>
</x-dashboard>

Security

If you discover any security related issues, please email w.kristories@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.