@microsoft/windows-admin-center-sdk
Version:
Microsoft - Windows Admin Center Shell
92 lines (91 loc) • 3.78 kB
TypeScript
import { EventEmitter, Injector, OnDestroy, OnInit } from '@angular/core';
import { CoreBaseComponent } from '../common/base.component';
import * as i0 from "@angular/core";
export declare enum LoadingWheelSize {
ExtraSmall = "extra-small",
Small = "small",
Medium = "medium",
Large = "large",
Default = "large"
}
export declare module LoadingWheelSize {
type Bindable = LoadingWheelSize | 'extra-small' | 'small' | 'medium' | 'large';
function fromBindableType(value: Bindable): LoadingWheelSize;
function toProgressClass(size: LoadingWheelSize): string;
}
/**
* @smeDoc {@label Loading Wheel @id sme-loading-wheel}
*
* @overview
* @file {@filepath ./examples/loading-wheel-overview.md}
*
* @example {@label Small loading wheel example @id small-loading-wheel}
* @file {@filename small-loading-wheel-example.html @filepath ./examples/small-loading-wheel-example.html }
* @file {@filename small-loading-wheel-example.ts @filepath ./examples/small-loading-wheel-example.ts }
* @file {@filename loading-wheel-example.module.ts @filepath ./examples/loading-wheel-example.module.ts }
*
* @example {@label Large loading wheel example @id large-loading-wheel}
* @file {@filename large-loading-wheel-example.html @filepath ./examples/large-loading-wheel-example.html }
* @file {@filename large-loading-wheel-example.ts @filepath ./examples/large-loading-wheel-example.ts }
* @file {@filename loading-wheel-example.module.ts @filepath ./examples/loading-wheel-example.module.ts }
*/
export declare class LoadingWheelComponent extends CoreBaseComponent implements OnDestroy, OnInit {
/**
* The source name to use for logging
*/
protected get logSourceName(): string;
/**
* The event fired when the button is clicked.
*/
buttonClick: EventEmitter<void>;
/**
* The message to be displayed on the loading wheel.
*/
message: string;
/**
* The class to be applied to the message, multiple classes should be passed in with space separator.
*/
messageClass: string;
/**
* It determines whether the message is inline with the spinner wheel.
*/
messageInline: boolean;
/**
* It determines whether the loading wheel is whole page or inline.
*/
inline: boolean;
/**
* The label to be displayed on the button/link.
*/
buttonLabel: string;
/**
* It determines whether the background for the loading wheel is transparent.
*/
isBackgroundTransparent: boolean;
/**
* It determines the size of the loading wheel.
*/
size: LoadingWheelSize.Bindable;
get sizeClass(): string;
private initialSize;
constructor(injector: Injector);
/**
* The method run when the component is initialized
*/
ngOnInit(): void;
/**
* Destroy resources.
*/
ngOnDestroy(): void;
/**
* Adjust loading wheel size if its container is smaller than the inputted size
*/
private onLayoutChanged;
/**
* Creates the idBag used by this component to store unique element ids.
* id values will be assigned be the @see BaseComponent super class.
*/
protected createIdBag(): MsftSme.StringMap<string>;
static ɵfac: i0.ɵɵFactoryDeclaration<LoadingWheelComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<LoadingWheelComponent, "sme-loading-wheel", never, { "message": "message"; "messageClass": "messageClass"; "messageInline": "messageInline"; "inline": "inline"; "buttonLabel": "buttonLabel"; "isBackgroundTransparent": "isBackgroundTransparent"; "size": "size"; }, { "buttonClick": "buttonClick"; }, never, never, false, never>;
}