在 TypeScript 中定义一个自定义的 jQuery UI 小部件

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 小部件。有人有这方面的经验吗？

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

Answer 1

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

一个标准的 jQuery 插件将用几乎纯 JavaScript 表示，并且不会使用模块或类，因为它最终被包装为 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

在打字稿中拥有一个基类可能会有所帮助，其他小部件类可以从该基类派生。 它的唯一目的是提供基类语义，这样您就可以访问基类的成员，而不必求助于弱类型。

诀窍是在运行时（在构造函数中）删除所有成员——否则你会遇到小部件工厂提供的继承问题。例如，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"});