README

A Laravel package to browse models and show them in cards, tables, etc.

Branch	Status	Code Coverage
Main
Staging
Dev

Installation

Install the package via Composer:

# First time installation
composer require internetguru/laravel-model-browser
# For updating the package
composer update internetguru/laravel-model-browser

Optionally publish the views and translations:

php artisan vendor:publish --tag=views --provider="Internetguru\ModelBrowser\ModelBrowserServiceProvider"
php artisan vendor:publish --tag=translations --provider="Internetguru\ModelBrowser\ModelBrowserServiceProvider"

# If you want to publish everything, you can use the `--provider` option:
php artisan vendor:publish --provider="Internetguru\ModelBrowser\ModelBrowserServiceProvider"

Run Tests Locally

In Visual Studio Code you can simpy use Ctrl+Shift+B to run the tests.

To run the tests manually, you can use the following commands:

# Build the Docker image
docker build -t laravel-model-browser-test .
# Run the tests
docker run --rm laravel-model-browser-test
# Both steps combined
docker build -t laravel-model-browser-test . && docker run --rm laravel-model-browser-test

Basic Usage

Show the model browser in your views:

<!-- Show the model browser in base view (cards) -->
<livewire:base-model-browser model="App\Models\User" />
<!-- Show the model browser in a table -->
<livewire:table-model-browser model="App\Models\User" />

Advanced Options

When using the TableModelBrowser component, you can customize its behavior by passing additional parameters.

Here are the advanced options you can use:

model: The model class to be used for browsing. Optionally, you can specify a method to be called on the model.
```
model="App\Models\User"
// or
model="App\Models\User@summary"
```

filterAttributes: An array of attributes that can be used to filter the data.

:filterAttributes="['created_at', 'name', 'email', 'last_login', 'last_activity', 'is_active']"

viewAttributes: An array of attributes that will be displayed in the table, with their corresponding translations used as labels.

:viewAttributes="[
    'created_at' => __('summary.created_at'),
    'name' => __('summary.name'),
    'email' => __('summary.email'),
    'last_login' => __('summary.last_login'),
    'last_activity' => __('summary.last_activity'),
    'is_active' => __('summary.is_active'),
]"

formats: An array of formatting functions for the attributes. You can specify a single function name or an array with up and down keys.

:formats="[
    'created_at' =>  [
        'up' => 'formatDateTime',
        'down' => 'globalFormatDown',
    ],
    'name' => 'formatUserDetailLink',
    'email' => 'formatEmailLink',
    'last_login' =>  [
        'up' => 'formatDateTime',
        'down' => 'globalFormatDown',
    ],
    'last_activity' =>  [
        'up' => 'formatDateTime',
        'down' => 'globalFormatDown',
    ],
    'is_active' => [
        'up' => 'formatBoolean',
        'down' => 'formatBooleanDown',
    ],
]"

alignments: An array of alignment settings for the attributes. You can specify start, end, or center.

:alignments="[
    'created_at' => 'start',
    'last_activity' => 'end',
    'is_active' => 'center',
]"

lightDarkStep: An integer value to control the light/dark step for table rows. It is used only for the table layout.
```
:lightDarkStep="2"
```

License & Commercial Terms

Open Source License

This software is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) license.

Disclaimer: This software is provided "as is", without warranty of any kind, express or implied. In no event shall the authors or copyright holders be liable for any claim, damages or other liability.

Commercial Use

The standard CC BY-NC-SA license prohibits commercial use. If you wish to use this software in a commercial environment or product, we offer flexible commercial licenses tailored to:

Your company size.
The nature of your project.
Your specific integration needs.

Note: In many instances (especially for startups or small-scale tools), this may result in no fees being charged at all. Please contact us to obtain written permission or a commercial agreement.

Contact for Licensing: info@internetguru.io

Professional Services

Are you looking to get the most out of this project? We are available for:

Custom Development: Tailoring the software to your specific requirements.
Integration & Support: Helping your team implement and maintain the solution.
Training & Workshops: Seminars and hands-on workshops for your developers.

Reach out to us at info@internetguru.io — we are more than happy to assist you!

internetguru / laravel-model-browser

Maintainers

Details