webkernel/platform-forms

05-toggle

On this page

title: Toggle

Introduction

The toggle component, similar to a checkbox, allows you to interact a boolean value.

use Webkernel\Platform\Forms\Components\Toggle;

Toggle::make('is_admin')

If you're saving the boolean value using Eloquent, you should be sure to add a boolean cast to the model property:

use Webkernel\ORM\Model;

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

    // ...
}

Adding icons to the toggle button

Toggles may also use an icon to represent the "on" and "off" state of the button. To add an icon to the "on" state, use the onIcon() method. To add an icon to the "off" state, use the offIcon() method:

use Webkernel\Platform\Forms\Components\Toggle;
use Webkernel\Platform\Support\Icons\Heroicon;

Toggle::make('is_admin')
    ->onIcon(Heroicon::Bolt)
    ->offIcon(Heroicon::User)

<UtilityInjection set="formFields">As well as allowing static values, the onIcon() and offIcon() methods also accept functions to dynamically calculate them. You can inject various utilities into the function as parameters.</UtilityInjection>

Customizing the color of the toggle button

You may also customize the color representing the "on" or "off" state of the toggle. To add a color to the "on" state, use the onColor() method. To add a color to the "off" state, use the offColor() method:

use Webkernel\Platform\Forms\Components\Toggle;

Toggle::make('is_admin')
    ->onColor('success')
    ->offColor('danger')

<UtilityInjection set="formFields">As well as allowing static values, the onColor() and offColor() methods also accept functions to dynamically calculate them. You can inject various utilities into the function as parameters.</UtilityInjection>

Positioning the label above

Toggle fields have two layout modes, inline and stacked. By default, they are inline.

When the toggle is inline, its label is adjacent to it:

use Webkernel\Platform\Forms\Components\Toggle;

Toggle::make('is_admin')
    ->inline()

When the toggle is stacked, its label is above it:

use Webkernel\Platform\Forms\Components\Toggle;

Toggle::make('is_admin')
    ->inline(false)

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

Toggle validation

As well as all rules listed on the validation page, there are additional rules that are specific to toggles.

Accepted validation

You may ensure that the toggle is "on" using the accepted() method:

use Webkernel\Platform\Forms\Components\Toggle;

Toggle::make('terms_of_service')
    ->accepted()

Optionally, you may pass a boolean value to control if the validation rule should be applied or not:

use Webkernel\Platform\Forms\Components\Toggle;

Toggle::make('terms_of_service')
    ->accepted(FeatureFlag::active())

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

Declined validation

You may ensure that the toggle is "off" using the declined() method:

use Webkernel\Platform\Forms\Components\Toggle;

Toggle::make('is_under_18')
    ->declined()

Optionally, you may pass a boolean value to control if the validation rule should be applied or not:

use Webkernel\Platform\Forms\Components\Toggle;

Toggle::make('is_under_18')
    ->declined(FeatureFlag::active())

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