@microsoft/windows-admin-center-sdk/angular/src/controls/summary/summary-item.d.ts

Microsoft - Windows Admin Center Shell

import { StatusIconType } from '../icon/layered-icon/status/status-icon.component';
export interface SummaryItemOptions {
    /**
     * It indicates whether the summary item is async.
     */
    isAsync?: boolean;
    /**
     * The link for the summary item.
     */
    link?: string;
    /**
     * The link fragment for the summary item.
     */
    fragment?: string;
    /**
     * The link query params for the summary item.
     */
    queryParams?: {
        [key: string]: string;
    };
    /**
     * It indicates whether the summary item is external link.
     */
    isExternalLink?: boolean;
    /**
     * The plain string content for value when value is link or action.
     */
    prefixString?: string;
    /**
     * It indicates the action for the summary item.
     */
    action?: MsftSme.Action1<SummaryItem>;
    /**
     * The tooltip for the summary item.
     */
    tooltip?: string;
    /**
     * The icon class for the summary item.
     */
    iconClass?: string;
    /**
     * The status for the summary item.
     */
    status?: StatusIconType.Bindable;
    /**
     * It indicates whether the summary item is loading.
     * This parameter has to have isAsync set to true to use.
     */
    loading?: boolean;
}
export declare class SummaryItem {
    options: SummaryItemOptions;
    /**
     * The internal value/context for the summary item.
     */
    private internalValue;
    /**
     * The label for the summary item.
     */
    label: string;
    /**
     * The plain string content for value when value is link or action.
     */
    prefixString: string;
    /**
     * The setter for value/context.
     */
    set value(input: any);
    /**
     * The getter for value/context.
     */
    get value(): any;
    /**
     * It indicates the action for the summary item.
     */
    action: MsftSme.Action1<SummaryItem>;
    /**
     * The link for the summary item.
     */
    link: string;
    /**
     * The link query params for the summary item.
     */
    fragment: string;
    /**
     * The link query params for the summary item.
     */
    queryParams: {
        [key: string]: string;
    };
    /**
     * The tooltip for the summary item.
     */
    tooltip: string;
    /**
     * It indicates whether the summary item is external link.
     */
    isExternalLink: boolean;
    /**
     * The icon class for the summary item.
     */
    iconClass: string;
    /**
     * The status for the summary item.
     */
    status: StatusIconType.Bindable;
    /**
     * It indicates the rendering of loading wheel when data unloaded.
     */
    isAsync: boolean;
    /**
     * It indicates whether the summary item is loading.
     * This parameter has to have isAsync set to true to use.
     */
    loading: boolean;
    constructor(label: string, value: string, options?: SummaryItemOptions);
    /**
     * Gets the status class to apply to this components value section
     */
    get statusClass(): string;
    /**
     * Give the ability to reset loading.
     */
    resetLoading(): void;
}