Documentation

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

Reset

Description

Purpose: The Reset Glyph is used to indicate the possibilty of resetting changes made by the user within a control back to a previous state.
Composition: The Reset Glyph uses the glyphicon-repeat.
Effect: Upon clicking, the related control is reloaded immediately and goes back to state before the user changes.

Rules

Usage

The Reset Glyph SHOULD not come without an Apply Glyph and vice versa.
If there are no changes to reset, the Reset Glyph MUST be deactivated (or not be clickable).

Style

The deactivated state of the Reset Glyph MUST be visually noticeable for the user, i.e. by greying out the Reset Glyph.

Accessibility

The aria-label MUST be 'Reset'.

Example 1: Glyph reset

Active
Inactive
Highlighted

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