Documentation

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

Header

Description

Purpose: The Heading Glyph indicates the intention of an action in an e.g. link or button, which transforms some text from or into a heading.
Composition: The Heading Glyph is composed of the letter H.
Effect: Clicking the Heading Glyph may insert or transform some text into a heading.

Context

Appears in the markdown-actions.

Rivals

Bold Glyph: should be used if the transformation should be bold.
Italic Glyph: should be used if the transformation should be italic.
Link Glyph: should be used if the transformation should be a link.

Rules

Accessibility

The aria-label MUST be ‘Insert Heading'.

Example 1: Header

Active
Inactive
Highlighted

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Symbol\Glyph\Header;
 
function header()
{
    global $DIC;
 
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    $glyph = $factory->symbol()->glyph()->header("#");
 
    // showcase the various states of this Glyph
    $list = $factory->listing()->descriptive([
        "Active" => $glyph,
        "Inactive" => $glyph->withUnavailableAction(),
        "Highlighted" => $glyph->withHighlight()
    ]);
 
    return $renderer->render($list);
}

Relations

Parents

UIComponent
Symbol
Glyph