koverae/koverae-ui-builder

Koverae UI Builder is a flexible and intuitive interface builder package designed specifically for Laravel. Built with the power of Koverae’s ecosystem in mind, it allows developers to easily create, customize, and manage UI components like navigation bars, forms, buttons, and more—without the hassl

v0.3.1 2024-10-12 07:05 UTC

Requires

• php: ^7.4|^8.0
• laravel/framework: ^10.0
• larswiegers/laravel-maps: ^0.18.0
• livewire/livewire: ^3.0
• nwidart/laravel-modules: ^10.0

Requires (Dev)

• phpunit/phpunit: ^9.0

MIT

• Arden BOUET

• form
• laravel
• laravel-modules
• form-builder
• livewire
• ui-builder
• koverae
• koverae-ui-builder

README

Koverae UI Builder is a flexible and intuitive interface builder package designed specifically for Laravel. Built with the power of Koverae’s ecosystem in mind, it allows developers to easily create, customize, and manage UI components like navigation bars, forms, buttons, and more—without the hassle of manual coding.

Installation

To get started, require the package via Composer:

composer require koverae/koverae-ui-builder

The package will automatically register a service provider and alias.

Optionally, publish the package's configuration file by running:

composer require koverae/koverae-ui-builder --provider"Koverae\KoveraeUiBuilder\KoveraeUiBuilderServiceProvider"

Publish the package's configuration file:

php artisan vendor:publish --tag=koverae-ui-builder-config

Macking Components:

Command Signature

php artisan koverae:make-form <Component>
php artisan koverae:make-table <Component>
php artisan koverae:make-cart <Component>

Examples

php artisan koverae:make-form UserForm
php artisan koverae:make-table UserTable
php artisan koverae:make-cart UserCart

Output

COMPONENT CREATED  🤙🏿

CLASS: App/Livewire/Form/UserForm
TAG: <livewire:form.user-form />

CLASS: App/Livewire/Table/UserTable
TAG: <livewire:table.user-table />

CLASS: App/Livewire/Cart/UserCart
TAG: <livewire:cart.user-cart />

Making Components (Nwidart Module):

To make a component inside a Laravel Module User

Command Signature

Currently the package only supports the following types of components: Form, Table and Cart.

php artisan koverae:module-component <Component> --type=form <Module>
php artisan koverae:module-component <Component> --type=table <Module>
php artisan koverae:module-component <Component> --type=cart <Module>

Examples

php artisan koverae:module-component UserForm --type=form User
php artisan koverae:module-component UserTable --type=table User
php artisan koverae:module-component UserCart --type=table User

Output

MODULE COMPONENT CREATED  🤙🏿

CLASS: Modules/User/Livewire/Form/UserForm
TAG: <livewire:user::form.user-form />

CLASS: Modules/User/Livewire/Table/UserTable
TAG: <livewire:user::table.user-table />

CLASS: Modules/User/Livewire/Cart/UserCart
TAG: <livewire:user::cart.user-cart />

Usage

To use a component, simply place its tag wherever you want it to appear:

<!-- Component (Form) -->
<livewire:form.user-form />

<!--  Module Component (Form) -->
<livewire:user::form.user-form />

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

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

Credits

• Arden BOUET
• All Contributors

License

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