implab/implabjs-djx Files · src/main/ts/tsx/DjxWidgetBase.ts

* tsx/{Xxx}Context renamed to tsx/{Xxx}Rendition, for old types made...

* tsx/{Xxx}Context renamed to tsx/{Xxx}Rendition, for old types made compatibility stubs with @deprected comments * Improved handling of functional component output, added support for boolean, null, undefined and widgets. * RenditionBase: fixed startup for the DocumentFragment nodes * startupWidgets: fixed startup of the widget when passed domNode of the widget. * DjxFragment converted to the functional component

cin - - Load All Authors

File last commit:

r63:1a0018655d1c v1.1.0 default


                r63:1a0018655d1c

v1.1.0 default

Download file

             DjxWidgetBase.ts
        
                    88 lines
            
             | 3.2 KiB
            
                | video/mp2t
            
             |
                TypeScriptLexer
            
             / src / main / ts / tsx / DjxWidgetBase.ts
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        cin
    
sync

              r7
            
      import { djbase, djclass } from "../declare";

      import _WidgetBase = require("dijit/_WidgetBase");

      import _AttachMixin = require("dijit/_AttachMixin");

        cin
    
* tsx/{Xxx}Context renamed to tsx/{Xxx}Rendition, for old types made...

              r63
            
      import { Rendition, isNode, startupWidgets } from "./traits";

        cin
    
sync

              r7
            
      import registry = require("dijit/registry");

        cin
    
Working on dojo typings

              r15
            
      // type Handle = dojo.Handle;

        cin
    
sync

              r7
            
        cin
    
Added 'Attrs', 'Events' type parameters to DjxWidgetBase, typed 'on' and 'emit' methods

              r30
            
      export interface EventArgs {

          bubbles?: boolean;

          cancelable?: boolean;

          composed?: boolean;

      }

      export interface DjxWidgetBase<Attrs = any, Events extends { [name in keyof Events]: Event } = any> {

          set<K extends keyof Attrs & string>(key: K, value: Attrs[K]): this;

          set(props: Partial<Attrs>): this;

          get<K extends keyof Attrs & string>(key: K): Attrs[K];

          on<K extends keyof Events & string>(eventName: K, cb: (evt: Events[K]) => void): dojo.WatchHandle;

        cin
    
DjxWidgetBase: implemented copying content from srcNode to contentNode

              r57
            
          emit<K extends keyof Events & string>(eventName: K, evt: Omit<Events[K], keyof Event> & EventArgs): void;

        cin
    
Added 'Attrs', 'Events' type parameters to DjxWidgetBase, typed 'on' and 'emit' methods

              r30
            
      }

        cin
    
sync

              r7
            
      @djclass

        cin
    
Added 'Attrs', 'Events' type parameters to DjxWidgetBase, typed 'on' and 'emit' methods

              r30
            
      export abstract class DjxWidgetBase<Attrs = any, Events = any> extends djbase(_WidgetBase, _AttachMixin) {

        cin
    
sync

              r7
            
          buildRendering() {

        cin
    
Added DjxFragment...

              r19
            
              this.domNode = this.render().getDomNode();

        cin
    
sync

              r7
            
              super.buildRendering();

        cin
    
DjxWidgetBase: implemented copying content from srcNode to contentNode

              r57
            
              // now we should get assigned data-dojo-attach-points

              // place the contents of the original srcNode to the containerNode

              const src = this.srcNodeRef;

              const dest = this.containerNode;

              if (src && dest) {

                  while (src.firstChild)

                      dest.appendChild(src.firstChild);

              }

        cin
    
sync

              r7
            
          }

        cin
    
* tsx/{Xxx}Context renamed to tsx/{Xxx}Rendition, for old types made...

              r63
            
          abstract render(): Rendition<HTMLElement>;

        cin
    
sync

              r7
            
          _processTemplateNode<T extends (Element | Node | _WidgetBase)>(

              baseNode: T,

              getAttrFunc: (baseNode: T, attr: string) => string,

              // tslint:disable-next-line: ban-types

        cin
    
Switched to dojo-typings...

              r22
            
              attachFunc: (node: T, type: string, func?: Function) => dojo.Handle

        cin
    
sync

              r7
            
          ): boolean {

              if (isNode(baseNode)) {

                  const w = registry.byNode(baseNode);

                  if (w) {

                      // from dijit/_WidgetsInTemplateMixin

                      this._processTemplateNode(w,

                          (n, p) => n.get(p), // callback to get a property of a widget

                          (widget, type, callback) => {

                              if (!callback)

                                  throw new Error("The callback must be specified");

                              // callback to do data-dojo-attach-event to a widget

                              if (type in widget) {

                                  // back-compat, remove for 2.0

                                  return widget.connect(widget, type, callback as EventListener);

                              } else {

                                  // 1.x may never hit this branch, but it's the default for 2.0

                                  return widget.on(type, callback);

                              }

                          });

                      // don't process widgets internals

                      return false;

                  }

              }

              return super._processTemplateNode(baseNode, getAttrFunc, attachFunc);

          }

        cin
    
Fixed startup of DjxWidgetBase to start inner widgets...

              r52
            
          /** Starts current widget and all its supporting widgets (placed outside

        cin
    
DjxWidgetBase: implemented copying content from srcNode to contentNode

              r57
            
           * `containerNode`) and child widgets (placed inside `containerNode`)

           */

        cin
    
Fixed startup of DjxWidgetBase to start inner widgets...

              r52
            
          startup() {

              // startup supporting widgets

        cin
    
* tsx/{Xxx}Context renamed to tsx/{Xxx}Rendition, for old types made...

              r63
            
              registry.findWidgets(this.domNode, this.containerNode).forEach(w => w.startup());

        cin
    
Fixed startup of DjxWidgetBase to start inner widgets...

              r52
            
              super.startup();

          }

        cin
    
sync

              r7
            
      }

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

