Awesome Open Source
Awesome Open Source

Laravel Nova tool to manage app settings

Latest Version on Packagist Total Downloads Build License: MIT

Store and edit simple app-wide settings right in Nova. Settings are stored as JSON using spatie/valuestore, making them really easy to pull in and use everywhere else in your app.

Settings Tool screenshot

Installation

Install the package via Composer in any Laravel app using Nova:

composer require bakerkretzmar/nova-settings-tool

Publish the default configuration file to config/nova-settings-tool.php:

php artisan vendor:publish --tag="nova-settings-tool"

Register the tool with Nova in the tools method of your NovaServiceProvider:

// in app/Providers/NovaServiceProvider.php

use Bakerkretzmar\NovaSettingsTool\SettingsTool;

    // ...

    public function tools()
    {
        return [
            new SettingsTool,
        ];
    }

Usage

Settings are declared in a nova-settings-tool.php config file. This file specifies where settings are stored, what the tools title is in Novas sidebar, the layout of the settings page, and metadata about the settings themselves.

A default config file with some helpful examples is included as a starting point:

Each item in the settings array is rendered as an input with a label and help text, similar to one of Novas fields. Settings can also be grouped into panels, to separate them visually.

The settings actual values are stored as JSON at the location specified in the config filestorage/app/settings.json by default.

There are currently six available setting types:

  • text: Single-line text input
  • textarea: Multi-line text input
  • toggle: Boolean switch
  • code: CodeMirror text editor
  • number: Number input
  • select: Single-select dropdown

All strings in this package, and any you pass to it, can easily be translated using Laravels built-in localization features.

This tool also fires an event any time any settings are changed, with all the old and new settings attached.

Roadmap

The following features are planned or in development:

  • color setting type
  • date setting type
  • file setting type
  • setting validation

CHANGELOG CONTRIBUTING LICENSE


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Php (402,597
Vue (83,096
Laravel (12,988
Settings (508
Nova (286
Laravel Nova (140
Related Projects