gammamatrix/playground-blade

Playground: Provides Blade UI handling.

dev-develop / 73.x-dev 2024-04-01 20:55 UTC

Requires

• php: ^8.2
• gammamatrix/playground: dev-develop|dev-master|dev-feature/*|^73.0@dev|^73.0

Requires (Dev)

• gammamatrix/playground-auth: dev-develop|dev-master|dev-feature/*|^73.0@dev|^73.0
• gammamatrix/playground-test: dev-develop|dev-master|dev-feature/*|^73.0@dev|^73.0

MIT

• Jeremy Postlethwaite

• laravel
• playground
• blade
• gammamatrix
• playground-blade

README

The Playground Blade package for Laravel applications.

This package provides Blade UI handling.

Read more on using Playground Blade at Read the Docs: Playground Documentation.

Installation

You can install the package via composer:

composer require gammamatrix/playground-blade

Configuration

You can publish the config file with:

php artisan vendor:publish --provider="Playground\Blade\ServiceProvider" --tag="playground-config"

See the contents of the published config file: config/playground-blade.php

Read more on using Environment Variables at the Read the Docs for Playground Blade.

UI Layouts

NOTE: Using Blade is not required to use Playground, it just an option, such as Vue, React or TypeScript.

The configuration in config/playground-blade.php has a section for frontend assets. If you would like to add more assets, CSS or JavaScript, publish the configuration and add them to the libs section.

Assets may be loaded into either head or they will be added to the end of the body.

By default, the following libraries are loaded.

• favicon: /favicon.ico
• Nunito: Loaded from Google Fonts.
• Bootstrap: v5.3.3
• FontAwesome: v6.5.1
• CKEditor 5: v41.1.0
• Vue 3 - v3.4.21
• /vendor/playground/blade.js A small library to be loaded for Blade UI usage. Needs to be published.

Optionally, a page may load:

• CKEditor 5 an advanced WYSIWYG editor for forms.

Assets

If you are using the Playground Blade UI, you can publish the JS assets with:

php artisan vendor:publish --tag playground-blade-js

• These Javascript assets, resources/js/playground-blade.js, provide simple helpers for features such as Bootstrap Form Validation and loading CKEditor for textarea elements on forms.

Publishes CSS:

php artisan vendor:publish --tag playground-blade-css

You can publish the layouts file with:

php artisan vendor:publish --tag playground-blade-layouts

Components may also be published:

php artisan vendor:publish --tag playground-blade-components

Error pages are available at:

php artisan vendor:publish --tag playground-blade-errors

Testing

composer test

PHPStan

Tests at level 9 on:

• config/
• resources/views/
• src/
• tests/Feature/
• tests/Unit/

composer analyse

About

Playground Blade provides information in the artisan about command.

Changelog

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

Credits

• Jeremy Postlethwaite

License

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