Filament Pretty JSON

https://github.com/novadaemon/filament-pretty-json
Admin
A Filament package that provides a read-only field to display pretty-formatted JSON within...
Tokens:34,874
Snippets:439
Trust Score:8.3
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Filament Pretty JSON

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/README.md

Install the package using Composer. This command fetches and installs the latest version of the filament-pretty-json package.

```bash
composer require novadaemon/filament-pretty-json
```

--------------------------------

### PrettyJsonField Setup Method

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonfield.md

The setUp() method configures the field during initialization, setting it to be read-only and not submitted with the form by default. It also registers a callback for state hydration.

```php
protected function setUp(): void
```

```php
// Automatically called when you do:
PrettyJsonField::make('data')
// Field is now read-only and will not be submitted
```

--------------------------------

### PrettyJsonEntry Usage Example

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/API-REFERENCE.md

Example of how to use the PrettyJsonEntry component within a Filament infolist schema. It demonstrates basic usage and how to enable copyable functionality with custom messages and durations.

```php
use Novadaemon\FilamentPrettyJson\Infolist\PrettyJsonEntry;
use Filament\Infolists\Infolist;

public static function infolist(Infolist $infolist):
 Infolist
{
    return $infolist
        ->schema([
            PrettyJsonEntry::make('api_response'),
            PrettyJsonEntry::make('payment_details')
                ->copyable()
                ->copyMessage('Payment details copied to clipboard')
                ->copyMessageDuration(2000),
        ]);
}
```

--------------------------------

### getStateUsing() Method Example

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

Provides an example of customizing state retrieval using a closure, allowing for dynamic data fetching based on the record.

```php
PrettyJsonEntry::make('computed_json')
    ->getStateUsing(function ($record) {
        return [
            'id' => $record->id,
            'name' => $record->name,
            'created_at' => $record->created_at->toIso8601String(),
        ];
    })
```

--------------------------------

### Check Filament Assets Installation

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/service-provider.md

Ensure that Filament's core assets have been properly installed. Running this command can help resolve issues related to missing or improperly configured frontend assets.

```bash
php artisan filament:install
```

--------------------------------

### Basic PrettyJsonField Configuration

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/configuration.md

Example demonstrating common configuration methods for PrettyJsonField, including copyability, custom messages, and styling attributes.

```php
PrettyJsonField::make('field_name')
    ->copyable()
    ->copyMessage('Copied!')
    ->copyMessageDuration(2000)
    ->extraAttributes(['style' => 'max-height: 500px;'])
    ->label('API Response')
    ->helperText('Raw JSON response from API');
```

--------------------------------

### StateType Examples

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/types.md

Demonstrates the various types accepted by StateType, including string, array, StdClass, Jsonable, and null.

```php
// State can be any of these types
$field->state($jsonString);           // string
$field->state(['key' => 'value']);    // array
$field->state((object)[]);            // StdClass
$field->state($customJsonable);       // Jsonable
$field->state(null);                  // null
```

--------------------------------

### visible() Method Example

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

Shows how to control the visibility of the Pretty JSON Entry based on user roles or application environment.

```php
PrettyJsonEntry::make('debug_info')
    ->visible(auth()->user()->isAdmin())
```

```php
// Dynamic visibility
->visible(fn() => app()->isLocal())
```

--------------------------------

### PrettyJsonField Usage Example

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/API-REFERENCE.md

Demonstrates how to use PrettyJsonField in a Filament form schema. It shows basic field creation and an example with the copyable trait enabled.

```php
use Novadaemon\FilamentPrettyJson\Form\PrettyJsonField;
use Filament\Forms\Form;

public static function form(Form $form): Form
{
    return $form
        ->schema([
            PrettyJsonField::make('api_response'),
            PrettyJsonField::make('config_data')
                ->copyable()
                ->copyMessage('Configuration copied!'),
        ]);
}
```

--------------------------------

### label() Method Example

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

Illustrates how to override the default label for the Pretty JSON Entry, including dynamic label generation.

```php
PrettyJsonEntry::make('api_response')
    ->label('API Response Data')
```

```php
// Dynamic label
->label(fn() => __('fields.api_response'))
```

--------------------------------

### getState() Example Usage

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

Demonstrates how the getState() method is used with a model attribute containing an array, and shows the resulting JSON string output.

```php
// Model attribute
$entry->data = ['status' => 'active', 'count' => 42];

// In infolist
$state = $entry->getState(); // Returns '{"status":"active","count":42}'

// Rendered in view
// <pre class="prettyjson">{"status":"active","count":42}</pre>
```

--------------------------------

### hidden() Method Example

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

Demonstrates how to hide the Pretty JSON Entry based on specific user permissions.

```php
PrettyJsonEntry::make('internal_data')
    ->hidden(fn() => !auth()->user()->can('debug'))
```

--------------------------------

### Usage Example for PrettyJsonField and PrettyJsonEntry

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/service-provider.md

Demonstrates how to use PrettyJsonField and PrettyJsonEntry components within Filament forms or inlists, utilizing the package's views.

```php
// In a form/infolist, these views are available
PrettyJsonField::make('data'); // Uses filament-pretty-json::form.json
PrettyJsonEntry::make('data'); // Uses filament-pretty-json::infolist.json
```

--------------------------------

### Infolist Configuration

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/configuration.md

Configure PrettyJsonEntry for displaying JSON data in Filament infolists. This example shows how to set labels, enable copying, and control visibility based on the environment.

