Documentation

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

Help

Description

Purpose: The Help Glyph opens a context-sensitive help screen.
Composition: The Help Glyph uses the glyphicon-question-sign.
Effect: When clicked, the user is provided with explanations or instructions for the usage of the current context. When used in the Meta Bar, the help is displayed as tool in the Sidebar.

Context

The Help Glyph appears in the Meta Bar.

Rules

Accessibility

The aria-label MUST be 'Help'.

Example 1: Help

Active
Inactive
Highlighted

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Symbol\Glyph\Help;
 
function help()
{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    $glyph = $f->symbol()->glyph()->help("#");
 
    //Showcase the various states of this Glyph
    $list = $f->listing()->descriptive([
        "Active" => $glyph,
        "Inactive" => $glyph->withUnavailableAction(),
        "Highlighted" => $glyph->withHighlight()
    ]);
 
    return $renderer->render($list);
}

Relations

Parents

UIComponent
Symbol
Glyph