README

This Laravel package provides an effortless way to implement beautiful and responsive dashboard templates from Taildashboards. Taildashboards offers a collection of pre-designed templates built with Tailwind CSS, and this package helps you to incorporate them into your Laravel application with ease.This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Installation

You can install the package via composer:

composer require ivanaquino/laravel-taildashboards

You need tailwind installation on your laravel, if you're using jetstream or breeze you have it installed but if not you can follow the official tailwindcss guide

You will need the npm package @tailwindcss/typography, and add the font config to your tailwind.config.js

export default {
    theme: {
        extend: {
            fontFamily: {
                sans: ["Figtree", ...defaultTheme.fontFamily.sans],
            },
        },
    },
    plugins: [require("@tailwindcss/typography")],
};

If you're having problems with broken styles you can add this line into tailwind.config.js

export default {
    content: [
        // ...
        "./vendor/ivanaquino/laravel-taildashboards/resources/views/**/*.blade.php",
        // ...
    ],
};

You can publish the config file with:

php artisan vendor:publish --tag="taildashboards-config"

In this file you'll be able to edit the menu for the dashboard

'menu' => [
    [
        'label' => 'Dashboard',
        'route' => 'dashboard',
        'active_route' => 'dashboard',
        'icon' => 'home',
    ],
    [
        'label' => 'View 1',
        'route' => 'view-1',
        'active_route' => 'view-1',
        'icon' => 'circle',
    ],
    [
        'label' => 'View 2',
        'route' => 'view-2',
        'active_route' => 'view-2',
        'icon' => 'home',
    ],
],

Optionally, you can publish the views using

php artisan vendor:publish --tag="laravel-taildashboards-views"

Usage

# As blade layout
@extends('laravel-taildashboards::layouts.tailapp')

@section('content')
    Lorem ipsum dolor sit amet consectetur adipisicing elit.
@endsection

# Or as a component layout
<x-laravel-taildashboards::layout-tailapp>
    Lorem, ipsum dolor sit amet consectetur
</x-laravel-taildashboards::layout-tailapp>

Availables

@extends('laravel-taildashboards::layouts.tailapp')
@extends('laravel-taildashboards::layouts.tailism')

<x-laravel-taildashboards::layout-tailapp>
<x-laravel-taildashboards::layout-tailism>

Roadmap

TailApp
TailTube
TailFlix
TailLism
TailAdmin
TailSocial
Custom components for each dashboard
Test suit

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

ivanaquino / laravel-taildashboards

Maintainers

Details