Documentation

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

Settings

Description

Purpose: The Settings Glyph triggers the opening of a dropdown that allows to edit settings of the displayed block.
Composition: The Settings Glyph uses the glyphicon-cog.
Effect: Upon clicking, a settings Dropdown is opened.

Rules

Usage

The Settings Glyph MUST only be used in Blocks.

Accessibility

The aria-label MUST be “Settings”.

Example 1: Settings

Active
Inactive
Highlighted

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Symbol\Glyph\Settings;
 
function settings()
{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    $glyph = $f->symbol()->glyph()->settings("#");
 
    //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