Documentation

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

Report

Description

Purpose: Report Panels display user-generated data combining text in lists, tables and sometimes charts. Report Panels always draw from two distinct sources: the structure / scaffolding of the Report Panels stems from user-generated content (i.e a question of a survey, a competence with levels) and is filled with user-generated content harvested by that very structure (i.e. participants’ answers to the question, self-evaluation of competence).
Composition: They are composed of a Standard Panel which contains several Sub Panels. They might also contain a card to display information meta information in their first block.
Effect: Report Panels are predominantly used for displaying data. They may however comprise links or buttons.

Rivals

Standard Panels: The Report Panels contains sub panels used to structure information.
Presentation Table: Presentation Tables display only a subset of the data at first glance; their entries can then be expanded to show detailed information.

Rules

Usage

Report Panels SHOULD be used when user generated content of two sources (i.e results, guidelines in a template) is to be displayed alongside each other.

Interaction

Links MAY open new views.
Buttons MAY trigger actions or inline editing.

Example 1: Base

Report Title

Sub Panel Title 1

Some Content

Card Heading

Card Content

Sub Panel Title 2

Some Content

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Panel\Report;
 
function base()
{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    $sub1 = $f->panel()->sub("Sub Panel Title 1", $f->legacy("Some Content"))
            ->withFurtherInformation($f->card()->standard("Card Heading")->withSections(array($f->legacy("Card Content"))));
    $sub2 = $f->panel()->sub("Sub Panel Title 2", $f->legacy("Some Content"));
 
    $block = $f->panel()->report("Report Title", array($sub1,$sub2));
 
    return $renderer->render($block);
}

Relations

Parents

UIComponent
Panel