ILIAS\UI\examples\Button\Bulky Namespace Reference

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

Function Documentation

base()

ILIAS\UI\examples\Button\Bulky\base

(

)

---

description: > Example for rendering a bulky button.

note: > The exact look of the Bulky Buttons is mostly defined by the surrounding container.

expected output: >

ILIAS shows buttons with icons, glyphs and in some cases a title. Clicking the button won't activate any actions.

Definition at line 35 of file base.php.

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

Referenced by ilTableGUI\setBase().

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

    $ico = $f->symbol()->icon()
        ->standard('someExample', 'Example')
        ->withAbbreviation('E')
        ->withSize('medium');
    $button = $f->button()->bulky($ico, 'Icon', '#');

    $glyph = $f->symbol()->glyph()->briefcase();
    $button2 = $f->button()->bulky($glyph, 'Glyph', '#');

    $button3 = $f->button()->bulky($glyph, '', '#');
    $button4 = $f->button()->bulky($ico, '', '#');

    return $renderer->render([
        $button,
        $f->divider()->horizontal(),
        $button2,
        $f->divider()->horizontal(),
        $button3,
        $f->divider()->horizontal(),
        $button4
    ]);
}

Here is the caller graph for this function:

engaged()

ILIAS\UI\examples\Button\Bulky\engaged

(

)

---

description: > Example for rendering an engaged bulky button

expected output: > ILIAS shows a button with a glyph and the title "Engaged". The button's background looks different from the base bulky button.

Clicking the button won't activate any actions.

Definition at line 33 of file engaged.php.

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

Referenced by ILIAS\UI\Implementation\Component\Button\Toggle\__construct().

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

    $glyph = $f->symbol()->glyph()->briefcase();
    $button = $f->button()->bulky($glyph, 'Engaged Button', '#')
                          ->withEngagedState(true);

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

Here is the caller graph for this function:

unavailable_action()

ILIAS\UI\examples\Button\Bulky\unavailable_action

(

)

---

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

expected output: > ILIAS shows a button with a glyph and the title "Unavailable". The button's background is grayed out. Clicking the button won't activate any actions.

note: > The disabled attribute is set in the DOM.

No action must be fired, even if done by keyboard.

Definition at line 37 of file unavailable_action.php.

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

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

    $glyph = $f->symbol()->glyph()->attachment();
    $button = $f->button()->bulky($glyph, 'Unavailable', '#')->withUnavailableAction();

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

with_tooltip()

ILIAS\UI\examples\Button\Bulky\with_tooltip

(

)

---

description: > Example for rendering a bulky button with tooltips

expected output: > Hovering over the rendered text will show you the following tooltips: "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();
    $glyph = $f->symbol()->glyph()->comment();

    $button = $f->button()
        ->bulky($glyph, "Goto ILIAS", "http://www.ilias.de")
        ->withHelpTopics(
            ...$f->helpTopics("ilias", "learning management system")
        );

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