@microsoft/mgt
Version:
The Microsoft Graph Toolkit
69 lines (68 loc) • 2.37 kB
TypeScript
/**
* -------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License.
* See License in the project root for license information.
* -------------------------------------------------------------------------------------------
*/
import { LitElement, PropertyValues } from 'lit-element';
/**
* BaseComponent extends LitElement including ShadowRoot toggle and fireCustomEvent features
*
* @export MgtBaseComponent
* @abstract
* @class MgtBaseComponent
* @extends {LitElement}
*/
export declare abstract class MgtBaseComponent extends LitElement {
/**
* Get ShadowRoot toggle, returns value of _useShadowRoot
*
* @static _useShadowRoot
* @memberof MgtBaseComponent
*/
static get useShadowRoot(): boolean;
/**
* Set ShadowRoot toggle value
*
* @static _useShadowRoot
* @memberof MgtBaseComponent
*/
static set useShadowRoot(value: boolean);
private static _useShadowRoot;
constructor();
/**
* Receive ShadowRoot Disabled value
*
* @returns boolean _useShadowRoot value
* @memberof MgtBaseComponent
*/
isShadowRootDisabled(): boolean;
/**
* helps facilitate creation of events across components
*
* @protected
* @param {string} eventName name given to specific event
* @param {*} [detail] optional any value to dispatch with event
* @returns {boolean}
* @memberof MgtBaseComponent
*/
protected fireCustomEvent(eventName: string, detail?: any): boolean;
/**
* method to create ShadowRoot if disabled flag isn't present
*
* @protected
* @returns boolean
* @memberof MgtBaseComponent
*/
protected createRenderRoot(): Element | ShadowRoot;
/**
* Invoked whenever the element is updated. Implement to perform
* post-updating tasks via DOM APIs, for example, focusing an element.
*
* Setting properties inside this method will trigger the element to update
* again after this update cycle completes.
*
* * @param changedProperties Map of changed properties with old values
*/
protected updated(changedProperties: PropertyValues): void;
}