This describes a toggle button. More...

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

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

Public Member Functions
	getActionOn ()
	Get the action of the Toggle Button when it is set from off to on. More...

	getActionOff ()
	Get the action of the Toggle Button when it is set from on to off. More...

	withAdditionalToggleOnSignal (Signal $signal)

	withAdditionalToggleOffSignal (Signal $signal)

Public Member Functions inherited from ILIAS\UI\Component\Button\Button
	getLabel ()
	Get the label on the button. More...

	withLabel (string $label)
	Get a button like this, but with an additional/replaced label. More...

	withSymbol (?Symbol $symbol)
	Get a button like this with a symbol in its label. More...

	getAction ()
	Get the action of the button, i.e. More...

	isActive ()
	Get to know if the button is activated. More...

	withUnavailableAction (bool $flag=true)
	Get a button like this, but action should be unavailable atm. More...

	withAriaLabel (string $aria_label)
	Get a button like this, but with an additional/replaced aria-label. More...

	getAriaLabel ()
	Get the aria-label on the button. More...

Public Member Functions inherited from ILIAS\UI\Component\Component
	getCanonicalName ()
	Get the canonical name of the component. More...

Public Member Functions inherited from ILIAS\UI\Component\JavaScriptBindable
	withOnLoadCode (Closure $binder)

	withAdditionalOnLoadCode (Closure $binder)
	Add some onload-code to the component instead of replacing the existing one. More...

	getOnLoadCode ()
	Get the currently bound on load code. More...

Public Member Functions inherited from ILIAS\UI\Component\Clickable
	withOnClick (Signal $signal)
	Get a component like this, triggering a signal of another component on click. More...

	appendOnClick (Signal $signal)
	Get a component like this, triggering a signal of another component on click. More...

Public Member Functions inherited from ILIAS\UI\Component\Triggerer
	withResetTriggeredSignals ()
	Get a component like this but reset any triggered signals of other components. More...

	getTriggeredSignals ()
	Get all triggered signals of this component. More...

Public Member Functions inherited from ILIAS\UI\Component\Hoverable
	withOnHover (Signal $signal)
	Get a component like this, triggering a signal of another component on hover. More...

	appendOnHover (Signal $signal)
	Get a component like this, triggering a signal of another component on hover. More...

Public Member Functions inherited from ILIAS\UI\Component\Button\Engageable
	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\HasHelpTopics
	withHelpTopics (Topic ... $topics)
	Let this component have the given topics. More...

	withAdditionalHelpTopics (Topic ... $topics)
	Let this component also have the given topics. More...

	getHelpTopics ()

Detailed Description

This describes a toggle button.

Definition at line 28 of file Toggle.php.

Member Function Documentation

◆ getActionOff()

ILIAS\UI\Component\Button\Toggle::getActionOff ( )

Get the action of the Toggle Button when it is set from on to off.

Returns: string|Signal[]

◆ getActionOn()

ILIAS\UI\Component\Button\Toggle::getActionOn ( )

Get the action of the Toggle Button when it is set from off to on.

Returns: string|Signal[]

◆ withAdditionalToggleOffSignal()

ILIAS\UI\Component\Button\Toggle::withAdditionalToggleOffSignal ( Signal $signal )

◆ withAdditionalToggleOnSignal()

ILIAS\UI\Component\Button\Toggle::withAdditionalToggleOnSignal ( Signal $signal )

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