Documentation

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

Search

Description

Purpose: The Search Glyph is used to trigger a search dialog.
Composition: The Search Glyph uses the glyphicon-search.
Effect: Clicking this glyph will open a search dialog. Since the context for the Search Glyph primarily is the Meta Bar, the according search dialog will be opened as Tool in the Main Bar.

Context

The Search Glyph appears in the Meta Bar.

Rules

Accessibility

The aria-label MUST be 'Search'.

Example 1: Search

Active
Inactive
Highlighted

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