README

This package provides a star field type for the Backpack for Laravel administration panel. The star field allows admins to change the value of a integer variable in order to rate the item, in a prettier way. It uses a CSS-only solution, so it has zero external dependencies and zero javascript.

Screenshots

Installation

Via Composer

composer require soufiene-slimi/star-field-for-backpack

Usage

Inside your custom CrudController:

CRUD::addField([
    'view_namespace' => 'star-field-for-backpack::fields',
    'name' => 'rate',
    'type' => 'star',
    // 'label' => 'Rating', // (optional)
    // 'count' => 8, // (optional) the max rate count; default value is 5
    // 'default' => 6, // (optional) the default checked rate on new item creation
    // 'hint' => 'Cheer up!', // (optional)
    // 'options' => [ // (optional) customize the look
    //     'icon' => '★', // (optional) the default icon is ★
    //     'unchecked_color' => '#ccc', // (optional) the default value is #ccc
    //     'checked_color' => '#ffc700', // (optional) the default value is #ffc700
    //     'hover_color' => '#c59b08', // (optional) the default value is #c59b08
    // ],
]);

Notice the view_namespace attribute - make sure that is exactly as above, to tell Backpack to load the field from this addon package, instead of assuming it's inside the Backpack\CRUD package.

Overwriting

If you need to change the field in any way, you can easily publish the file to your app, and modify that file any way you want. But please keep in mind that you will not be getting any updates.

Step 1. Copy-paste the blade file to your directory:

# create the fields directory if it's not already there
mkdir -p resources/views/vendor/backpack/crud/fields

# copy the blade file inside the folder we created above
cp -i vendor/soufiene-slimi/star-field-for-backpack/src/resources/views/fields/star.blade.php resources/views/vendor/backpack/crud/fields/star.blade.php

Step 2. Remove the vendor namespace wherever you've used the field:

$this->crud->addField([
-   'view_namespace' => 'star-field-for-backpack::fields'
    'name' => 'rate',
    'type' => 'star',
]);

Step 3. Uninstall this package. Since it only provides one file - star.blade.php, and you're no longer using that file, it makes no sense to have the package installed:

composer remove soufiene-slimi/star-field-for-backpack

Change log

Please see the changelog for more information on what has changed recently.

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email the author instead of using the issue tracker.

Credits

Cristian Tabacitu - created an example field type addon and shared it in this repo;
Soufiene Slimi - polish & packaging;
All Contributors

License

MIT. Please see the license file for more information.

soufiene-slimi / star-field-for-backpack

Maintainers

Details