Skip to content

AccountItem Type documentation

extends MenuItem
Deprecated: Use the new si-application-header instead.
Properties
A function that will be invoked when clicking on the menu item. When passed as a string, use together with SiLinkActionService to receive events. This is meant for repetitive things in lists/tables/etc.
action?: (string | (param: any) => any) from MenuItem.action
The status (success, info, warning, caution, danger, critical, pending, progress) to be visualized.
avatarStatus?: EntityStatusType
aria-label for avatar status
avatarStatusAriaLabel?: TranslatableString
Defines the content of the optional badge. Should be a number or something like "100+". if undefined or empty string, no badge is displayed
badge?: (string | number) from MenuItem.badge
Defines the background color of the badge. Default is specific to Element flavour.
badgeColor?: string from MenuItem.badgeColor
Show a dot badge without content?
badgeDot?: boolean from MenuItem.badgeDot
Defines the badge style
badgeStyle?: ("" | "inline" | "dot") from MenuItem.badgeStyle
Name of the Company
company?: string
Defines if custom content is chosen in account dropdown (otherwise accountItems are used)
customContent?: boolean from MenuItem.customContent
A boolean that lets the link know whether it is disabled or not.
disabled?: boolean from MenuItem.disabled
Whether the menu items sub-menu should open upwards instead of downwards.
dropUpwards?: boolean from MenuItem.dropUpwards
Email address of the user
email?: string
If the menu item has children you can specify if they are visible or not.
expanded?: boolean from MenuItem.expanded
Defines a href URI that the menu item will be linked to. Will be used to set the href attribute of the a element. Will only be used if link and function is not set.
href?: string from MenuItem.href
The web font icon class name (e.g. element-settings-outline).
icon?: string from MenuItem.icon
Defines if only the icon is shown in the default navigation bar.
iconOnly?: boolean from MenuItem.iconOnly
An optional id to uniquely identify the menu item.
id?: string from MenuItem.id
The value for an image src tag. Maybe a relative or absolute link to an jpg or gif image.
image?: string from MenuItem.image
Initials to be displayed as avatar if no icon and also no image are provided. If also no initials are provided, they will be automatically calculated from the title .
initials?: string
A boolean that lets the link know whether it is active or not. It is useful when action() is executed instead of link route.
isActive?: boolean from MenuItem.isActive
Whether the menu item should be displayed as a heading/title, will also disable links and actions.
isHeading?: boolean from MenuItem.isHeading
A navigation bar item can have a sub-menu, if these items are set. They define the sub-menu content.
items?: MenuItem[] from MenuItem.items
The navigation extras provide additional routing options when using the router link.
navigationExtras?: NavigationExtras from MenuItem.navigationExtras
Role name shown as a badge in the bottom
role?: string
For single/multi choice items: the kind of icon to show.
selectionState?: ("" | "check" | "radio") from MenuItem.selectionState
The target attribute specifies where to open the linked document. If no target is specified, the link will open in the current tab.
target?: string from MenuItem.target
Full name of user
title: string
The optional tooltip of the link. Can be either the text to be displayed or the translation key.
tooltip?: TranslatableString from MenuItem.tooltip
Type to distinguish between check and radio menu items. Needs to be set for correct interaction and used for a11y.
type?: ("check" | "radio") from MenuItem.type

Types Documentation

Represents a translatable string. This can either be a translation key, e.g. ACTIONS.EDIT that will be automatically translated when displayed on the UI or a pre-translated string, e.g. Edit . Equivalent to a normal string in usage and functionality.
Translatable
import
("success" | "info" | "warning" | "danger" | "caution" | "critical")

Except where otherwise noted, content on this site is licensed under MIT License.