kirschbaum-development/nova-inline-select

An inline select field for Laravel Nova apps.

2.0.1 2022-05-23 17:05 UTC

Requires

• php: ^8.0

Requires (Dev)

• laravel/nova: ^4.2
• orchestra/testbench: ^7.4
• phpunit/phpunit: ^9.5.10

MIT

• Brandon Ferens

• nova
• laravel

README

An inline select field for Nova apps

This package contains a Nova select field that can update field values inline from the index and detail views.

Requirements

Nova Version	Inline Select Version
v1-3	^1.0
v4	^2.0

This Nova field requires Nova 1.0 or higher.

Installation

You can install this package in a Laravel app that uses Nova via composer:

composer require kirschbaum-development/nova-inline-select

Usage

Next you can use the KirschbaumDevelopment\Nova\InlineSelect field in your Nova resource:

namespace App\Nova;

use KirschbaumDevelopment\Nova\InlineSelect;

class User extends Resource
{
    // ...

    public function fields(Request $request)
    {
        return [
            // ...

            InlineSelect::make('Status'),

            // ...
        ];
    }
}

Use the InlineSelect field just like Nova's Select field. But now for the magic...

Inline editing

By default, the inline select field works just like a normal select field. To enable the inline editing capabilities we can use the inlineOnIndex() and inlineOnDetail() methods.

InlineSelect::make('Status')->options($options)
    ->inlineOnIndex()
    ->inlineOnDetail(),

The above inline select field will show up on both the index and detail views. When making a change to the select field, a button will display next to the field allowing you to commit the change. If you would rather the field auto-submits the change, simply add enableOneStepOnIndex() or enableOneStepOnDetail().

InlineSelect::make('Status')->options($options)
    ->inlineOnIndex()
    ->enableOneStepOnIndex(),

The inline select field on the index view now will auto-submit the changed value. You can also continue to use the old disableTwoStepOnIndex() method if you choose, which just calls enableOneStepOnIndex() under the hood.

You can also add the inline select to Lenses. Use the inlineOnLens() method. Auto-submitting works the same as well with enableOneStepOnLens().

InlineSelect::make('Status')->options($options)
    ->inlineOnLens()
    ->enableOneStepOnLens(),

Display using labels

This method works just like Nova's select field. It will display the option value rather than the option key.

InlineSelect::make('Status')->options($options)
    ->displayUsingLabels(),

Using closures as options() argument

You may pass a closure to the options method. It must return a key value pair array.

InlineSelect::make('Status')
    ->options(function () {
        return [
            'one' => 'foo',
            'two' => 'bar',
        ];
    }),

Validation caveats

In the case where fields on a model are required, which is likely, an extra step needs to be taken to ensure the inline select update persists and doesn't throw an error. The validation rule sometimes needs to be added to the updateRules() method on any field that is required.

Text::make('Email')
    ->rules('required', 'email')
    ->updateRules('sometimes'),

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] or [e-mail] instead of using the issue tracker.

Credits

• Brandon Ferens

Sponsorship

Development of this package is sponsored by Kirschbaum Development Group, a developer driven company focused on problem solving, team building, and community. Learn more about us or join us!

License

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