codebar-ag/filament-json-field

This is my package filament-json-field

v1.5.0 2024-07-15 10:15 UTC

This package is auto-updated.

Last update: 2024-10-15 10:53:33 UTC


README

Latest Version on Packagist Total Downloads run-tests PHPStan

πŸ’‘ What is Filament Json Field?

Filament Json Field is a Filament wrapper for Codemirror.

πŸ›  Requirements

βš™οΈ Installation

You can install the package via composer:

composer require codebar-ag/filament-json-field
php artisan filament:assets

Usage

Forms:

use CodebarAg\FilamentJsonField\Forms\Components\JsonInput;

...

public function form(Form $form): Form
{
    return $form
        ->schema([
            JsonInput::make('json')
                ->label('JSON')
                ->lineNumbers(true)
                ->lineWrapping(true)
                ->autoCloseBrackets(true)
                ->darkTheme(true)
                ->foldingCode(true)
                ->foldedCode(true), // Folded code will fold the code on form load
        ]);
}
...

Infolists:

use CodebarAg\FilamentJsonField\Infolists\Components\JsonEntry;

...

public function form(Form $form): Form
{
    return $form
        ->schema([
            JsonEntry::make('json')
                ->label('JSON')
                ->lineNumbers(true)
                ->lineWrapping(true)
                ->autoCloseBrackets(true)
                ->darkTheme(true)
                ->foldingCode(true)
                ->foldedCode(true), // Folded code will fold the code on form load
        ]);
}
...

Options

The following options are currently supported:

🚧 Testing

Copy your own phpunit.xml-file.

cp phpunit.xml.dist phpunit.xml

Run the tests:

./vendor/bin/pest

🚧 Building

node bin/build

Note: there is no output, but the build will be in the dist directory.

πŸ“ Changelog

Please see CHANGELOG for recent changes.

✏️ Contributing

Please see CONTRIBUTING for details.

composer test

Code Style

./vendor/bin/pint

πŸ§‘β€πŸ’» Security Vulnerabilities

Please review our security policy on reporting security vulnerabilities.

πŸ™ Credits

🎭 License

The MIT License (MIT). Please have a look at License File for more information.