dothtml-interfaces 0.3.11 → 0.3.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dothtml-interfaces",
-  "version": "0.3.11",
+  "version": "0.3.13",
   "description": "Dependency injection interfaces for DOTHtml.",
   "main": "src/index.d.ts",
   "types": "src/index.d.ts",

package/src/i-component.d.ts

@@ -1,5 +1,5 @@
 
-import { IDotDocument } from "./i-dot";
+import { IDotCore, IDotDocument } from "./i-dot";
 import IDotCss from "./styles/i-dot-css";
 
 // export type EventNames<T> = T extends { allowedEvents: infer E } ? E : never;
@@ -44,31 +44,41 @@ export default interface IComponent/*<TProps extends Array<string> = [], TEvents
 
 	/**
 	 * A function returning DOThtml (required). The `build` hook is called once per component instance, and constructs the component's virtual DOM.
-	 */
-    build(): IDotDocument;
+	 * @param dot - The DOThtml core object passed in for DI purposes. You can also just use the main .
+	 * @returns The DOThtml document representing the component's virtual DOM.	 */
+    build(dot: IDotCore): IDotDocument;
 
 	/**
-	 * An optional function that gets called before the component is created, scoped to the new component object.
+	 * An optional function called after the component is built. Is only called once per component instance. 
+	 */
+    built?(): void;
+	
+	/**
+	 * An optional function that gets called before the component is mounted.
 	 */
-    creating?(): void;
+    mounting?(): void;
 
 	/**
 	 * An optional function called after the element has been mounted. May be called mulitple times if the component is rerendered.
 	 */
     mounted?(): void;
-
+	
 	/**
-	 * An optional function called before the component is deleted.
+	 * An optional function that gets called before the component is unmounted. Use it to do custom cleanup or data saving.
 	 */
-    deleting?(): void;
+    unmounting?(): void;
 
 	/**
-	 * An optional function called after the component is deleted.
+	 * An optional function called after the element has been unmounted. May be called mulitple times if the component is rerendered.
 	 */
-    deleted?(): void;
+    unmounted?(): void;
 
 	/**
-	 * An optional function called after the component is built. Is only called once per component instance. 
+	 * A function that returns a string containing CSS rules to be applied to all instances of the component.
+	 * It will only be called exactly once per component. We use a function so that you can return a potentially 
+	 * large string containing CSS without introducing a memory leak. The reason it's not static is so that 
+	 * it will work in JavaScript, and because static members are not valid in DI interfaces.
+	 * @returns A string containing CSS rules.
 	 */
-    built?(): void;
+	stylize?(): string;
 }