Documentation

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

Mini

Description

Purpose: The Mini Progress Meter is used, if it needs to be as small as possible, like in an heading. It is used to display only a single Progress or performance indicator.
Composition: Other than the Standard and Fixed Size Progress Meter it does not allow a comparison value and only displays a single bar. It also does not display any text.

Rules

Composition

See composition rules for Progress Meter.

Example 1: Base

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Chart\ProgressMeter\Mini;
 
/**
 * Example for rendering a mini Progress Meter with minimum configuration
 */
function base()
{
    //Loading factories
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    //Genarating and rendering the mini progressmeter
    $progressmeter = $f->chart()->progressMeter()->mini(100, 75);
 
    // render
    return $renderer->render($progressmeter);
}

Example 2: Headline

Your Progress:

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Chart\ProgressMeter\Mini;
 
/**
 * Example for rendering a mini Progress Meter as part of a headline
 */
function headline()
{
    //Loading factories
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    //Genarating and rendering the mini progressmeter
    $progressmeter = $f->chart()->progressMeter()->mini(100, 75);
 
    // render
    return '<h3 style="display: inline-block;">Your Progress: </h3><div style="display: inline-block; padding-left: 20px">' .
        $renderer->render($progressmeter) . '</div>';
}

Example 3: Maximum configuration

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Chart\ProgressMeter\Mini;
 
/**
 * Example for rendering a mini Progress Meter with minimum configuration
 */
function maximum_configuration()
{
    //Loading factories
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    //Generating and rendering the mini progressmeter
    $progressmeter = $f->chart()->progressMeter()->mini(100, 50, 75);
 
    // render
    return $renderer->render($progressmeter);
}

Example 4: No score yet

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Chart\ProgressMeter\Mini;
 
/**
 * Example for rendering a mini Progress Meter when no score is given
 */
function no_score_yet()
{
    //Loading factories
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    //Generating and rendering the mini progressmeter
    $progressmeter = $f->chart()->progressMeter()->mini(100, 0);
 
    // render
    return $renderer->render($progressmeter);
}

Example 5: Reached 100 percent

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Chart\ProgressMeter\Mini;
 
/**
 * Example for rendering a mini Progress Meter when 100% are reached
 */
function reached_100_percent()
{
    //Loading factories
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    //Generating and rendering the mini progressmeter
    $progressmeter = $f->chart()->progressMeter()->mini(100, 100);
 
    // render
    return $renderer->render($progressmeter);
}

Relations

Parents

UIComponent
Chart
Progress Meter