README

Based on encima-io/novachecklists

This package is made to allow you to easily create checklists in Laravel Nova. All you need is a text/json column on you model to store the items.

Installation

You can install the package via composer:

composer require ahmedkandel/nova-checklist

Usage

use Ahmedkandel\NovaChecklist\Checklist;

Checklist::make('Tasks')
    ->placeholder('Add another task')   // Defaults to "Add item"
    ->placeholderCounter()              // Not active by default
    ->storeUserName()                   // Not active by default, accepts user-model column. Uses "name" when column isn't provided.
    ->showDetails()                     // Not active by default
    ->showItemStatusOnIndex()           // Not active by default
    ->showCompletionOnIndex(),          // Not active by default

To use this package you'll need a text or JSON column on you model to save the items, as they are persisted as json on your model.

Form-page

The ->placeholder() method allows you to specify your placeholder-text for the "add new item field".

The ->placeholderCounter() method lets you show the item number when adding new item. If there is already 5 items, then it will say "Add item 6".

The ->storeUserName() method allows you to save which user created or completed the item. You specify which column on the User model you want to save on item, it default to use the "name" column.

The ->canEdit() method can be used to allow/disallow add/edit/delete items. By passing a boolean of closure to the method, If true the user can add/edit/delete items, If false the user can only check/uncheck items.

->canEdit(function ($request) {
    return $request->isCreateOrAttachRequest() || $request->user()->isAdmin();
})

You can edit an existing item by clicking on it unless it is not allowed by ->canEdit() method.

Detail-page

The ->showDetails() method lets you show who completed the item and how long ago it was completed.

Index-page

By default this package will only show the items count on the index page.

The ->showItemStatusOnIndex() will change the index to show how many items are completed of the total amount of items.

The ->showCompletionOnIndex() method will let you show how many percent of the items are completed.

When you click on the label a tooltip will all details will be shown.

License

The MIT License (MIT).

ahmedkandel / nova-checklist

Maintainers

Details