ILIAS\UI\examples\Button\Primary Namespace Reference

Functions
	base ()
	description: > Example for rendering a primary button. More...
	engaged ()
	description: > Example for rendering an engaged primary 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_load_anim ()
	description: > Example for rendering a primary button with a loading animation More...
	with_tooltip ()
	description: > Example for rendering a primary button with tooltips More...

Function Documentation

base()

ILIAS\UI\examples\Button\Primary\base

(

)

---

description: > Example for rendering a primary button.

expected output: > ILIAS shows an active, very colorful button with a title. 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()->primary("Goto ILIAS", "http://www.ilias.de"));
}

engaged()

ILIAS\UI\examples\Button\Primary\engaged

(

)

---

description: > Example for rendering an engaged primary button

expected output: >

ILIAS shows a white button with a title. A click onto 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()->primary("Engaged Button", "#")
                                  ->withEngagedState(true);
    return $renderer->render($button);
}

unavailable_action()

ILIAS\UI\examples\Button\Primary\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 grayed out inactive button with a title. Clicking the button won't activate any actions.

Hovering over the button will change the look of the cursor.

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()->primary('Unavailable', '#')->withUnavailableAction();

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

with_glyph()

ILIAS\UI\examples\Button\Primary\with_glyph

(

)

---

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

expected output: >

ILIAS shows buttons with the Search Gylph and in some cases a label in different states.

Definition at line 32 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()->primary('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_load_anim()

ILIAS\UI\examples\Button\Primary\with_load_anim

(

)

---

description: > Example for rendering a primary button with a loading animation

expected output: > ILIAS shows an active, very colorful button with a title. After clicking the button the text will change to "Working..." and the button's color will change to grey. During that process you cannot click the button. After a

while the button will change to it's origin color and the text will be "Done".

Definition at line 34 of file with_load_anim.php.

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

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

    return $renderer->render(
        $f->button()->primary("Goto ILIAS", "")
            ->withLoadingAnimationOnClick(true)
            ->withOnLoadCode(function ($id) {
                return
                    "$('#$id').click(function(e) {
                                                        $('#$id').html('Working...');
                                                        setInterval(
                                                                function(){
                                                                        $('#$id').html('Done');
                                                                        il.UI.button.deactivateLoadingAnimation('$id');
                                                                }
                                                        ,3000);
                                        });";
            })
    );
}

with_tooltip()

ILIAS\UI\examples\Button\Primary\with_tooltip

(

)

---

description: > Example for rendering a primary button with tooltips

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

content: "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();
    $primary = $f->button()->primary("Goto ILIAS", "http://www.ilias.de")
        ->withHelpTopics(
            ...$f->helpTopics("ilias", "learning management system")
        );
    return $renderer->render($primary);
}