@ui5/webcomponents-base 0.0.0-7d5f73b20 → 0.0.0-7d8c57f70

package/dist/UI5Element.d.ts

@@ -1,8 +1,17 @@
+import "@ui5/webcomponents-base/dist/ssr-dom.js";
 import UI5ElementMetadata, { Slot, SlotValue, State, PropertyValue, Metadata } from "./UI5ElementMetadata.js";
 import EventProvider from "./EventProvider.js";
 import StaticAreaItem from "./StaticAreaItem.js";
-import { TemplateFunction, TemplateFunctionResult } from "./renderer/executeTemplate.js";
-import { PromiseResolve, ComponentStylesData, ClassMap } from "./types.js";
+import type { TemplateFunction, TemplateFunctionResult } from "./renderer/executeTemplate.js";
+import type { AccessibilityInfo, PromiseResolve, ComponentStylesData, ClassMap } from "./types.js";
+type Renderer = (templateResult: TemplateFunctionResult, container: HTMLElement | DocumentFragment, styleStrOrHrefsArr: string | Array<string> | undefined, forStaticArea: boolean, options: RendererOptions) => void;
+type RendererOptions = {
+    /**
+     * An object to use as the `this` value for event listeners. It's often
+     * useful to set this to the host component rendering a template.
+     */
+    host?: object;
+};
 type ChangeInfo = {
     type: "property" | "slot";
     name: string;
@@ -18,12 +27,9 @@ type InvalidationInfo = ChangeInfo & {
 type ChildChangeListener = (param: InvalidationInfo) => void;
 type SlotChangeListener = (this: HTMLSlotElement, ev: Event) => void;
 /**
+ * @class
  * Base class for all UI5 Web Components
  *
- * @class
- * @constructor
- * @author SAP SE
- * @alias sap.ui.webc.base.UI5Element
  * @extends HTMLElement
  * @public
  */
@@ -31,7 +37,8 @@ declare abstract class UI5Element extends HTMLElement {
     __id?: string;
     _suppressInvalidation: boolean;
     _changedState: Array<ChangeInfo>;
-    _eventProvider: EventProvider<InvalidationInfo, void>;
+    _invalidationEventProvider: EventProvider<InvalidationInfo, void>;
+    _componentStateFinalizedEventProvider: EventProvider<void, void>;
     _inDOM: boolean;
     _fullyConnected: boolean;
     _childChangeListeners: Map<string, ChildChangeListener>;
@@ -41,15 +48,16 @@ declare abstract class UI5Element extends HTMLElement {
     };
     _doNotSyncAttributes: Set<string>;
     _state: State;
-    _onComponentStateFinalized?: () => void;
     _getRealDomRef?: () => HTMLElement;
     staticAreaItem?: StaticAreaItem;
     static template?: TemplateFunction;
     static staticAreaTemplate?: TemplateFunction;
     static _metadata: UI5ElementMetadata;
-    static render: (templateFunctionResult: TemplateFunctionResult, container: HTMLElement | DocumentFragment, styleStrOrHrefsArr: string | Array<string> | undefined, forStaticArea: boolean, options: {
-        host: HTMLElement;
-    }) => void;
+    /**
+     * @deprecated
+     */
+    static render: Renderer;
+    static renderer?: Renderer;
     constructor();
     /**
      * Returns a unique ID for this UI5 Element
@@ -58,6 +66,8 @@ declare abstract class UI5Element extends HTMLElement {
      * @protected
      */
     get _id(): string;
+    render(): object;
+    renderStatic(): object;
     /**
      * Do not call this method from derivatives of UI5Element, use "onEnterDOM" only
      * @private
@@ -113,22 +123,22 @@ declare abstract class UI5Element extends HTMLElement {
     /**
      * Attach a callback that will be executed whenever the component is invalidated
      *
-     * @param {InvalidationInfo} callback
+     * @param callback
      * @public
      */
     attachInvalidate(callback: (param: InvalidationInfo) => void): void;
     /**
      * Detach the callback that is executed whenever the component is invalidated
      *
-     * @param {InvalidationInfo} callback
+     * @param callback
      * @public
      */
     detachInvalidate(callback: (param: InvalidationInfo) => void): void;
     /**
      * Callback that is executed whenever a monitored child changes its state
      *
-     * @param {sting} slotName the slot in which a child was invalidated
-     * @param { ChangeInfo } childChangeInfo the changeInfo object for the child in the given slot
+     * @param slotName the slot in which a child was invalidated
+     * @param childChangeInfo the changeInfo object for the child in the given slot
      * @private
      */
     _onChildChange(slotName: string, childChangeInfo: ChangeInfo): void;
@@ -153,15 +163,13 @@ declare abstract class UI5Element extends HTMLElement {
      * Returns a singleton event listener for the "change" event of a child in a given slot
      *
      * @param slotName the name of the slot, where the child is
-     * @returns {ChildChangeListener}
      * @private
      */
-    _getChildChangeListener(slotName: string): ChildChangeListener | undefined;
+    _getChildChangeListener(slotName: string): ChildChangeListener;
     /**
      * Returns a singleton slotchange event listener that invalidates the component due to changes in the given slot
      *
      * @param slotName the name of the slot, where the slot element (whose slotchange event we're listening to) is
-     * @returns {SlotChangeListener}
      * @private
      */
     _getSlotChangeListener(slotName: string): SlotChangeListener;
@@ -245,7 +253,7 @@ declare abstract class UI5Element extends HTMLElement {
     getFocusDomRefAsync(): Promise<HTMLElement | undefined>;
     /**
      * Set the focus to the element, returned by "getFocusDomRef()" (marked by "data-sap-focus-ref")
-     * @param {FocusOptions} focusOptions additional options for the focus
+     * @param focusOptions additional options for the focus
      * @public
      */
     focus(focusOptions?: FocusOptions): Promise<void>;
@@ -256,7 +264,7 @@ declare abstract class UI5Element extends HTMLElement {
      * @param data - additional data for the event
      * @param cancelable - true, if the user can call preventDefault on the event object
      * @param bubbles - true, if the event bubbles
-     * @returns {boolean} false, if the event was cancelled (preventDefault called), true otherwise
+     * @returns false, if the event was cancelled (preventDefault called), true otherwise
      */
     fireEvent<T>(name: string, data?: T, cancelable?: boolean, bubbles?: boolean): boolean;
     _fireEvent<T>(name: string, data?: T, cancelable?: boolean, bubbles?: boolean): boolean;
@@ -265,22 +273,41 @@ declare abstract class UI5Element extends HTMLElement {
      * Useful when there are transitive slots in nested component scenarios and you don't want to get a list of the slots, but rather of their content.
      * @public
      */
-    getSlottedNodes(slotName: string): Node[];
+    getSlottedNodes<T = Node>(slotName: string): Array<T>;
+    /**
+     * Attach a callback that will be executed whenever the component's state is finalized
+     *
+     * @param callback
+     * @public
+     */
+    attachComponentStateFinalized(callback: () => void): void;
+    /**
+     * Detach the callback that is executed whenever the component's state is finalized
+     *
+     * @param callback
+     * @public
+     */
+    detachComponentStateFinalized(callback: () => void): void;
     /**
      * Determines whether the component should be rendered in RTL mode or not.
      * Returns: "rtl", "ltr" or undefined
      *
      * @public
-     * @returns {String|undefined}
+     * @default undefined
      */
     get effectiveDir(): string | undefined;
     /**
      * Used to duck-type UI5 elements without using instanceof
-     * @returns {boolean}
      * @public
+     * @default true
      */
     get isUI5Element(): boolean;
     get classes(): ClassMap;
+    /**
+     * Returns the component accessibility info.
+     * @private
+     */
+    get accessibilityInfo(): AccessibilityInfo;
     /**
      * Do not override this method in derivatives of UI5Element, use metadata properties instead
      * @private
@@ -306,17 +333,12 @@ declare abstract class UI5Element extends HTMLElement {
      * Returns the metadata object for this UI5 Web Component Class
      * @protected
      */
-    static get metadata(): Metadata;
-    /**
-     * Sets a new metadata object for this UI5 Web Component Class
-     * @protected
-     */
-    static set metadata(newMetadata: Metadata);
+    static metadata: Metadata;
     /**
      * Returns the CSS for this UI5 Web Component Class
      * @protected
      */
-    static get styles(): ComponentStylesData;
+    static styles: ComponentStylesData;
     /**
      * Returns the Static Area CSS for this UI5 Web Component Class
      * @protected
@@ -330,45 +352,39 @@ declare abstract class UI5Element extends HTMLElement {
      * @protected
      */
     static get dependencies(): Array<typeof UI5Element>;
+    static cacheUniqueDependencies(this: typeof UI5Element): void;
     /**
      * Returns a list of the unique dependencies for this UI5 Web Component
      *
      * @public
      */
-    static getUniqueDependencies(this: typeof UI5Element): (typeof UI5Element)[];
+    static getUniqueDependencies(this: typeof UI5Element): Array<typeof UI5Element>;
     /**
      * Returns a promise that resolves whenever all dependencies for this UI5 Web Component have resolved
-     *
-     * @returns {Promise}
      */
     static whenDependenciesDefined(): Promise<Array<typeof UI5Element>>;
     /**
      * Hook that will be called upon custom element definition
      *
      * @protected
-     * @returns {Promise<void>}
      */
     static onDefine(): Promise<void>;
     /**
      * Registers a UI5 Web Component in the browser window object
      * @public
-     * @returns {Promise<UI5Element>}
      */
     static define(): Promise<typeof UI5Element>;
     /**
      * Returns an instance of UI5ElementMetadata.js representing this UI5 Web Component's full metadata (its and its parents')
      * Note: not to be confused with the "get metadata()" method, which returns an object for this class's metadata only
      * @public
-     * @returns {UI5ElementMetadata}
      */
     static getMetadata(): UI5ElementMetadata;
-    static decoratorMetadata: Metadata;
 }
 /**
  * Always use duck-typing to cover all runtimes on the page.
- * @returns {boolean}
  */
 declare const instanceOfUI5Element: (object: any) => object is UI5Element;
 export default UI5Element;
 export { instanceOfUI5Element };
-export type { ChangeInfo };
+export type { ChangeInfo, Renderer, RendererOptions, };