class Checkboxes extends BaseFormField (View source)

Traits

Properties

bool $renderForBlocks from  RenderForBlocks
protected bool $translated from  IsTranslatable
protected Options|null $options from  HasOptions
protected int $columns from  HasColumns
protected int|null $max from  HasMax
protected int|null $min from  HasMin
protected bool $inline from  Inlineable
protected bool $border from  HasBorder

Methods

renderForBlocks(bool $renderForBlocks = true)

No description

bool
forBlocks()

No description

__construct(string $component, string|null $name = null, string|null $label = null, string|null $note = null, bool|null $required = false, bool|null $disabled = false, mixed $default = null, mixed $connectedTo = null, array $mandatoryProperties = [])

No description

static BaseFormField
make()

No description

name(string $name)

Set the name of the field, if no label is set yet, this method will also update that.

default(mixed $default)

No description

label(string $label)

Set the label of the field, you can use twillTrans('') Laravel translatable strings here.

note(string $note)

Add a note to the field to display on the form.

required(bool $required = true)

Marks the field as mandatory, however you still need to add validation rules.

disabled(bool $disabled = true)

Marks the field as disabled.

connectedTo(string $fieldName, mixed $fieldValues, array $options = [])

No description

View
render()

No description

array
getAdditionalConstructorArguments()

In render we dynamically build the constructor arguments.

translatable(bool $translatable = true)

Makes the field translatable.

options(Options|Closure|array $options)

List of options to display in the field.

addOption(Option $option)

Adds a single option.

getOptions()

No description

max(int $max)

Sets the max amount of items.

from  HasMax
min(int $min)

Sets the minimum amount of items.

from  HasMin
inline(bool $inline = true)

Shows the option inline.

border(bool $border = true)

Adds a border around the options.

columns(int $columns = 1)

The amount of column to show the option in (when using unpack).

Details

RenderForBlocks renderForBlocks(bool $renderForBlocks = true)

No description

Parameters

bool $renderForBlocks

Return Value

RenderForBlocks

bool forBlocks()

No description

Return Value

bool

protected __construct(string $component, string|null $name = null, string|null $label = null, string|null $note = null, bool|null $required = false, bool|null $disabled = false, mixed $default = null, mixed $connectedTo = null, array $mandatoryProperties = [])

No description

Parameters

string $component
string|null $name
string|null $label
string|null $note
bool|null $required
bool|null $disabled
mixed $default
mixed $connectedTo
array $mandatoryProperties

static BaseFormField make()

No description

Return Value

BaseFormField

BaseFormField name(string $name)

Set the name of the field, if no label is set yet, this method will also update that.

Parameters

string $name

Return Value

BaseFormField

BaseFormField default(mixed $default)

No description

Parameters

mixed $default

Return Value

BaseFormField

BaseFormField label(string $label)

Set the label of the field, you can use twillTrans('') Laravel translatable strings here.

Parameters

string $label

Return Value

BaseFormField

BaseFormField note(string $note)

Add a note to the field to display on the form.

Parameters

string $note

Return Value

BaseFormField

BaseFormField required(bool $required = true)

Marks the field as mandatory, however you still need to add validation rules.

Parameters

bool $required

Return Value

BaseFormField

BaseFormField disabled(bool $disabled = true)

Marks the field as disabled.

There might be some fields not supporting this.

Parameters

bool $disabled

Return Value

BaseFormField

connectedTo(string $fieldName, mixed $fieldValues, array $options = [])

No description

Parameters

string $fieldName
mixed $fieldValues
array $options

View render()

No description

Return Value

View

protected array getAdditionalConstructorArguments()

In render we dynamically build the constructor arguments.

In exceptional cases such as browser we have more conditionals and we can use this method to set those.

Return Value

array

IsTranslatable translatable(bool $translatable = true)

Makes the field translatable.

Parameters

bool $translatable

Return Value

IsTranslatable

HasOptions options(Options|Closure|array $options)

List of options to display in the field.

Parameters

Options|Closure|array $options

Return Value

HasOptions

HasOptions addOption(Option $option)

Adds a single option.

Parameters

Option $option

Return Value

HasOptions

protected Options getOptions()

No description

Return Value

Options

HasMax max(int $max)

Sets the max amount of items.

Parameters

int $max

Return Value

HasMax

HasMin min(int $min)

Sets the minimum amount of items.

Parameters

int $min

Return Value

HasMin

Inlineable inline(bool $inline = true)

Shows the option inline.

Parameters

bool $inline

Return Value

Inlineable

HasBorder border(bool $border = true)

Adds a border around the options.

Parameters

bool $border

Return Value

HasBorder

HasColumns columns(int $columns = 1)

The amount of column to show the option in (when using unpack).

Parameters

int $columns

Return Value

HasColumns