Question

我们目前正在考虑将我们的JavaScript项目翻译成TypeScript。我们的应用程序在很大程度上依赖于自定义开发的jQuery UI小部件。

在我们当前的代码库中，我们使用深层复制机制从窗口小部件定义继承，例如，允许我们声明泛型TableWidget以及定义更具体的OrdersTableWidget功能

因此，我想将我的窗口小部件定义定义为TypeScript类，然后将这些类的实例绑定到jQuery。

例如

class MyWidget {
    options: WidgetOptions;
    _init(){
        // general initialization
    }
}

class MySecondWidget extends MyWidget {
    _init(){
        super._init();
        // specific initialization
    }
}

然后

$.widget("MyNameSpace.MyWidget", new MyWidget());
$.widget("MyNameSpace.MySeWidget", new MyWidget());

此外，我想将我的自定义小部件表示为jQuery UI Widget定义的实现

class MyWidget implements Widget {
    options: WidgetOptions;
    _init(){
        // general initialization
    }
}

所以我可以在TypeScript中使用以下语法：

$(selector).MyWidget(options);

我知道我必须使用定义文件（来自DefinitelyTyped），但是我还没有找到一个可靠的来源解释我应该如何在TypeScript中编写自定义jQuery UI Widgets。有没有人有过这方面的经验？

任何帮助都非常感谢，一如既往！

Answer 1

由于缺少重载的构造函数，我不确定您是否可以编写实现Widget接口的类。您可以创建一个由Widget接口键入的变量。

标准的jQuery插件将在几乎纯粹的JavaScript中表示，并且不会使用模块或类，因为它最终被包装为jQuery的一部分，jQuery本身不是模块或类。

这是一个名为plugin的空插件，看起来像任何标准的jQuery插件，但你可以看到它利用TypeScript类型系统并扩展JQuery接口以允许它被调用。

/// <reference path="jquery.d.ts" />

interface JQuery {
    plugin(): JQuery;
    plugin(settings: Object): JQuery;
}

(function ($) {

    function DoSomething(someParamater: string) : void {

    }

    $.fn.plugin = function (settings) {

        var config = {
            settingA: "Example",
            settingB: 5
        };

        if (settings) {
            $.extend(config, settings);
        }

        return this.each(function () {

        });
    };

})(jQuery);

这将以正常方式调用。

$('#id').plugin();

所以，我的答案是 - 你不能真正做你想要的，因为你正在为jQuery添加声明的接口，而不是将它们作为模块公开。你可以将用法包装在一个模块中，比如一个适用于抽象jQuery方面的适配器，而不是在你的TypeScript中使用，或者你可以从插件中调用你的类，但插件或小部件并不真正适合模块或类。

Answer 2

在typescript中创建一个基类可能会有所帮助，其他窗口小部件类可以从中派生出来。它的唯一目的是提供基类语义，这样你就可以访问基类成员，而不必诉诸弱类型。

诀窍是在运行时删除所有成员（在构造函数中） - 否则会遇到小部件工厂提供的继承问题。例如，option方法将覆盖小部件的原始方法，这是不希望的：我们只是希望能够调用它（以静态类型的方式）。

class WidgetBase {

    public element:JQuery;

    constructor() {
        // remove all members, they are only needed at compile time.
        var myPrototype =  (<Function>WidgetBase).prototype;
        $.each(myPrototype, (propertyName, value)=>{
           delete myPrototype[propertyName];
        });
    }

    /**
     * Calles the base implementation of a method when called from a derived method.
     * @private
     */
    public _super(arg1?:any, arg2?:any, arg3?:any, arg4?:any) {

    }

    /**
     * @private
     */
    public _superApply(arguments) {

    }

    /**
     * Gets or sets the value of the widget option associated with the specified optionName.
     */
    public option(optionName:string, value?:any):any {

    }

    // ... further methods from http://api.jqueryui.com/jQuery.widget/
}

然后您可以像这样实现自己的小部件：

class SmartWidget extends WidgetBase {

    constructor(){
        super();
    }

    public _create() {
        var mySmartOption = this.option('smart'); // compiles because of base class
        this.beSmart(mySmartOption);
    }

    public _setOption(key:string, value:any) {
        if (key === 'smart') {
           this.beSmart(value);
        }

        this._super(key, value); // compiles because of base class
    }

    private beSmart(smartOne:any){
        // ...
    }

}

// register
jQuery.widget("myLib.smartWidget", new SmartWidget());

// assuming you are using https://github.com/borisyankov/DefinitelyTyped
declare interface JQuery{
    smartWidget();
    smartWidget(options:any);
    smartWidget(methodName:string, param1?:any, param2?:any, param3?:any, param4?:any);
}

最后，您可以使用您的小部件：

$(".selector").smartWidget({smart:"you"});

在TypeScript中定义自定义jQuery UI小部件

2 个答案: