@akveo/nga-theme/components/user/user.component.d.ts

@akveo/nga-theme

/**
 * @license
 * Copyright Akveo. All Rights Reserved.
 * Licensed under the MIT License. See License.txt in the project root for license information.
 */
import { EventEmitter, ElementRef } from '@angular/core';
export declare class NgaUserMenuItem {
    /**
     * Menu title
     * @type string
     */
    title: string;
    /**
     * Menu link for [routerLink] directive
     * @type string
     */
    link?: string;
    /**
     * URL for absolute urls, used directly in href
     * @type string
     */
    url?: string;
    /**
     * Link target (_blank, _self, etc)
     * @type string
     */
    target?: string;
    /**
     * Icon class
     * @type string
     */
    icon?: string;
}
/**
 * Represents a component showing a user avatar (picture) with a user name on the right.
 *
 * Can be used as a user profile link or can bring a user context menu.
 *
 * @theme
 * $nga-user-size-small: 1.5rem !default;
 * $nga-user-size-medium: 3rem !default;
 * $nga-user-size-large: 4rem !default;
 * $nga-user-picture-background: $nga-color-gray !default;
 * $nga-user-menu-border: $nga-border-color !default;
 */
export declare class NgaUserComponent {
    private el;
    static readonly SIZE_SMALL: string;
    static readonly SIZE_MEDIUM: string;
    static readonly SIZE_LARGE: string;
    static readonly SIZE_XLARGE: string;
    private sizeValue;
    inverseValue: boolean;
    readonly small: boolean;
    readonly medium: boolean;
    readonly large: boolean;
    readonly xlarge: boolean;
    /**
     * Specifies a name to be shown on the right of a user picture
     * @type string
     */
    name: string;
    /**
     * Specifies a title (written in a smaller font) to be shown under the **name**
     * @type string
     */
    title: string;
    /**
     * Absolute path to a user picture
     * User name initials (JD for John Doe) will be shown if no picture specified
     * @type string
     */
    picture: string;
    /**
     * Color of the area shown when no picture specified
     * @type string
     */
    color: string;
    /**
     * List of menu items for a user context menu (shown when clicked)
     * @type NgaUserMenuItem[]
     */
    menu: NgaUserMenuItem[];
    /**
     * Size of the component, small|medium|large
     * @type string
     */
    size: string;
    /**
     * Whether to show a user name or not
     * @type boolean
     */
    showName: boolean;
    /**
     * Whether to show a user title or not
     * @type boolean
     */
    showTitle: boolean;
    /**
     * Whether to show a user initials (if no picture specified) or not
     * @type boolean
     */
    showInitials: boolean;
    /**
     * Whether to show only a picture or also show the name and title
     * @type boolean
     */
    onlyPicture: boolean;
    /**
     * Makes colors inverse based on current theme
     * @type boolean
     */
    inverse: boolean;
    /**
     * Outputs when a context menu item is clicked
     * @type EventEmitter<NgaUserMenuItem>
     */
    menuClick: EventEmitter<NgaUserMenuItem>;
    showNameValue: boolean;
    showTitleValue: boolean;
    showInitialsValue: boolean;
    isMenuShown: boolean;
    constructor(el: ElementRef);
    itemClick(event: any, item: NgaUserMenuItem): boolean;
    /**
     * Toggles a context menu
     */
    toggleMenu(): void;
    hideMenu(event: any): void;
    getInitials(): string;
    hasMenu(): boolean;
}