Documentation

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

Logout

Description

Purpose: The Logout Glyph is used to trigger the logout interaction. It is displayed in the Slate triggered by clicking on the User Avatar in the Meta Bar.
Composition: The Logout Glyph uses the logout glyph from the il-icons font.
Effect: Clicking this Glyph will trigger the interaction to logout.

Context

The Logout Glyph appears in the Slate triggered by clicking on the User Avatar in the Meta Bar.

Rivals

Login Glyph: The Login Glyph triggers the login interaction.

Rules

Usage

The Logout Glyph MUST be displayed if the user is logged in.

Accessibility

The aria-label MUST be 'Logout'.

Example 1: Logout

Active
Inactive
Highlighted

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