Documentation

Kitchen Sink documentation of style: 'Delos' of skin: 'ILIAS'

Property

Description

Purpose: Property Listings will list characteristic, labeled values in a space saving manner. Property listing is ideal when there are many values of reasonable, but not specific or primarily relevant, importance.
Composition: Entries are listed as label/value pair in one line. Since the focus is strongly on the value, which might be self-explaining, visibility of the label is optional. The value is a string, or one or several Symbols, Links or Legacy Components.

Context

Property Listing is used in Entities

Rivals

Characteristic Value: In Charakteristic Values, label/value pairs are displayed in a tabular way; labels cannot be omitted for display.
Descriptive: The Descriptive's (visual) emphasis is on the key, not the value.

Example 1: Base

Title Some Title

number 7

in progress

a 1

link Goto ILIAS

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Listing\Property;
 
function base()
{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    $props = $f->listing()->property()
        ->withProperty('Title', 'Some Title')
        ->withProperty('number', '7')
        ->withProperty(
            'status',
            $renderer->render(
                $f->symbol()->icon()->custom('./templates/default/images/learning_progress/in_progress.svg', 'incomplete'),
            ) . ' in progress',
            false
        );
 
    $props2 = $props->withItems([
        ['a', "1"],
        ['y', "25", false],
        ['link', $f->link()->standard('Goto ILIAS', 'http://www.ilias.de')]
    ]);
 
    return $renderer->render([
            $props,
            $f->divider()->horizontal(),
            $props2
    ]);
}

Relations

Parents

UIComponent
Listing