class Input extends BaseFormField (View source)

Traits

Constants

TYPE_TEXT

TYPE_NUMBER

TYPE_TEXTAREA

TYPE_EMAIL

TYPE_URL

Properties

bool $renderForBlocks from  RenderForBlocks
protected bool $translated from  IsTranslatable
protected int|null $min from  HasMin
protected int|null $max from  HasMax
protected int|null $maxlength from  HasMaxlength
protected string|null $placeholder from  HasPlaceholder
protected bool|null $readOnly from  HasReadOnly
protected string|null $direction from  HasDirection
protected string|null $ref from  HasOnChange
protected string|null $onChange from  HasOnChange
protected string|null $onChangeAttribute from  HasOnChange
protected string $type
protected string $prefix
protected string|null $mask
protected int|null $rows

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.

min(int $min)

Sets the minimum amount of items.

from  HasMin
max(int $max)

Sets the max amount of items.

from  HasMax
maxLength(string $maxlength)

Sets the max character length.

placeholder(string $placeholder)

Sets the placeholder of the field.

readOnly(bool $readOnly = true)

Marks the field as read only.

direction(string $direction)

Sets the direction of the field.

ref(string $ref)

The field to act on.

onChange(string $onChange)

Javascript to execute on change.

onChangeAttribute(string $onChangeAttribute)

Attribute to change.

prefix(string $prefix)

Text to display (inside) before the actual input.

type(string $type)

The type of input field like: text, number, email, .

mask(string $mask)

Apply a mask to field based on alpinjs mask.

rows(int $rows)

The amount of rows, only used with textarea type.

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

HasMin min(int $min)

Sets the minimum amount of items.

Parameters

int $min

Return Value

HasMin

HasMax max(int $max)

Sets the max amount of items.

Parameters

int $max

Return Value

HasMax

HasMaxlength maxLength(string $maxlength)

Sets the max character length.

Parameters

string $maxlength

Return Value

HasMaxlength

HasPlaceholder placeholder(string $placeholder)

Sets the placeholder of the field.

Parameters

string $placeholder

Return Value

HasPlaceholder

HasReadOnly readOnly(bool $readOnly = true)

Marks the field as read only.

Parameters

bool $readOnly

Return Value

HasReadOnly

HasDirection direction(string $direction)

Sets the direction of the field.

Parameters

string $direction

Return Value

HasDirection

HasOnChange ref(string $ref)

The field to act on.

Parameters

string $ref

Return Value

HasOnChange

HasOnChange onChange(string $onChange)

Javascript to execute on change.

Parameters

string $onChange

Return Value

HasOnChange

HasOnChange onChangeAttribute(string $onChangeAttribute)

Attribute to change.

Parameters

string $onChangeAttribute

Return Value

HasOnChange

Input prefix(string $prefix)

Text to display (inside) before the actual input.

Parameters

string $prefix

Return Value

Input

Input type(string $type)

The type of input field like: text, number, email, .

.

Parameters

string $type

Return Value

Input

Input mask(string $mask)

Apply a mask to field based on alpinjs mask.

This only works with Input::TYPE_TEXT

Parameters

string $mask

Return Value

Input

See also

https://alpinejs.dev/plugins/mask

Input rows(int $rows)

The amount of rows, only used with textarea type.

Parameters

int $rows

Return Value

Input