```php
use Novadaemonilamen tPrettyJson
Infolist
ettyJsonEntry;
use Filament
Infolists
Infolist;

public static function infolist(Infolist $infolist):
Infolist
{
    return $infolist
        ->schema([
            PrettyJsonEntry::make('webhook_payload')
                ->label('Webhook Payload')
                ->copyable()
                ->copyMessage('Webhook payload copied!')
                ->copyMessageDuration(2500),
                
            PrettyJsonEntry::make('database_backup')
                ->label('Backup Metadata')
                ->visible(fn() => app()->isLocal())
                ->extraAttributes(['style' => 'font-size: 11px;']),
        ]);
}
```

--------------------------------

### PrettyJsonEntry with Copy Functionality

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/README.md

This example demonstrates adding a copy-to-clipboard button to a JSON entry in a Filament infolist. It simplifies data handling for users viewing the infolist.

```php
PrettyJsonEntry::make('webhook_payload')->copyable()
```

--------------------------------

### Infolist Schema with PrettyJsonEntry

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/INDEX.md

Define an infolist schema that includes a PrettyJsonEntry for displaying webhook data. This example shows how to enable the copyable feature.

```php
public static function infolist(Infolist $infolist): Infolist
{
    return $infolist->schema([
        PrettyJsonEntry::make('webhook_payload')
            ->label('Webhook Data')
            ->copyable(),
    ]);
}
```

--------------------------------

### Full Form Configuration

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/configuration.md

This example demonstrates advanced options for the PrettyJsonField, including labels, helper text, visibility control, copy functionality, and custom attributes for styling. Ensure the user has the 'view_debug' capability to see the field.

```php
use Novadaemonilamen tPrettyJson
Form
ettyJsonField;
use Filamentormsorm;

public static function form(Form $form):
Form
{
    return $form
        ->schema([
            PrettyJsonField::make('api_response')
                ->label('API Response')
                ->helperText('Raw response from the third-party API')
                ->hint('read-only')
                ->visible(fn() => auth()->user()->can('view_debug'))
                ->copyable()
                ->copyMessage('API response copied to clipboard!')
                ->copyMessageDuration(3000)
                ->extraAttributes([
                    'style' => 'font-size: 13px; max-height: 500px; overflow-y: auto;',
                    'class' => 'bg-slate-50 dark:bg-slate-900',
                ]),
        ]);
}
```

--------------------------------

### Filament Dependencies

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/service-provider.md

Imports required for Filament asset management. Ensure you have compatible versions of filament/filament and filament/forms installed.

```php
use Filament\Support\Assets\Js;
use Filament\Support\Assets\Css;
use Filament\Support\Facades\FilamentAsset;
```

--------------------------------

### Example Jsonable Implementation: PaymentInfo

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/types.md

Demonstrates how to implement the `Jsonable` interface for a custom class. The `toJson()` method provides a JSON string representation of the object's data.

```php
<?php

use Illuminate\Contracts\Support\Jsonable;

class PaymentInfo implements Jsonable
{
    public function __construct(
        public string $method,
        public float $amount,
        public string $currency,
    ) {}

    public function toJson($options = 0): string
    {
        return json_encode([
            'method' => $this->method,
            'amount' => $this->amount,
            'currency' => $this->currency,
        ], $options);
    }
}

// Usage in model
class Invoice extends Model
{
    protected $casts = [
        'payment_info' => PaymentInfo::class,
    ];
}

// In form
PrettyJsonField::make('payment_info'); // Automatically calls toJson()
```

--------------------------------

### Example Model with stdClass Cast

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/types.md

Shows how to cast a model attribute to a generic object type (`stdClass`) which can be accepted by PrettyJsonField and PrettyJsonEntry.

```php
<?php

// Model with stdClass cast
class Configuration extends Model
{
    protected $casts = [
        'settings' => 'object', // Cast to stdClass
    ];
}

// In form
$config = Configuration::first();
$config->settings; // stdClass { email: "...", theme: "dark" }

PrettyJsonField::make('settings'); // Automatically JSON-encodes the stdClass
```

--------------------------------

### Manual Service Provider Registration

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/service-provider.md

If auto-discovery is disabled, manually register the service provider in `config/app.php`. This ensures the provider is loaded when the application starts.

```php
'providers' => [
    // ...
    Novadaemon\FilamentPrettyJson\FilamentPrettyJsonServiceProvider::class,
]
```

--------------------------------

### Get Asset Package Name

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/API-REFERENCE.md

The `getAssetPackageName()` method returns the package name used for asset registration, which is 'novadaemon/filament-pretty-json'.

```php
protected function getAssetPackageName(): ?string
{
    return 'novadaemon/filament-pretty-json';
}
```

--------------------------------

### Example Model with Array Cast

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/types.md

Illustrates casting a model attribute to an array type, which is automatically handled for JSON serialization by the PrettyJson components.

```php
<?php

// Model with array cast
class WebhookPayload extends Model
{
    protected $casts = [
        'data' => 'array',
    ];
}

// In form
$webhook = WebhookPayload::first();
$webhook->data; // ['event' => 'user.created', 'user_id' => 123]

PrettyJsonField::make('data'); // Automatically JSON-encodes the array
```

--------------------------------

### Example Model with Nullable JSON Field

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/types.md

Shows a model with a nullable JSON field, demonstrating how `null` values are handled and displayed as the JSON literal `null` by the PrettyJson components.

```php
<?php

class Report extends Model
{
    protected $casts = [
        'metadata' => 'json', // Can be null
    ];
}

// In form
$report = Report::create(['metadata' => null]);

PrettyJsonField::make('metadata'); // Displays as JSON null
```

--------------------------------

### Minimal Form Configuration

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/configuration.md

Use this basic setup to quickly add a JSON field to your Filament form. It requires the PrettyJsonField class and a name for the field.

