Documentation

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

Filter

Description

Purpose: The Filter Glyph is used to trigger a filter action.
Composition: The Filter Glyph uses the glyphicon-filter.
Effect: Clicking this glyph will filter a list of entries.

Context

The Filter Glyph appears in the Who-is-online-Tool.

Rivals

Search Glyph: The Search Glyph will open a search dialog or will generate a list of entries according to the search input.

Rules

Accessibility

The aria-label MUST be 'Filter'.

Example 1: Filter

Active
Inactive
Highlighted

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