ILIAS\UI\examples\Item\Shy Namespace Reference

Functions
	base ()
	with_close ()
	with_description ()
	with_lead_icon ()
	with_long_description ()
	with_properties ()

Function Documentation

base()

ILIAS\UI\examples\Item\Shy\base

(

)

---

description: > Example for rendering a shy item.

expected output: >

ILIAS shows a box highlighted white and including the text "Test shy Item".

Definition at line 32 of file base.php.

{
    global $DIC;
 
    return $DIC->ui()->renderer()->render(
        $DIC->ui()->factory()->item()->shy('Test shy Item')
    );
}

References $DIC.

with_close()

ILIAS\UI\examples\Item\Shy\with_close

(

)

---

description: > Example for rendering a shy item with a close function.

expected output: > ILIAS renders a base shy item. Additionally a "X" for closing the item is displayed on the right side. If you

click onto the "X" nothing will happen.

Definition at line 33 of file with_close.php.

{
    global $DIC;
 
    return $DIC->ui()->renderer()->render(
        $DIC->ui()->factory()->item()->shy('Test shy Item')->withClose(
            $DIC->ui()->factory()->button()->close()
        )
    );
}

References $DIC.

with_description()

ILIAS\UI\examples\Item\Shy\with_description

(

)

---

description: > Example for rendering a shy item with a description.

expected output: > ILIAS shows a box highlighted white and including the text "Test shy Item". Additionally a short description is displayed

below the text.

Definition at line 33 of file with_description.php.

{
    global $DIC;
 
    return $DIC->ui()->renderer()->render(
        $DIC->ui()->factory()->item()->shy('Test shy Item')->withDescription('This is a test shy.')
    );
}

References $DIC.

with_lead_icon()

ILIAS\UI\examples\Item\Shy\with_lead_icon

(

)

---

description: > Example for rendering a shy item with an lead icon.

expected output: > ILIAS shows a box highlighted white and including the text "Test shy Item". Additionally a small icon is displayed

to the left of the text.

Definition at line 35 of file with_lead_icon.php.

{
    global $DIC;
 
    return $DIC->ui()->renderer()->render(
        $DIC->ui()->factory()->item()->shy('Test shy Item')->withLeadIcon(
            $DIC->ui()->factory()->symbol()->icon()->standard(Standard::GRP, 'conversation')
        )
    );
}

References $DIC, and ILIAS\UI\Component\Symbol\Icon\Standard\GRP.

with_long_description()

ILIAS\UI\examples\Item\Shy\with_long_description

(

)

---

description: > Example for rendering a shy item with a long description.

expected output: > ILIAS shows a box highlighted white and including the text "Test shy Item". Additionally a multi-lined description

is displayed below the text.

Definition at line 33 of file with_long_description.php.

{
    global $DIC;
 
    return $DIC->ui()->renderer()->render(
        $DIC->ui()->factory()->item()->shy('Test shy Item')->withDescription(
            'This is a test shy of the root user in the current time. This is a little bit longer than
            the usual to test its visual presentation when the content exceed a minor amount of chars to see if this
            is still presented properly. This may affect its presentation inside a mobile or restricted view therefore
            the presentation of a long text is necessary to test within this example to show its responsivity above all
            views and to show the using developer, who is accessing this example for exact those information if the
            component can be used for his target purpose.'
        )
    );
}

References $DIC.

with_properties()

ILIAS\UI\examples\Item\Shy\with_properties

(

)

---

description: > Example for rendering a shy item with properties.

expected output: > ILIAS shows a box highlighted white and including the text "Test shy Item". Additionally a fine dashed line is displayed

below the text. Right below the line you can see the information "Property: Value".

Definition at line 33 of file with_properties.php.

{
    global $DIC;
 
    return $DIC->ui()->renderer()->render(
        $DIC->ui()->factory()->item()->shy('Test shy Item')->withProperties(['Property' => 'Value'])
    );
}

References $DIC.