Documentation

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

Apply

Description

Purpose: The Apply Glyph is used to indicate the possibilty of applying changes which the user has made within a control, i.e. a filter.
Composition: The Apply Glyph uses the glyphicon-ok.
Effect: Upon clicking, the page is reloaded immediately with the updated content reflected in the control. In case of a filter, it means that the entries in a table change in accordance with the filter values set by the user.

Rules

Usage

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

Style

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

Accessibility

The aria-label MUST be 'Apply'.

Example 1: Apply

Active
Inactive
Highlighted

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