tw5-typed 0.2.10 → 0.2.12

package/package.json

@@ -2,7 +2,7 @@
   "description": "Types for tiddlywiki",
   "license": "MIT",
   "name": "tw5-typed",
-  "version": "0.2.10",
+  "version": "0.2.12",
   "url": "https://github.com/tiddly-gittly/tw5-typed",
   "homepage": "https://github.com/tiddly-gittly/tw5-typed",
   "bugs": {

package/src/widget.d.ts

@@ -64,6 +64,10 @@ declare module 'tiddlywiki' {
       @param parseTreeNodes default to `this.parseTreeNode.children`, can be undefined
     */
     makeChildWidgets(parseTreeNodes?: IParseTreeNode[], options?: { variables?: unknown }): void;
+    /*
+      Initialise widget properties. These steps are pulled out of the constructor so that we can reuse them in subclasses
+    */
+    initialise(parseTreeNode: IParseTreeNode, options?: { document?: Document; parentWidget?: Widget; wiki?: ITiddlyWiki }): void;
     /**
      * Remove any DOM nodes created by this widget or its children
      *
@@ -120,7 +124,7 @@ declare module 'tiddlywiki' {
      * @param event
      * @returns handled
      */
-    invokeAction: (triggeringWidget: Widget, event: IWidgetEvent) => boolean | undefined;
+    invokeAction(triggeringWidget: Widget, event: IWidgetEvent): boolean | undefined;
 
     /**
      * Lifecycle method: Render this widget into the DOM
@@ -199,4 +203,17 @@ declare module 'tiddlywiki' {
   export interface TW_TextNode extends Node {
     textContent: string;
   }
+
+  export interface ModalWidget {
+    new (wiki: Wiki): ModalWidget;
+    adjustPageClass(): void;
+    /**
+     *
+     * @param title
+     * @param options
+     * variables: optional hashmap of variables to wrap around the widget
+     * downloadLink: normally is used for "Right-click to save changes"
+     */
+    display(title: string, options?: { downloadLink?: string; event?: IWidgetEvent; variables?: unknown }): void;
+  }
 }