```php
use Novadaemonilamen tPrettyJson
Form
ettyJsonField;
use Filamentormsorm;

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

--------------------------------

### Implement Custom JSON Pretty Printer

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/configuration.md

Replace the default JSON pretty printing function with a custom implementation. This example shows how to create a basic formatter using JSON.stringify and HTML entity escaping.

```javascript
// In your application JavaScript
window.prettyPrint = function(json) {
    // Custom implementation
    return JSON.stringify(json, null, 2)
        .replace(/&/g, '&amp;')
        .replace(/
```

```javascript
/g, '&quot;')
        .replace(/</g, '&lt;')
        .replace(/>/g, '&gt;');
};
```

--------------------------------

### Get Asset Package Name

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/service-provider.md

Returns the package name used for registering assets with Filament. This is called by `packageBooted()` to identify the asset package in Filament's registry.

```php
protected function getAssetPackageName(): ?string
```

--------------------------------

### PHP: Mitigating invalid JSON by encoding

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/errors.md

This example shows the correct way to ensure the state is valid JSON before passing it to the PrettyJsonField by using `json_encode`.

```php
$model->json_field = json_encode(['error' => 'invalid']);
```

--------------------------------

### Basic PrettyJsonField Integration

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonfield.md

Integrate the PrettyJsonField into a Filament resource form to display JSON data. This example shows how to add the field for 'request_body' and 'response_body'.

```php
use NovadaemonFilamentPrettyJsonFormPrettyJsonField;
use FilamentResourcesResource;
use FilamentFormsForm;

class ApiLogResource extends Resource
{
    public static function form(Form $form): Form
    {
        return $form
            ->schema([
                TextInput::make('endpoint')
                    ->required(),
                    
                PrettyJsonField::make('request_body'),
                PrettyJsonField::make('response_body'),
            ]);
    }
}
```

--------------------------------

### Get Assets for Registration

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/service-provider.md

Returns an array of CSS and JavaScript assets to be registered with Filament. This method declares all assets that should be registered, including styling and formatting scripts.

```php
protected function getAssets(): array
```

```php
[ 
    Css::make('styles', __DIR__ . '/../resources/css/app.css'),
    Js::make('scripts', __DIR__ . '/../resources/js/app.js'),
]
```

--------------------------------

### PrettyJsonField with Copy Functionality

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/README.md

This example shows how to add a copy-to-clipboard button to a JSON field in a Filament form. This is useful for easily sharing or saving JSON data.

```php
PrettyJsonField::make('api_response')->copyable()
```

--------------------------------

### Adding Extra HTML Attributes

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/configuration.md

Example of applying custom HTML attributes like style, class, and data attributes to the JSON rendering element.

```php
PrettyJsonField::make('response')
    ->extraAttributes([
        'style' => 'max-height: 400px; overflow-y: auto;',
        'class' => 'custom-json-styling',
        'data-testid' => 'api-response-json',
    ])
```

--------------------------------

### Example Model with JSON String Cast

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/types.md

Demonstrates casting a model attribute to a string type, where the string is expected to be a valid JSON-formatted string. This string is passed directly to the frontend renderer.

```php
<?php

// Model with string cast
class ApiResponse extends Model
{
    protected $casts = [
        'body' => 'string',
    ];
}

// In form
$response = ApiResponse::first();
$response->body; // '{"status":"success","data":{"id":1}}'

PrettyJsonField::make('body'); // Passed directly to frontend
```

--------------------------------

### Form Schema with PrettyJsonField

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/INDEX.md

Define a form schema that includes a PrettyJsonField for displaying API responses. This example demonstrates enabling the copy feature with custom messages.

```php
public static function form(Form $form): Form
{
    return $form->schema([
        PrettyJsonField::make('api_response')
            ->label('API Response')
            ->copyable()
            ->copyMessage('Response copied!')
            ->copyMessageDuration(2000),
    ]);
}
```

--------------------------------

### Override Asset Registration in Service Provider

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/service-provider.md

Extend the FilamentPrettyJsonServiceProvider to override asset registration. This example shows how to include a custom CSS file and retain the default JavaScript file.

```php
<?php

namespace App\Providers;

use Novadaemon\FilamentPrettyJson\FilamentPrettyJsonServiceProvider;
use Filament\Support\Assets\Css;
use Filament\Support\Assets\Js;

class CustomPrettyJsonServiceProvider extends FilamentPrettyJsonServiceProvider
{
    protected function getAssets(): array
    {
        return [
            // Use custom CSS file
            Css::make('styles', public_path('css/custom-json.css')),
            // Keep the default JS
            Js::make('scripts', __DIR__ . '/../../../vendor/novadaemon/filament-pretty-json/resources/js/app.js'),
        ];
    }
}
```

--------------------------------

### Get Copyable State Logic

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/copyable.md

The `getCopyableState()` method returns the state to be copied, returning `null` if the state is the literal string 'null' or '[]'. This prevents copying empty or null representations.

```php
public function getCopyableState(): ?string
{
    $state = $this->getState();
    return $state == 'null' ? null : $state;
}
```

```php
use Novadaemon\FilamentPrettyJson\Form\PrettyJsonField;

$field = PrettyJsonField::make('data');

// State: valid JSON string
$field->state('{"key":"value"}');
$copyable = $field->getCopyableState(); // '{"key":"value"}'

// State: the literal string 'null'
$field->state('null');
$copyable = $field->getCopyableState(); // null (nothing copied)

// State: the literal string '[]'
$field->state('[]');
$copyable = $field->getCopyableState(); // null (nothing copied)
```

--------------------------------

### Get Copyable State from PrettyJsonField

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/API-REFERENCE.md

Retrieve the state formatted for clipboard copying using `getCopyableState()`. This method returns null if the state is the string 'null', otherwise it returns the state as is.

```php
$copyableText = $field->getCopyableState();
// Returns null if state is 'null', otherwise returns the JSON string
```

--------------------------------

### Automatic Service Provider Registration

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/service-provider.md

The service provider is automatically registered via Laravel's package auto-discovery. This configuration in composer.json ensures the provider is loaded automatically after Composer install.

```json
{
    "extra": {
        "laravel": {
            "providers": [
                "Novadaemon\FilamentPrettyJson\FilamentPrettyJsonServiceProvider"
            ]
        }
    }
}
```

--------------------------------

### Creating PrettyJsonField and PrettyJsonEntry Instances

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/configuration.md

Shows how to instantiate PrettyJsonField and PrettyJsonEntry, binding them to specific database columns or model attributes.

```php
PrettyJsonField::make('api_response')
PrettyJsonEntry::make('webhook_data')
```

--------------------------------

### PrettyJsonField with Conditional Display

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonfield.md

Control the visibility of the PrettyJsonField based on other form fields. This example shows how to display the field only when 'show_response' is true.

```php
PrettyJsonField::make('api_response')
    ->visible(fn(Get $get) => $get('show_response'))
    ->copyable()
    ->copyMessage('Response copied to clipboard')
```

--------------------------------

### Package Booted Method - Asset Registration

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/service-provider.md

Registers CSS and JavaScript assets with Filament's asset pipeline after the package has booted. These assets are automatically loaded on Filament pages.

```php
FilamentAsset::register([
    Css::make('styles', __DIR__ . '/../resources/css/app.css'),
    Js::make('scripts', __DIR__ . '/../resources/js/app.js'),
],
'novadaemon/filament-pretty-json'
);
```

--------------------------------

### Use Third-Party Library for Pretty Printing

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/configuration.md

Integrate a third-party library, such as highlight.js, to format and highlight JSON output. This requires including the library and its CSS.

```javascript
// Example with highlight.js
window.prettyPrint = function(json) {
    return hljs.highlight(JSON.stringify(json, null, 2), {
        language: 'json',
        ignoreIllegals: true
    }).value;
};
```

--------------------------------

### Get Copyable State

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonfield.md

Retrieve the state value that will be copied to the clipboard using `getCopyableState()`. Returns null if the state is the string 'null'.

```php
$field = PrettyJsonField::make('data');
$field->state('{"key":"value"}');

$copyable = $field->getCopyableState(); // '{"key":"value"}'

$field->state('null');
$copyable = $field->getCopyableState(); // null
```

--------------------------------

### Publish Filament Pretty JSON Views

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/README.md

Publish the package's views to your application. This allows for global customization of the package's appearance.

```bash
php artisan vendor:publish --tag="filament-pretty-json-views"
```

--------------------------------

### Conditionally Visible JSON Field

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/INDEX.md

Control the visibility of a PrettyJsonField based on the application environment. This example makes the field visible only in local development.

```php
PrettyJsonField::make('debug')
    ->visible(fn() => app()->isLocal())
    ->copyable()
```

--------------------------------

### Project File Structure

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/MANIFEST.md

Overview of the directory and file organization for the Filament Pretty JSON project.

```text
/workspace/home/output/
├── README.md                              (User guide and introduction)
├── INDEX.md                               (Navigation and quick reference)
├── API-REFERENCE.md                       (Unified API documentation)
├── configuration.md                       (Configuration guide)
├── types.md                               (Type system reference)
├── errors.md                              (Error handling guide)
├── MANIFEST.md                            (This file)
└── api-reference/                         (Class-specific documentation)
    ├── prettyjsonfield.md                 (Form field class)
    ├── prettyjsonentry.md                 (Infolist entry class)
    ├── copyable.md                        (Copy trait)
    └── service-provider.md                (Service provider)
```

--------------------------------

### Bash: Publishing Filament Pretty JSON configuration

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/errors.md

If the frontend JavaScript asset fails to load, resulting in a 'window.prettyPrint is not defined' error, ensure the `FilamentPrettyJsonServiceProvider` is loaded. This command helps publish configuration files which can aid in verifying service provider registration.

```bash
php artisan vendor:publish --tag="config" # Check service providers
```

--------------------------------

### Basic PrettyJsonEntry Usage in Filament Resource

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

Demonstrates how to integrate PrettyJsonEntry into a Filament resource's infolist schema to display JSON fields like request and response bodies.

```php
use Novadaemon\FilamentPrettyJson\Infolist\PrettyJsonEntry;
use Filament\Resources\Resource;
use Filament\Infolists\Infolist;

class ApiLogResource extends Resource
{
    public static function infolist(Infolist $infolist): Infolist
    {
        return $infolist
            ->schema([
                TextEntry::make('endpoint'),
                PrettyJsonEntry::make('request_body'),
                PrettyJsonEntry::make('response_body'),
            ]);
    }
}
```

--------------------------------

### Enable Copy Functionality

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/INDEX.md

Make the JSON content copyable with a button. Customize the confirmation message and its duration.

```php
->copyable(bool = true)
->copyMessage(string|Closure)
->copyMessageDuration(int|Closure)
```

--------------------------------

### PrettyJsonEntry with Advanced Styling and Conditional Visibility

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

Illustrates advanced customization of PrettyJsonEntry, including applying custom CSS styles for better presentation (e.g., max-height, font-size) and conditionally displaying the entry only in local development environments.

```php
PrettyJsonEntry::make('debug_info')
    ->label('Debug Information')
    ->visible(fn() => app()->isLocal())
    ->copyable()
    ->extraAttributes([
        'style' => 'max-height: 500px; overflow-y: auto; font-size: 11px;',
        'class' => 'font-mono',
    ])
```

--------------------------------

### PrettyJsonEntry with Copy Feature Enabled

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

Shows how to enable the copyable feature for PrettyJsonEntry, allowing users to easily copy the JSON content. Includes customization for the copy message and its duration.

```php
PrettyJsonEntry::make('webhook_payload')
    ->label('Webhook Payload')
    ->copyable()
    ->copyMessage('Webhook payload copied!')
    ->copyMessageDuration(2500)
```

--------------------------------

### Configure Package Name in Service Provider

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/API-REFERENCE.md

The `configurePackage()` method in `FilamentPrettyJsonServiceProvider` sets the package name to 'filament-pretty-json' and handles view publishing.

```php
// Internally called during package registration
// Configures:
// - Package name as 'filament-pretty-json'
// - Views publishable with tag 'filament-pretty-json-views'
```

--------------------------------

### PHP: Attempting to set 'required' on PrettyJsonField

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/errors.md

PrettyJsonField is read-only and cannot be required. This example shows that calling `->required()` has no effect. For validation, implement it in the model or form submission.

```php
// This has no effect on PrettyJsonField
PrettyJsonField::make('data')->required();

// If you need validation, validate in the model or form submission
```

--------------------------------

### PrettyJsonEntry in Resource Infolists

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

Demonstrates how to use PrettyJsonEntry to display JSON data within a Filament resource's infolist. Ensure the field contains JSON-serializable data.

```php
class OrderResource extends Resource
{
    public static function infolist(Infolist $infolist): Infolist
    {
        return $infolist
            ->schema([
                TextEntry::make('order_id'),
                
                PrettyJsonEntry::make('shipping_address')
                    ->label('Shipping Address'),
                PrettyJsonEntry::make('billing_address')
                    ->label('Billing Address'),
                PrettyJsonEntry::make('order_items')
                    ->label('Items'),
            ]);
    }
}
```

--------------------------------

### Create PrettyJsonEntry Instance

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

Use the `make` factory method to create a new PrettyJsonEntry instance, binding it to a specific model attribute or database column. This is useful for displaying JSON data stored in your database.

```php
use Novadaemon\FilamentPrettyJson\Infolist\PrettyJsonEntry;

PrettyJsonEntry::make('api_response')
PrettyJsonEntry::make('webhook_payload')
PrettyJsonEntry::make('config_data')
```

--------------------------------

### PrettyJsonEntry::make()

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

Creates a new PrettyJsonEntry instance. This component is used to display JSON data with syntax highlighting in Filament resource infolists.

```APIDOC
## PrettyJsonEntry::make()

### Description
Creates a new PrettyJsonEntry instance bound to a model attribute. This component displays JSON data with syntax highlighting.

### Method
`static make(string $fieldName): self`

### Parameters
#### Path Parameters
- **fieldName** (string) - Required - The database column or model attribute name

### Request Example
```php
use Novadaemon\FilamentPrettyJson\Infolist\PrettyJsonEntry;

PrettyJsonEntry::make('api_response');
PrettyJsonEntry::make('webhook_payload');
PrettyJsonEntry::make('config_data');
```

### Response
#### Success Response
- **self** - The entry instance for method chaining.
```

--------------------------------

### Get Copyable State Value

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

Retrieve the state value that will be copied to the clipboard using `getCopyableState()`. It returns null if the state is the string 'null', otherwise returns the state as is.

```php
$entry = PrettyJsonEntry::make('data');
$entry->record(['data' => '{"key":"value"}']);

$copyable = $entry->getCopyableState(); // '{"key":"value"}'
```

--------------------------------

### PrettyJsonEntry with Computed State

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

Demonstrates how to use PrettyJsonEntry with a computed state, where the JSON data is generated dynamically using a closure based on the record's data. This is useful for displaying derived or aggregated information.

```php
PrettyJsonEntry::make('computed_metadata')
    ->label('Metadata')
    ->getStateUsing(function ($record) {
        return [
            'id' => $record->id,
            'name' => $record->name,
            'email' => $record->email,
            'created' => $record->created_at->toIso8601String(),
        ];
    })
    ->copyable()
```

--------------------------------

### Basic PrettyJsonEntry in Filament Infolist

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/README.md

Use this snippet to display JSON data as an entry in a Filament infolist. It provides a structured view of JSON content.

```php
PrettyJsonEntry::make('json')
```

--------------------------------

### Conditionally Hide Pretty JSON Field

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/configuration.md

Use the hidden method to conditionally hide the field. This is the inverse of the visible method. The example hides the field unless the user is an administrator.

```php
PrettyJsonField::make('internal_state')
    ->hidden(fn() => !auth()->user()->is_admin)
```

--------------------------------

### hint()

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonfield.md

Display hint text to the right of the label, offering concise information.

```APIDOC
## hint()

### Description
Display hint text to the right of the label.

### Method
`hint(string|Htmlable|Closure|null $hint): self`

### Example
```php
PrettyJsonField::make('payload')
    ->hint('read-only')
```
```

--------------------------------

### FilamentPrettyJsonServiceProvider Methods

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/API-REFERENCE.md

The service provider class responsible for bootstrapping the filament-pretty-json package, registering assets, and configuring package settings.

```APIDOC
## configurePackage()

### Description
Configures the package name and publishes views.

### Method
`configurePackage(Package $package): void`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **package** (`Spatie\LaravelPackageTools\Package`) - The package configuration instance.

### Return
void

### Called By
Laravel service provider lifecycle

### Example
```php
// Internally called during package registration
// Configures:
// - Package name as 'filament-pretty-json'
// - Views publishable with tag 'filament-pretty-json-views'
```
```

```APIDOC
## packageBooted()

### Description
Called after the package is booted. Registers CSS and JavaScript assets with Filament's asset pipeline.

### Method
`packageBooted(): void`

### Parameters
None

### Return
void

### Called By
Laravel service provider lifecycle

### Assets Registered

| Type | Path | Purpose |
|------|------|---------|
| CSS | `resources/css/app.css` | Styling for JSON display containers and copy button |
| JavaScript | `resources/js/app.js` | JSON pretty-printing and syntax highlighting logic |
```

```APIDOC
## getAssetPackageName()

### Description
Returns the package name used for asset registration.

### Method
`getAssetPackageName(): ?string`

### Parameters
None

### Return
`'novadaemon/filament-pretty-json'`
```

```APIDOC
## getAssets()

### Description
Returns an array of CSS and JavaScript assets to be registered.

### Method
`getAssets(): array<Filament
Support
Assets
Asset>`

### Parameters
None

### Return Type
`array<Filament
Support
Assets
Asset>`

### Returns
```php
[
    Css::make('styles', __DIR__ . '/../resources/css/app.css'),
    Js::make('scripts', __DIR__ . '/../resources/js/app.js'),
]
```
```

--------------------------------

### helperText()

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonfield.md

Display helper text below the field to provide additional guidance to the user.

```APIDOC
## helperText()

### Description
Display helper text below the field.

### Method
`helperText(string|Htmlable|Closure|null $text): self`

### Example
```php
PrettyJsonField::make('response')
    ->helperText('Raw response from the API endpoint')
```
```

--------------------------------

### Verify View Registration

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/service-provider.md

Use the Artisan Tinker command to check if the package's views are registered correctly. This command attempts to retrieve the 'filament-pretty-json::form.json' view.

```bash
php artisan tinker
>>> view('filament-pretty-json::form.json')
```

--------------------------------

### Clear Application Caches

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/service-provider.md

Clear various Laravel caches, including configuration, route, view, and application caches. This is a common step to resolve issues after configuration changes or package installations.

```bash
php artisan optimize:clear
```

--------------------------------

### PrettyJsonEntry with Model Casts

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

Shows how to use PrettyJsonEntry when model attributes are cast to JSON type. The entries will display correctly without explicit casting in the infolist schema.

```php
class Order extends Model
{
    protected $casts = [
        'shipping_address' => 'json',
        'billing_address' => 'json',
        'order_items' => 'json',
    ];
}

// In infolist - all entries display correctly
PrettyJsonEntry::make('shipping_address');
PrettyJsonEntry::make('billing_address');
PrettyJsonEntry::make('order_items');
```

--------------------------------

### Configure Package Method

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/service-provider.md

Configures the package by setting its name and declaring its views. This method is called during the Laravel service provider registration phase.

```php
public function configurePackage(Package $package): void
{
    $package->name(static::$name)
        ->hasViews(static::$name);
}
```

--------------------------------

### State Hydration Input Transformations

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonfield.md

Illustrates how different input states are transformed into JSON strings or the 'null' literal by the afterStateHydrated callback.

```text
// Input state transformations
[
    'key' => 'value',
]
→ '{"key":"value"}'

(object)['id' => 1]
→ '{"id":1}'

null
→ 'null'

'[]'
→ 'null'

'{"already":"json"}'
→ '{"already":"json"}'
```

--------------------------------

### Eloquent Model Casting with JSON Data

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/types.md

Demonstrates how to cast various JSON-like attributes to appropriate types within an Eloquent model using $casts. This setup ensures compatibility with PrettyJsonField for display.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Contracts\Support\Jsonable;

class ApiRequest extends Model
{
    protected $casts = [
        // All of these work with PrettyJsonField/PrettyJsonEntry:
        'string_json' => 'string',
        'json_data' => 'json',
        'array_data' => 'array',
        'object_data' => 'object',
        'custom_data' => CustomCast::class,
    ];
}

// Usage
$request = ApiRequest::create([
    'string_json' => '{"type":"request"}',
    'json_data' => ['status' => 'pending'],
    'array_data' => ['items' => [1, 2, 3]],
    'object_data' => json_decode('{"mode":"sync"}'),
]);

// In form/infolist - all display correctly
PrettyJsonField::make('string_json');
PrettyJsonField::make('json_data');
PrettyJsonField::make('array_data');
PrettyJsonField::make('object_data');

```

--------------------------------

### Conditional Copyable Button

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/configuration.md

Demonstrates how to conditionally enable the clipboard copy button based on user roles or other logic.

```php
PrettyJsonField::make('config')
    ->copyable(auth()->user()->is_admin) // Conditionally copyable
```

--------------------------------

### Custom Cast Class for JSON Handling

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/types.md

Implement a custom cast class like JsonArrayCast to define specific logic for getting and setting JSON data. This allows for custom encoding/decoding behavior.

```php
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;

class JsonArrayCast implements CastsAttributes
{
    public function get($model, $key, $value, $attributes)
    {
        return json_decode($value, true);
    }

    public function set($model, $key, $value, $attributes)
    {
        return json_encode($value);
    }
}

protected $casts = [
    'json_data' => JsonArrayCast::class,
];
```

--------------------------------

### Enable Copy to Clipboard for JSON Data

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/README.md

Make the JSON content copyable to the clipboard. You can customize the success message and its display duration.

```php
PrettyJsonEntry::make('card_info')
    ->copyable()
    ->copyMessage('Your JSON is copied to the clipboard')
    ->copyMessageDuration(1500)
```

--------------------------------

### PHP: Setting invalid JSON in model for PrettyJsonField

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/errors.md

This example demonstrates how an invalid JSON string assigned to a model's field can cause frontend parsing errors. Ensure the state is valid JSON before passing it to the field.

```php
// In model
$model->json_field = 'not json'; // Invalid

// In form - Alpine fails to parse
PrettyJsonField::make('json_field');
```

--------------------------------

### Add PrettyJsonEntry to Filament Infolist

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/README.md

Use the PrettyJsonEntry class to display formatted JSON data in Filament infolists. This is ideal for read-only views of JSON content.

```php
use Novadaemon\FilamentPrettyJson\Infolist\PrettyJsonEntry;

class InfoResource extends Resource
{
    public static function infolist(Infolist $infolist): Form
    {
        return $infolist
            ->schema([
                PrettyJsonEntry::make('json')
            ]);
    }
}
```

--------------------------------

### Custom PrettyJsonEntry for API Responses

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

Illustrates extending PrettyJsonEntry to create a custom component, ApiResponseEntry, for displaying API responses with additional features like copying and custom styling.

```php
<?php

namespace App\Infolists\Components;

use Novadaemon\FilamentPrettyJson\Infolist\PrettyJsonEntry;

class ApiResponseEntry extends PrettyJsonEntry
{
    public static function make(string $fieldName): self
    {
        return parent::make($fieldName)
            ->copyable()
            ->copyMessage('API response copied!')
            ->copyMessageDuration(3000)
            ->extraAttributes([
                'style' => 'font-family: "Fira Code", monospace;',
            ]);
    }
}

// Usage
ApiResponseEntry::make('response_body')
    ->label('API Response')
```

--------------------------------

### Verify Asset Registration in Console

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/service-provider.md

Check if the prettyPrint JavaScript function is available globally in the browser console. This confirms that the package's JavaScript assets have been loaded correctly.

```javascript
typeof window.prettyPrint // Should be "function"
```

--------------------------------

### Customizing Copy Message

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/configuration.md

Illustrates setting a custom tooltip message for the copy button, including dynamic and HTMLable options.

```php
PrettyJsonField::make('data')
    ->copyable()
    ->copyMessage('JSON copied!')

// Dynamic message
->copyMessage(fn() => __('messages.json_copied'))

// Using Htmlable (for styling)
->copyMessage(new HtmlString('<strong>Success!</strong>'))
```

--------------------------------

### Add Hint Text

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/INDEX.md

Provide concise hint text for the JSON field using the `hint` method.

```php
->hint(string)
```

--------------------------------

### getState() Method Signature

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

The core method for retrieving and transforming the entry's state from the model attribute. It handles various input types and returns a JSON string or null.

```php
public function getState(): mixed
```

--------------------------------

### PrettyJsonEntry Constructor

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/API-REFERENCE.md

The PrettyJsonEntry component uses the standard Filament entry factory pattern. The 'fieldName' parameter is the database column name or attribute key to retrieve data from.

```php
PrettyJsonEntry::make(string $fieldName): self
```

--------------------------------

### Package Name Constant

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/service-provider.md

Defines the internal name of the package, used for asset organization, view namespaces, and configuration publishing.

```php
public static string $name = 'filament-pretty-json'
```

--------------------------------

### Alpine.js Integration for JSON Rendering

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonentry.md

This JavaScript snippet demonstrates how the view integrates with Alpine.js to parse and render JSON data. It uses a getter to dynamically format the JSON string into a pretty-printed HTML output using `window.prettyPrint()`.

```javascript
x-data="{
    state: @js($getState()),
    get prettyJson() {
        json = JSON.parse(this.state != undefined ? this.state : '{}')
        return window.prettyPrint(json)
    }
}"
```

--------------------------------

### copyMessage()

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/copyable.md

Sets the tooltip message displayed when the user clicks the copy button. A default message is provided if not explicitly set.

```APIDOC
## copyMessage()

### Description
Sets the tooltip message displayed when the user clicks the copy button.

### Method
`copyMessage(string|Htmlable|Closure|null $message): self`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **message** (string|Htmlable|Closure|null) - Required - The message text shown in the copy confirmation tooltip.

### Request Example
```php
// Static message
PrettyJsonField::make('config')
    ->copyable()
    ->copyMessage('Configuration JSON copied!')

// Closure (dynamic)
PrettyJsonField::make('data')
    ->copyable()
    ->copyMessage(fn() => __('messages.json_copied'))

// With Htmlable (for styling)
use Illuminate\Support\HtmlString;

PrettyJsonField::make('api_response')
    ->copyable()
    ->copyMessage(new HtmlString('<strong>Success!</strong> Copied to clipboard'))

// Conditional message
->copyMessage(fn() => 
    auth()->user()->is_admin 
        ? 'Admin: JSON copied' 
        : 'JSON copied'
)
```

### Response
#### Success Response (200)
`self` - The component instance for method chaining.

#### Response Example
None provided.

### Default Message
`'Copied to clipboard'`
```

--------------------------------

### Add Helper Text to Pretty JSON Field

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/configuration.md

Use the helperText method to display guidance below the field. This is useful for providing context or instructions to the user.

```php
PrettyJsonField::make('config')
    ->helperText('Configuration in JSON format, read-only')
```

--------------------------------

### Create PrettyJsonField Instance

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonfield.md

Use the `make` static method to create a new PrettyJsonField instance. This method binds the field to a specific model attribute or form field name.

```php
use Novadaemon\FilamentPrettyJson\Form\PrettyJsonField;

PrettyJsonField::make('api_response')
PrettyJsonField::make('webhook_payload')
PrettyJsonField::make('config_data')
```

--------------------------------

### Check Service Provider Registration

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/service-provider.md

Verify that the service provider for Filament Pretty JSON is correctly registered in your Laravel application's configuration. This command lists configuration values and filters for the provider.

```bash
php artisan config:list | grep provider
```

--------------------------------

### PHP Class Name Type Notation

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/README.md

Represents a full PHP class name.

```php
ClassName
```

--------------------------------

### PrettyJsonEntry with Custom State Retrieval

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/README.md

Configure a PrettyJsonEntry to dynamically retrieve its JSON state using a closure. This is useful for computed or complex data structures within an infolist.

```php
PrettyJsonEntry::make('computed_data')->getStateUsing(...)
```

--------------------------------

### make() - Factory Method

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonfield.md

Creates a new PrettyJsonField instance. This is a factory method used to instantiate the field and bind it to a specific model attribute or form field name.

```APIDOC
## make()

### Description
Creates a new PrettyJsonField instance bound to a model attribute or form field name.

### Method
`public static function make(string $fieldName): self`

### Parameters
#### Path Parameters
- **fieldName** (string) - Required - The database column or model attribute name

### Response
#### Success Response
- **self** - The field instance for method chaining

### Request Example
```php
use Novadaemon\FilamentPrettyJson\Form\PrettyJsonField;

PrettyJsonField::make('api_response');
PrettyJsonField::make('webhook_payload');
PrettyJsonField::make('config_data');
```
```

--------------------------------

### Composer JSON for Package Registration

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/configuration.md

This JSON snippet shows how the filament-pretty-json package is declared for automatic service provider registration in Laravel.

```json
{
    "extra": {
        "laravel": {
            "providers": [
                "Novadaemon\\FilamentPrettyJson\\FilamentPrettyJsonServiceProvider"
            ]
        }
    }
}
```

--------------------------------

### Alpine.js Integration for JSON Rendering

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonfield.md

The view uses Alpine.js to bind the field state and render JSON with syntax highlighting. The state is synced with Livewire, and a getter formats the JSON for display.

```javascript
x-data="{
    state: $wire.entangle('{{ $getStatePath() }}'),
    get prettyJson() {
        json = JSON.parse(this.state != undefined ? this.state : '{}')
        return window.prettyPrint(json)
    }
}"
```

--------------------------------

### Setting Custom Field Label

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/configuration.md

Demonstrates how to set a custom label for the PrettyJsonField, which appears above the JSON display.

```php
PrettyJsonField::make('api_response')
    ->label('API Response Body')
```

--------------------------------

### window.prettyPrint

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/API-REFERENCE.md

Converts a JavaScript object to an indented HTML string with syntax-highlighted JSON markup. This function is globally available after the package is registered.

```APIDOC
## JavaScript API: window.prettyPrint

### Description
Converts a JavaScript object to an indented HTML string with syntax-highlighted JSON markup.

### Method
`window.prettyPrint(json: object): string`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **json** (object) - Required - The JavaScript object to format.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **string** - An HTML string representing the formatted JSON.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### PrettyJsonField with Copy Feature

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonfield.md

Enable the copy-to-clipboard functionality for the PrettyJsonField. Customize the copy button label and the confirmation message.

```php
PrettyJsonField::make('webhook_payload')
    ->label('Webhook Payload')
    ->copyable()
    ->copyMessage('Webhook payload copied!')
    ->copyMessageDuration(2500)
```

--------------------------------

### Set Copy Confirmation Message

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/copyable.md

Customize the tooltip message shown after copying using `copyMessage()`. This can be a static string, a dynamic closure, or an Htmlable object.

```php
use Novadaemon\FilamentPrettyJson\Form\PrettyJsonField;
use Illuminate\Support\HtmlString;

// Static message
PrettyJsonField::make('config')
    ->copyable()
    ->copyMessage('Configuration JSON copied!')

// Closure (dynamic)
PrettyJsonField::make('data')
    ->copyable()
    ->copyMessage(fn() => __('messages.json_copied'))

// With Htmlable (for styling)
PrettyJsonField::make('api_response')
    ->copyable()
    ->copyMessage(new HtmlString('<strong>Success!</strong> Copied to clipboard'))

// Conditional message
->copyMessage(fn() => 
    auth()->user()->is_admin 
        ? 'Admin: JSON copied' 
        : 'JSON copied'
)
```

--------------------------------

### Custom PrettyJsonField with Copyable and Styling

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/api-reference/prettyjsonfield.md

Extend the PrettyJsonField to add custom behavior like making the JSON always copyable with a custom message and applying specific styling.

```php
<?php

namespace App\Forms\Components;

use Novadaemon\FilamentPrettyJson\Form\PrettyJsonField;

class ApiResponseField extends PrettyJsonField
{
    protected function setUp(): void
    {
        parent::setUp();

        // Always copyable
        $this->copyable();

        // Always with helpful message
        $this->copyMessage('API response copied!');
        $this->copyMessageDuration(3000);

        // Always with style
        $this->extraAttributes([
            'style' => 'font-family: "Fira Code", monospace;',
        ]);
    }
}

// Usage
ApiResponseField::make('response_body')
    ->label('API Response')
```

--------------------------------

### PHP String Type Notation

Source: https://github.com/novadaemon/filament-pretty-json/blob/main/_autodocs/README.md

Represents a PHP string type.

```php
string
```
Tokens:
Raw