06-view

title: View action

Introduction

Platform includes an action that is able to view Eloquent records. When the trigger button is clicked, a modal will open with information inside. Platform uses form fields to structure this information. All form fields are disabled, so they are not editable by the user. You may use it like so:

use Webkernel\Platform\Actions\ViewAction;
use Webkernel\Platform\Forms\Components\TextInput;

ViewAction::make()
    ->schema([
        TextInput::make('title')
            ->required()
            ->maxLength(255),
        // ...
    ])

<AutoScreenshot name="actions/view-action/modal" alt="View action modal" />

Customizing data before filling the form

You may wish to modify the data from a record before it is filled into the form. To do this, you may use the mutateRecordDataUsing() method to modify the $data array, and return the modified version before it is filled into the form:

use Webkernel\Platform\Actions\ViewAction;

ViewAction::make()
    ->mutateRecordDataUsing(function (array $data): array {
        $data['user_id'] = auth()->id();

        return $data;
    })

<UtilityInjection set="actions">As well as $data, the mutateRecordDataUsing() function can inject various utilities as parameters.</UtilityInjection>