cin sync	r7	import { djbase, djclass } from "../declare";
		import _WidgetBase = require("dijit/_WidgetBase");
		import _AttachMixin = require("dijit/_AttachMixin");
cin * tsx/{Xxx}Context renamed to tsx/{Xxx}Rendition, for old types made...	r63	import { Rendition, isNode, startupWidgets } from "./traits";
cin sync	r7	import registry = require("dijit/registry");
cin Working on dojo typings	r15
		// type Handle = dojo.Handle;
cin sync	r7
cin Added 'Attrs', 'Events' type parameters to DjxWidgetBase, typed 'on' and 'emit' methods	r30	export interface EventArgs {
		bubbles?: boolean;

		cancelable?: boolean;

		composed?: boolean;
		}

		export interface DjxWidgetBase<Attrs = any, Events extends { [name in keyof Events]: Event } = any> {
		set<K extends keyof Attrs & string>(key: K, value: Attrs[K]): this;
		set(props: Partial<Attrs>): this;
		get<K extends keyof Attrs & string>(key: K): Attrs[K];

		on<K extends keyof Events & string>(eventName: K, cb: (evt: Events[K]) => void): dojo.WatchHandle;

cin DjxWidgetBase: implemented copying content from srcNode to contentNode	r57	emit<K extends keyof Events & string>(eventName: K, evt: Omit<Events[K], keyof Event> & EventArgs): void;
cin Added 'Attrs', 'Events' type parameters to DjxWidgetBase, typed 'on' and 'emit' methods	r30	}

cin sync	r7	@djclass
cin Added 'Attrs', 'Events' type parameters to DjxWidgetBase, typed 'on' and 'emit' methods	r30	export abstract class DjxWidgetBase<Attrs = any, Events = any> extends djbase(_WidgetBase, _AttachMixin) {
cin sync	r7
		buildRendering() {
cin Added DjxFragment...	r19	this.domNode = this.render().getDomNode();
cin sync	r7	super.buildRendering();
cin DjxWidgetBase: implemented copying content from srcNode to contentNode	r57
		// now we should get assigned data-dojo-attach-points
		// place the contents of the original srcNode to the containerNode
		const src = this.srcNodeRef;
		const dest = this.containerNode;

		if (src && dest) {
		while (src.firstChild)
		dest.appendChild(src.firstChild);
		}
cin sync	r7	}

cin * tsx/{Xxx}Context renamed to tsx/{Xxx}Rendition, for old types made...	r63	abstract render(): Rendition<HTMLElement>;
cin sync	r7
		_processTemplateNode<T extends (Element \| Node \| _WidgetBase)>(
		baseNode: T,
		getAttrFunc: (baseNode: T, attr: string) => string,
		// tslint:disable-next-line: ban-types
cin Switched to dojo-typings...	r22	attachFunc: (node: T, type: string, func?: Function) => dojo.Handle
cin sync	r7	): boolean {
		if (isNode(baseNode)) {
		const w = registry.byNode(baseNode);
		if (w) {
		// from dijit/_WidgetsInTemplateMixin
		this._processTemplateNode(w,
		(n, p) => n.get(p), // callback to get a property of a widget
		(widget, type, callback) => {
		if (!callback)
		throw new Error("The callback must be specified");

		// callback to do data-dojo-attach-event to a widget
		if (type in widget) {
		// back-compat, remove for 2.0
		return widget.connect(widget, type, callback as EventListener);
		} else {
		// 1.x may never hit this branch, but it's the default for 2.0
		return widget.on(type, callback);
		}

		});
		// don't process widgets internals
		return false;
		}
		}
		return super._processTemplateNode(baseNode, getAttrFunc, attachFunc);
		}
cin Fixed startup of DjxWidgetBase to start inner widgets...	r52
		/** Starts current widget and all its supporting widgets (placed outside
cin DjxWidgetBase: implemented copying content from srcNode to contentNode	r57	* `containerNode`) and child widgets (placed inside `containerNode`)
		*/
cin Fixed startup of DjxWidgetBase to start inner widgets...	r52	startup() {
		// startup supporting widgets
cin * tsx/{Xxx}Context renamed to tsx/{Xxx}Rendition, for old types made...	r63	registry.findWidgets(this.domNode, this.containerNode).forEach(w => w.startup());
cin Fixed startup of DjxWidgetBase to start inner widgets...	r52	super.startup();
		}
cin sync	r7	}