ILIAS\UI\examples\Button\Shy Namespace Reference

Functions
	base ()
	description: > Example for rendering a shy button. More...
	engaged ()
	description: > Example for rendering an engaged shy button More...
	unavailable_action ()
	description: > This example provides the given button with an unavailable action. More...
	with_glyph ()
	description: > This example provides buttons with a Glyph in (and as) the label. More...
	with_tooltip ()
	description: > Example for rendering a shy button with tooltips More...

Function Documentation

base()

ILIAS\UI\examples\Button\Shy\base

(

)

---

description: > Example for rendering a shy button.

expected output: > The shown button lacks a background, but shows a text. Clicking the button will

open the website www.ilias.de in the same browser window.

Definition at line 33 of file base.php.

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

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

    return $renderer->render($f->button()->shy("ILIAS", "http://www.ilias.de"));
}

engaged()

ILIAS\UI\examples\Button\Shy\engaged

(

)

---

description: > Example for rendering an engaged shy button

expected output: >

ILIAS shows a small button with a title. Clicking the button won't activate any actions.

Definition at line 32 of file engaged.php.

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

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

    $button = $f->button()->shy("Engaged Button", "#")
                                  ->withEngagedState(true);
    return $renderer->render($button);
}

unavailable_action()

ILIAS\UI\examples\Button\Shy\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 small button with a title. The button's background is colored dark grey. Clicking the button

won't activate any actions.

Definition at line 35 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()->shy('Unavailable', '#')->withUnavailableAction();

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

with_glyph()

ILIAS\UI\examples\Button\Shy\with_glyph

(

)

---

description: > This example provides buttons with a Glyph in (and as) the label.

expected output: > ILIAS shows a button with the Search Gylph and in some cases a label in different states.

Clicking the button won't activate any actions.

Definition at line 33 of file with_glyph.php.

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

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

    $glyph = $f->symbol()->glyph()->search();
    $button = $f->button()->shy('search', "#")
        ->withSymbol($glyph);
    $button2 = $button->withLabel('');

    return $renderer->render([
        $button,
        $button->withEngagedState(true),
        $button->withUnavailableAction(true),
        $f->divider()->vertical(),
        $button2,
        $button2->withEngagedState(true),
        $button2->withUnavailableAction(true),

    ]);
}

with_tooltip()

ILIAS\UI\examples\Button\Shy\with_tooltip

(

)

---

description: > Example for rendering a shy button with tooltips

expected output: > Hovering over the rendered button will show a tooltip with the following contents:

"tooltip: ilias" and "tooltip: learning management system".

Definition at line 33 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()
        ->shy("Goto ILIAS", "http://www.ilias.de")
        ->withHelpTopics(
            ...$f->helpTopics("ilias", "learning management system")
        );

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