ILIAS\UI\examples\Button\Toggle Namespace Reference

Functions
	base ()
	description: > Example for rendering a Toggle Button. More...
	unavailable_action ()
	description: > This example provides the given button with an unavailable action. More...
	with_tooltip ()
	description: > Example for rendering a Toggle Button with tooltips More...

Function Documentation

base()

ILIAS\UI\examples\Button\Toggle\base

(

)

---

description: > Example for rendering a Toggle Button.

expected output: > ILIAS shows a switch. Clicking onto the switch will result in the switch moving to the right side and opening a dialog: "Toggle Button has been turned on". Closing the dialog via "delete" will move back the switch. The switch will stay on the right side if the dialog is closed via "close".

Another click onto the switch will move the switch to the left side. ILIAS notifies: "Toggle Button has been turned off".

Definition at line 36 of file base.php.

References $DIC, and $renderer.

{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();

    $message1 = 'Toggle Button has been turned on';
    $message2 = 'Toggle Button has been turned off';
    $form_action = $DIC->ctrl()->getFormActionByClass('ilsystemstyledocumentationgui');

    $modal = $factory->modal()->interruptive('ON', $message1, $form_action);
    $modal2 = $factory->modal()->interruptive('OFF', $message2, $form_action);

    //Note, important do not miss to set a proper aria-label (see rules above).
    //Note that aria-pressed is taken care off by the default implementation.
    $button = $factory->button()->toggle("", $modal->getShowSignal(), $modal2->getShowSignal())
        ->withAriaLabel("Switch the State of XY");

    return $renderer->render([$button, $modal, $modal2]);
}

unavailable_action()

ILIAS\UI\examples\Button\Toggle\unavailable_action

(

)

---

description: > This example provides the given button with an unavailable action.

Note that the disabled attribute is set in the DOM. No action must be fired, even if done by keyboard.

expected output: >

ILIAS shows a greyed out switch. Clicking onto the switch won't activate any actions.

Definition at line 34 of file unavailable_action.php.

References $DIC, Vendor\Package\$f, and $renderer.

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();

    $button = $f->button()->toggle('', '#', '#')
                          ->withAriaLabel("Switch the State of XY")
                          ->withUnavailableAction();

    return $renderer->render([$button]);
}

with_tooltip()

ILIAS\UI\examples\Button\Toggle\with_tooltip

(

)

---

description: > Example for rendering a Toggle Button with tooltips

expected output: >

Hovering over the rendered switch shows following tooltips: "tooltip: ilias" and "tooltip: learning management system".

Definition at line 32 of file with_tooltip.php.

References $DIC, Vendor\Package\$f, and $renderer.

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();

    $button = $f->button()->toggle('', '#', '#')
                          ->withAriaLabel("Switch the State of XY")
                          ->withHelpTopics(
                              ...$f->helpTopics("ilias", "learning management system")
                          );

    return $renderer->render([$button]);
}