ILIAS\UI\Component\Button\Engageable Interface Reference

Engageable Components have an "engaged" state and will be displayed accordingly. More...

Inheritance diagram for ILIAS\UI\Component\Button\Engageable:

Collaboration diagram for ILIAS\UI\Component\Button\Engageable:

Public Member Functions
	isEngageable ()
	Returns whether the button is stateful or not. More...
	withEngagedState (bool $state)
	Get a copy of the Engageable Button with engaged state for $state=true and with disengaged state for $state=false. More...
	isEngaged ()
	Returns whether the button is currently engaged or not. More...
Public Member Functions inherited from ILIAS\UI\Component\Component
	getCanonicalName ()
	Get the canonical name of the component. More...
	reduceWith (\Closure $fn)
	The scheme starts at the leaves of the structure and applies the function to each leave and moves up the tree recursively. More...

Detailed Description

Engageable Components have an "engaged" state and will be displayed accordingly.

Definition at line 28 of file Engageable.php.

Member Function Documentation

isEngageable()

ILIAS\UI\Component\Button\Engageable::isEngageable

(

)

Returns whether the button is stateful or not.

Engageable must be explicitly turned on by initializing the Button with a state (withEngagedState), since not all Buttons are used as toggles and thus should not bear an aria-pressed attribute.

Referenced by ILIAS\UI\Implementation\Component\Button\Renderer\renderButton().

Here is the caller graph for this function:

isEngaged()

ILIAS\UI\Component\Button\Engageable::isEngaged

(

)

Returns whether the button is currently engaged or not.

withEngagedState()

ILIAS\UI\Component\Button\Engageable::withEngagedState

(

bool

$state

)

Get a copy of the Engageable Button with engaged state for $state=true and with disengaged state for $state=false.

Returns

static

---

The documentation for this interface was generated from the following file:

• components/ILIAS/UI/src/Component/Button/Engageable.php