2022-02-24 16:23:22 +00:00
|
|
|
// (C) Copyright 2015 Moodle Pty Ltd.
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
|
2022-03-11 11:42:44 +00:00
|
|
|
import { Component } from '@angular/core';
|
2023-01-25 09:34:13 +00:00
|
|
|
import { AsyncDirective } from '@classes/async-directive';
|
2023-02-21 10:51:15 +00:00
|
|
|
import { CoreDirectivesRegistry } from '@singletons/directives-registry';
|
2022-03-11 11:42:44 +00:00
|
|
|
|
2022-02-24 16:23:22 +00:00
|
|
|
/**
|
|
|
|
* Registry to keep track of component instances.
|
2023-01-25 09:34:13 +00:00
|
|
|
*
|
|
|
|
* @deprecated since 4.1.1. Use CoreDirectivesRegistry instead.
|
2022-02-24 16:23:22 +00:00
|
|
|
*/
|
|
|
|
export class CoreComponentsRegistry {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Register a component instance.
|
|
|
|
*
|
|
|
|
* @param element Root element.
|
|
|
|
* @param instance Component instance.
|
|
|
|
*/
|
|
|
|
static register(element: Element, instance: unknown): void {
|
2023-02-21 10:51:15 +00:00
|
|
|
CoreDirectivesRegistry.register(element, instance);
|
2022-02-24 16:23:22 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Resolve a component instance.
|
|
|
|
*
|
|
|
|
* @param element Root element.
|
|
|
|
* @param componentClass Component class.
|
|
|
|
* @returns Component instance.
|
|
|
|
*/
|
2022-03-16 12:49:58 +00:00
|
|
|
static resolve<T>(element?: Element | null, componentClass?: ComponentConstructor<T>): T | null {
|
2023-02-21 10:51:15 +00:00
|
|
|
return CoreDirectivesRegistry.resolve(element, componentClass);
|
2022-02-24 16:23:22 +00:00
|
|
|
}
|
|
|
|
|
2022-03-08 16:39:22 +00:00
|
|
|
/**
|
|
|
|
* Get a component instances and fail if it cannot be resolved.
|
|
|
|
*
|
|
|
|
* @param element Root element.
|
|
|
|
* @param componentClass Component class.
|
|
|
|
* @returns Component instance.
|
|
|
|
*/
|
|
|
|
static require<T>(element: Element, componentClass?: ComponentConstructor<T>): T {
|
2023-02-21 10:51:15 +00:00
|
|
|
return CoreDirectivesRegistry.require(element, componentClass);
|
2022-03-08 16:39:22 +00:00
|
|
|
}
|
|
|
|
|
2022-03-11 11:42:44 +00:00
|
|
|
/**
|
2022-03-16 12:49:58 +00:00
|
|
|
* Get a component instances and wait to be ready.
|
2022-03-11 11:42:44 +00:00
|
|
|
*
|
2022-03-16 12:49:58 +00:00
|
|
|
* @param element Root element.
|
|
|
|
* @param componentClass Component class.
|
2022-12-01 11:31:00 +00:00
|
|
|
* @returns Promise resolved when done.
|
2022-03-11 11:42:44 +00:00
|
|
|
*/
|
2023-01-25 09:34:13 +00:00
|
|
|
static async waitComponentReady<T extends AsyncDirective>(
|
2022-03-16 12:49:58 +00:00
|
|
|
element: Element | null,
|
|
|
|
componentClass?: ComponentConstructor<T>,
|
2022-03-11 11:42:44 +00:00
|
|
|
): Promise<void> {
|
2023-02-21 10:51:15 +00:00
|
|
|
return CoreDirectivesRegistry.waitDirectiveReady(element, componentClass);
|
2022-03-16 12:49:58 +00:00
|
|
|
}
|
2022-03-11 11:42:44 +00:00
|
|
|
|
2022-03-16 12:49:58 +00:00
|
|
|
/**
|
|
|
|
* Waits all elements matching to be ready.
|
|
|
|
*
|
|
|
|
* @param element Element where to search.
|
|
|
|
* @param selector Selector to search on parent.
|
|
|
|
* @param componentClass Component class.
|
2022-12-01 11:31:00 +00:00
|
|
|
* @returns Promise resolved when done.
|
2022-03-16 12:49:58 +00:00
|
|
|
*/
|
2023-01-25 09:34:13 +00:00
|
|
|
static async waitComponentsReady<T extends AsyncDirective>(
|
2022-03-16 12:49:58 +00:00
|
|
|
element: Element,
|
|
|
|
selector: string,
|
|
|
|
componentClass?: ComponentConstructor<T>,
|
|
|
|
): Promise<void> {
|
2023-02-21 10:51:15 +00:00
|
|
|
return CoreDirectivesRegistry.waitDirectivesReady(element, selector, componentClass);
|
2022-03-11 11:42:44 +00:00
|
|
|
}
|
|
|
|
|
2022-02-24 16:23:22 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Component constructor.
|
|
|
|
*/
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
2022-03-16 12:49:58 +00:00
|
|
|
export type ComponentConstructor<T = Component> = { new(...args: any[]): T };
|