src/app/core/ui/navigation/menu-item.ts

Description

An alternative MenuItem details of an entry in the main navigation.

Extends

MenuItem

Relationships

Used by

No results matching.

Depends on

Index

Properties

Properties

entityType
entityType: string
Type : string

The entity type to whose list this item should link.

subMenu
subMenu: (MenuItem | EntityMenuItem)[]
Type : (MenuItem | EntityMenuItem)[]
Optional
icon
icon: string
Type : string
Optional

The icon to be displayed left of the label.

label
label: string
Type : string

The text to be displayed in the menu.

link
link: string
Type : string
Optional

The url fragment to which the item will route to (e.g. '/dashboard')

subtitle
subtitle: string
Type : string
Optional

Optional subtitle or description

export interface MenuItem {
  /**
   * The text to be displayed in the menu.
   */
  label: string;
  /**
   * Optional subtitle or description
   */
  subtitle?: string;
  /**
   * The icon to be displayed left of the label.
   */
  icon?: string;
  /**
   * The url fragment to which the item will route to (e.g. '/dashboard')
   */
  link?: string;

  subMenu?: MenuItem[];
}

/**
 * An alternative MenuItem details of an entry in the main navigation.
 */
export interface EntityMenuItem extends MenuItem {
  /**
   * The entity type to whose list this item should link.
   */
  entityType: string;

  subMenu?: (MenuItem | EntityMenuItem)[];
}

/**
 * Object specifying overall navigation menu
 * as stored in the config database
 */
export interface NavigationMenuConfig {
  items: MenuItem[];
}

results matching ""

    No results matching ""