webkernel/platform-infolists

07-key-value-entry

On this page

title: Key-value entry

Introduction

The key-value entry allows you to render key-value pairs of data, from a one-dimensional JSON object / PHP array.

use Webkernel\Platform\Infolists\Components\KeyValueEntry;

KeyValueEntry::make('meta')

For example, the state of this entry might be represented as:

[
    'description' => 'Platform is a collection of Laravel packages',
    'og:type' => 'website',
    'og:site_name' => 'Platform',
]

If you're saving the data in Eloquent, you should be sure to add an array cast to the model property:

use Webkernel\ORM\Model;

class Post extends Model
{
    /**
     * @return array<string, string>
     */
    protected function casts(): array
    { 
        return [
            'meta' => 'array',
        ];
    }

    // ...
}

Customizing the key column's label

You may customize the label for the key column using the keyLabel() method:

use Webkernel\Platform\Infolists\Components\KeyValueEntry;

KeyValueEntry::make('meta')
    ->keyLabel('Property name')

<UtilityInjection set="infolistEntries">As well as allowing a static value, the keyLabel() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.</UtilityInjection>

Customizing the value column's label

You may customize the label for the value column using the valueLabel() method:

use Webkernel\Platform\Infolists\Components\KeyValueEntry;

KeyValueEntry::make('meta')
    ->valueLabel('Property value')

<UtilityInjection set="infolistEntries">As well as allowing a static value, the valueLabel() method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.</UtilityInjection>