codebar-ag/filament-json-field

This is my package filament-json-field

v1.4.0 2024-03-26 17:15 UTC

This package is auto-updated.

Last update: 2024-05-03 10:48:54 UTC


README

68747470733a2f2f62616e6e6572732e6265796f6e64636f2e64652f46696c616d656e742532304a736f6e2532304669656c642e706e673f7468656d653d6c69676874267061636b6167654d616e616765723d636f6d706f7365722b72657175697265267061636b6167654e616d653d636f64656261722d616725324666696c616d656e742d6a736f6e2d6669656c64267061747465726e3d63697263756974426f617264267374796c653d7374796c655f32266465736372697074696f6e3d412b4c61726176656c2b46696c616d656e742b4a736f6e2b4669656c642b696e746567726174696f6e2e266d643d312673686f7757617465726d61726b3d3126666f6e7453697a653d313530707826696d616765733d686f6d65267769647468733d35303026686569676874733d353030

Latest Version on Packagist Total Downloads run-tests PHPStan

This package was developed to give you a quick start to creating tickets via the Filament Json Field API.

💡 What is Filament Json Field?

Filament Json Field is a Filament wrapper for Codemirror.

🛠 Requirements

Package PHP Laravel Filament Infolists Filament Support Filament Tables
v1.0 ^8.1 ^10.45, ^11.0 ^3.2 ^3.2 ^3.2

⚙️ 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\Forms\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:

Request Supported
Line Numbers
Auto Close Brackets
Dark Theme
Folding Code

🚧 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.