功能插件开发

DataTables 在表格周围放置了一些控制和信息元素。我们将这些组件称为“功能”。DataTables 内置了许多功能,这些功能通过一个 API 注册,该 API 可公开用于注册附加功能作为插件。此页面讨论如何使用功能 API。

DataTables 的功能通过layout 选项使用,该选项允许开发人员根据需要将功能放置在表格周围。

功能通过DataTable.feature.register() 静态 API 方法注册。有关传递到该方法的参数的完整详细信息,请参阅该方法的文档。

功能示例

前面的代码展示了如何创建名为myToolbar 的功能并注册它以供 DataTables 使用。它创建一个div 元素,该元素可以包含任何所需的 HTML(以及这些元素上的适当监听器),然后将其返回给 DataTables 以显示在表格周围

DataTable.feature.register('myToolbar', function (settings, opts) {
    // Define defaults
    let options = Object.assign({
        option1: false,
        option2: false
    }, opts);

    let container = document.createElement('div');

    // do something with the options and container
    // ...

    return container;
});

功能使用

注册功能后,您可以在layout 对象中引用它来控制表格布局

new DataTable('#myTable', {
    layout: {
        topStart: {
            myToolbar: {
                option1: true,
                option2: false
            }
        }
    }
});

发布您的插件

如果您为 DataTables 创建了一个功能插件,请告知我们! 其他人可能会从您的插件中受益,并且我(以及整个社区)将非常感谢您的贡献。