class UsersSelectElement extends SelectElement

Traits

Properties

protected string $actionId

An identifier for this action.

from  SelectElement
protected PlainTextOnlyTextObject|null $placeholder

A plain_text only text object that defines the placeholder text shown on the menu.

from  SelectElement
protected bool|null $focusOnLoad

Indicates whether the element should automatically gain focus when the view loads.

from  SelectElement

Methods

id(string $id)

Set the action ID for the select.

placeholder(string $text)

Set the placeholder text.

focus(bool $focus = true)

Set whether the element should automatically gain focus when the view loads.

array
toArray()

Get the instance as an array.

__construct(string|null $text = null)

Create a new users select element instance.

initialUser(string $value)

Specify the ID of the user that should be selected by default.

Details

in SelectElement at line 42
SelectElement id(string $id)

Set the action ID for the select.

Parameters

string $id

Return Value

SelectElement

in SelectElement at line 56
SelectElement placeholder(string $text)

Set the placeholder text.

Parameters

string $text

Return Value

SelectElement

in SelectElement at line 66
SelectElement focus(bool $focus = true)

Set whether the element should automatically gain focus when the view loads.

Parameters

bool $focus

Return Value

SelectElement

at line 39
array toArray()

Get the instance as an array.

Return Value

array

at line 21
__construct(string|null $text = null)

Create a new users select element instance.

Parameters

string|null $text

at line 29
UsersSelectElement initialUser(string $value)

Specify the ID of the user that should be selected by default.

Parameters

string $value

Return Value

UsersSelectElement