Skip to content

valentin-morice/filament-json-column

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

filament-json-column

A simple package to view and edit your JSON columns in Filament.

image image

Installation

You can install the package via composer:

composer require valentin-morice/filament-json-column

Usage

The filament-json-column plugin works as any other Filament Form Builder class. Make sure the column on which it is called is casted to JSON or array within your Eloquent model.

public static function form(Form $form): Form
    {
        return $form
            ->schema([
                FilamentJsonColumn::make('example'),
            ]);
    }

It provides you with two tabs: Viewer & Editor. The Viewer tab pretty prints your JSON data, while the Editor tab lets you edit it conveniently. All the methods provided by the plugin accept closures, injected with standard Filament utilities.

Personnalize the accent color

The tab selector menu uses the slateblue CSS color by default. However, you can choose any other color:

FilamentJsonColumn::make('example')->accent(string '#FFFFFF'|Closure); // The input needs to be a valid CSS color

Display a single tab

If you'd like to use only one of the tabs, without giving your user the possibility to switch to another, use the following methods:

FilamentJsonColumn::make('example')->editorOnly(bool|Closure); // Displays only the editor tab
FilamentJsonColumn::make('example')->viewerOnly(bool|Closure); // Displays only the viewer tab

Change the height

FilamentJsonColumn::make('example')->editorHeight(int 500|Closure); // Accepts an int, defaults to 300
FilamentJsonColumn::make('example')->viewerHeight(int 500|Closure); // Accepts an int, defaults to 300

Credits

I've taken inspiration from the following plugins: Pretty JSON & JSONeditor.

License

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

About

A simple package to view and edit your JSON columns in Filament

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •