PHPackages                             hmayer/json-field - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Parsing & Serialization](/categories/parsing)
4. /
5. hmayer/json-field

ActivePackage[Parsing & Serialization](/categories/parsing)

hmayer/json-field
=================

Nova v4.x json field to spread a json column throughout multiple fields.

v1.0.0(2y ago)03.6k2[2 issues](https://github.com/hmayer/json-field/issues)[1 PRs](https://github.com/hmayer/json-field/pulls)MITPHPPHP >=8.2

Since May 31Pushed 2y ago1 watchersCompare

[ Source](https://github.com/hmayer/json-field)[ Packagist](https://packagist.org/packages/hmayer/json-field)[ RSS](/packages/hmayer-json-field/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (1)Versions (2)Used By (0)

Nova JSON Field
===============

[](#nova-json-field)

The `JSON` field wrapper allows you to specify multiple fields which will be resolved into a single model attribute. This allows you to validate every information you store inside a json column seperately.

```
JSON::make('Author', [
    Text::make('Name')->rules(['string', 'required', 'min:3']),
    Text::make('Email')->rules(['email', 'required']),
])
```

The above will be resolved into a single `author` attribute on the model.

```
// prequesite: the 'author' attribute needs to casted into a json castable type
// e.g. object, array, ...
['author' => ['name' => '', 'email' => '']]
```

Install & setup
-------------------

[](#install--setup)

`composer require hmayer/json-field`

Add the column's name, you want to use in the `JSON` field, to your `$casts` array on the resource's model!

Usage
-----

[](#usage)

- [Nova JSON Field](#nova-json-field)
    - [Install & setup](#install--setup)
    - [Usage](#usage)
        - [FillUsing callbacks](#fillusing-callbacks)
        - [Fill at once](#fill-at-once)
        - [Nullable Fields](#nullable-fields)
        - [Labels and Attributes](#labels-and-attributes)
        - [Nested Structures](#nested-structures)
        - [Use inside Panels](#use-inside-panels)
            - [Examples](#examples)
    - [Changelog](#changelog)
    - [Contributing](#contributing)
    - [Credits](#credits)
    - [Security](#security)
    - [License](#license)

You can destructure one JSON column into multiple Nova fields and apply unique rules to each of the key-value pairs.

```
use Hmayer\JsonField\JSON;

// within your nova resource
public function fields()
{
    return [
        //...
        JSON::make('Some Json Column Name', [
            Text::make('First Field'),
            Text::make('Second Field'),
            Text::make('Third Field'),
        ]);
    ]
}
```

### FillUsing callbacks

[](#fillusing-callbacks)

The `->fillUsing()` callbacks are normally used to fill the models attribute directly. With this package, it's not necessary to fill the model's attribute, but instead you should return the value you want to save on the model itself.

```
JSON::make('Address', 'address', [
    Text::make('Street')->fillUsing(fn ($request, $model, $attribute, $requestAttribute) => $request[$requestAttribute] . ' Foo'),
]);
```

The above example is rather silly than useful, but it demonstrates the concept. The \_ Foo\_ value will be apended to every `address->street` value within nova.

### Fill at once

[](#fill-at-once)

When using [data transfer objects](https://github.com/spatie/data-transfer-object) (which works well with [castable dto's](https://github.com/jessarcher/laravel-castable-data-transfer-object)) you don't want each field to be filled seperately, because than the dto's validation is useless. With the `fillAtOnce()` method a `Hidden` field will be added and the filling of single fields will be avoided. Instead all values will be filled at once via the `Hidden` field.

```
JSON::make('Address', 'address', [
    Text::make('Street'),
    Text::make('City'),
])->fillAtOnce();
```

The `fillOnce()` method accepts a `Callback` which can be used to modify the data structure before it is added to the model.

```
// given these fields:
JSON::make('Address', 'address', [
    Text::make('Street'),
    Text::make('City'),
])->fillAtOnce(function ($request, $requestValues, $model, $attribute, $requestAttribute) {
    return ['nested' => $requestValues];
});

// and a request with ['address->street' => 'test str. 5', 'address->city' => 'test city']

// we will get
$requestValues = ['street' => 'test str. 5', 'city' => 'test city'];

// which will be pased into the fillAtOnce callback leading to the following in our db:
['address' => ['nested' => ['street' => 'test str. 5', 'city' => 'test city']]];
```

### Nullable Fields

[](#nullable-fields)

As with other fields you can call `nullable()` and `nullValues()` on the JSON field directly to make all fields contained nullable and specify which values are treated as `null`

```
JSON::make('Address', 'address', [
    Text::make('Street'),
    Text::make('City'),
])->nullable()->nullValues(['_', 0])
```

### Labels and Attributes

[](#labels-and-attributes)

By default the first argument you provide the `JSON` field will be considered its `name`. If you don't provide a second string argument the `attribute` of the field will be guessed e.g. `'Some Json Column Name' => 'some_json_column_name'`. If you want your field `name` to be different from your `attribute` you can provide the field with a second argument and provide the fields as the third argument: `JSON::make('Some Name', 'column_name', [])`

### Nested Structures

[](#nested-structures)

The `JSON` field can also be nested by itself to display nested JSON structures:

```
JSON::make('Meta', [
    Text::make('Street'),

    JSON::make('Location', [
        Text::make('Latitude'),
        Text::make('Longitude'),
    ]),
]);
```

### Use inside Panels

[](#use-inside-panels)

In order to use JSON column inside Nova Panel you need to get 'data' property of the top level JSON field.

#### Examples

[](#examples)

1. JSON is the only field inside Panel

```
new Panel('Brand Settings',
    JSON::make('brand_settings', [
        Image::make('Logo')->disk('public'),
        Color::make('Primary Color')->swatches(),
        Color::make('Secondary Color')->swatches(),
    ]),
),
```

2. if you need other fields inside the Panel you can use splat operator like this:

```
new Panel('Brand Settings', [
    Text::make('Some Field'),
    JSON::make('brand_settings', [
        Image::make('Logo')->disk('public'),
        Color::make('Primary Color')->swatches(),
        Color::make('Secondary Color')->swatches(),
    ]),
]),
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

Credits
-------

[](#credits)

- [Henrique Mayer](https://github.com/hmayer)
- [Artem Stepanenko](https://github.com/stepanenko3)
- [Krishan Koenig](https://github.com/naoray)

Security
--------

[](#security)

If you discover any security-related issues, please using the issue tracker or pull requests.

License
-------

[](#license)

The MIT License (MIT). Please see [License File](/LICENSE.md) for more information.

###  Health Score

29

—

LowBetter than 59% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community5

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

1083d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/43e9d86f8c749a94806258fa945ce9bb1e1a958d17508d73dae0a48eccf8b7bb?d=identicon)[hmayer](/maintainers/hmayer)

---

Tags

jsonlaravelnova

### Embed Badge

![Health badge](/badges/hmayer-json-field/health.svg)

```
[![Health](https://phpackages.com/badges/hmayer-json-field/health.svg)](https://phpackages.com/packages/hmayer-json-field)
```

###  Alternatives

[stepanenko3/nova-json

Nova json field to spread a json column throughout multiple fields.

42249.7k](/packages/stepanenko3-nova-json)[interaction-design-foundation/nova-html-card

A Laravel Nova card to display arbitrary HTML content

67731.2k3](/packages/interaction-design-foundation-nova-html-card)[dniccum/nova-documentation

A Laravel Nova tool that allows you to add markdown-based documentation to your administrator's dashboard.

37116.4k](/packages/dniccum-nova-documentation)[digital-creative/nova-json-wrapper

Allows you to group Nova fields and merge their output into a single JSON column.

1379.9k1](/packages/digital-creative-nova-json-wrapper)[json-mapper/laravel-package

The JsonMapper package for Laravel

25170.4k3](/packages/json-mapper-laravel-package)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)