dothtml 5.2.10 → 5.2.12

package/lib/component.d.ts

@@ -1,82 +1,93 @@
-import { IDotElement } from "./i-dot";
-import IDotCss from "./styling/i-dotcss";
-declare abstract class Component {
-    #private;
-    /**
-     * Called once per component, on the first build.
-     * TODO: this shouldn't require an instance of the component. Please experiment with fixing this.
-    */
-    static initializeComponent<T extends Component>(obj: T): void;
-    static build<T extends Component>(obj: T): HTMLElement;
-    /**
-     * Called any time the component needs to be completely rebuilt.
-    */
-    static rebuild<T extends Component>(obj: T): void;
-    static initializeEventHandlers(obj: any): void;
-    static createProp(activePropContainer: Function, name: string): void;
-    static configureDependency(cc: Component, name: string): void;
-    static updateProp(obj: Component, name: string): void;
-    constructor(...args: Array<any>);
-    /**
-     * A function returning DOThtml (required).
-     */
-    abstract builder(...args: Array<any>): IDotElement;
-    /**
-     *
-    */
-    props: {
-        [key: string]: any;
-    };
-    /**
-     * A series of events that can be raised from inside the component.
-     */
-    events: {
-        [key: string]: (...params: Array<any>) => void;
-    };
-    /**
-     * An optional function that gets called before the component is created, scoped to the new component object.
-     */
-    created(...args: Array<any>): void;
-    /**
-     * An optional function called after the element has been added. One parameter will be provided containing the added element.
-     */
-    ready(): void;
-    /**
-     * An optional function called before the component is deleted.
-     */
-    deleting(): void;
-    /**
-     * An optional function called after the component is deleted.
-     */
-    deleted(): void;
-    /**
-     * An optional function called after the component is built.
-     */
-    built(): void;
-    on(event: string, handler: Function): void;
-    off(event: string, handler: Function): void;
-    private __$el;
-    private __built;
-    private __stylesSet;
-    private __eventsInitialized;
-    private __propContainer;
-    private __args;
-    /**
-     * The main element of this component - automatically set after the builder is called.
-    */
-    get $el(): HTMLElement;
-    $refs: {
-        [key: string]: HTMLElement;
-    };
-    /**
-     * Name of the component (optional). If provided, dot and the VDBO will be extended.
-     */
-    name: string;
-    /**
-     * An optional function that is called after builder that stylizes the component using a scoped style builder.
-     */
-    style?(styleBuilder: IDotCss): void;
-    $styleBuilder?: Function;
-    $updateStyles(): void;
-}
-export default Component;
+import { IDotElement } from "./i-dot";
+import IDotCss from "./styling/i-dotcss";
+declare abstract class Component {
+    #private;
+    /**
+     * Called once per component, on the first build.
+     * TODO: this shouldn't require an instance of the component. Please experiment with fixing this.
+     * The issue with this is that simply declaring a class, it's not obvious how to run code.
+     * There are four options that come to mind:
+     * 1. We could find a way to call this upon declaration of the class (might not be possible).
+     * 2. Ignore the problem.
+     * 3. Call this per instance (possibly wasteful, but has some advantages, for instance, with polymorphic components).
+     * 4. Move to a completely different prop system that doesn't require this type of instantiation.
+    */
+    static initializeComponent<T extends Component>(obj: T): void;
+    static build<T extends Component>(obj: T): HTMLElement;
+    /**
+     * Called any time the component needs to be completely rebuilt.
+    */
+    static rebuild<T extends Component>(obj: T): void;
+    static initializeEventHandlers(obj: any): void;
+    static createProp(activePropContainer: Function, name: string): void;
+    static createBinding(ref: string, sample: Component): void;
+    static configureDependency(cc: Component, name: string): void;
+    static updateProp(obj: Component, name: string): void;
+    constructor(...args: Array<any>);
+    /**
+     * A function returning DOThtml (required).
+     */
+    abstract builder(...args: Array<any>): IDotElement;
+    /**
+     * A collection of properties that can be used for two-way bindings.
+    */
+    props: {
+        [key: string]: any;
+    };
+    /**
+     * A collection of properties that can be used for two-way bindings.
+    */
+    bindings: {
+        [key: string]: any;
+    };
+    /**
+     * A series of events that can be raised from inside the component.
+     */
+    events: Array<string>;
+    /**
+     * An optional function that gets called before the component is created, scoped to the new component object.
+     */
+    created(...args: Array<any>): void;
+    /**
+     * An optional function called after the element has been added. One parameter will be provided containing the added element.
+     */
+    ready(): void;
+    /**
+     * An optional function called before the component is deleted.
+     */
+    deleting(): void;
+    /**
+     * An optional function called after the component is deleted.
+     */
+    deleted(): void;
+    /**
+     * An optional function called after the component is built.
+     */
+    built(): void;
+    on(event: string, handler: Function): void;
+    off(event: string, handler: Function): void;
+    private __$el;
+    private __built;
+    private __stylesSet;
+    private __eventsInitialized;
+    private __propContainer;
+    private __args;
+    /**
+     * The main element of this component - automatically set after the builder is called.
+    */
+    get $el(): HTMLElement;
+    $refs: {
+        [key: string]: HTMLElement;
+    };
+    /**
+     * Name of the component (optional). If provided, dot and the VDBO will be extended.
+     */
+    name: string;
+    /**
+     * An optional function that is called after builder that stylizes the component using a scoped style builder.
+     */
+    style?(css: IDotCss): void;
+    $styleBuilder?: Function;
+    $updateStyles(): void;
+}
+export default Component;