final | |
|---|---|
readonly | |
extends |
AbstractControl |
Typed DTO for sap.m.Button — the canonical action control inside
card-header toolbars (sap.f.cards.Header / NumericHeader toolbar
aggregation), group panels, and other dashboard composition seats.
text is typically a UI5 binding expression ("{i18n>key}") — the
host UI5 i18n model resolves it at render time. icon accepts an
sap-icon:// URI (UI5 ships an icon font) or a custom image URI.
parameters is the press-intent seat — same convention as
{@see GenericTile::$parameters}: a free-form payload the Dashboard
control extracts via custom data and replays as the parameters of
the dashboard action event when this button is pressed. The button
fires no UI5 binding-resolved navigation itself; the host's
onAction handler dispatches based on parameters.method.
Example header toolbar:
new Header(
title: 'Your ERI',
toolbar: new OverflowToolbar([
new Button(
text: 'Open workspace',
icon: 'sap-icon://workspace',
type: ButtonType::Transparent,
parameters: ['method' => 'navTo', 'target' => '/workspace'],
),
]),
)
Omitted from the wire when parameters is null — a button with no
press-intent simply does nothing on press (or whatever UI5's default
is for an unhandled press event), so the absent parameters is the
"not an action" state. Same posture as Tile's parameters.
| Methods | ||
|---|---|---|
public
|
__construct(
?string $text = null,
?ButtonType $type = null,
?string $icon = null,
?bool $enabled = null,
?bool $visible = null,
?string $tooltip = null,
array<string, mixed>|null $parameters = null,
?string $class = null,
)
|
# |
public
|
ui5Class(): string
|
# |
| Methods inherited from LaravelUi5\Core\Ui5\Controls\AbstractControl |
|---|
jsonSerialize() |
| Properties | |||
|---|---|---|---|
public
|
?string
|
$text
|
# |
public
|
?ButtonType
|
$type
|
# |
public
|
?string
|
$icon
|
# |
public
|
?bool
|
$enabled
|
# |
public
|
?bool
|
$visible
|
# |
public
|
?string
|
$tooltip
|
# |
public
|
array<string, mixed>|null
|
$parameters
|
# |
public
|
?string
|
$class
|
# |