扩展 ContextHub extending-contexthub

在提供的ContextHub存储和模块不符合您的解决方案要求时,定义新类型的ContextHub存储和模块。

创建自定义商店候选 creating-custom-store-candidates

ContextHub存储是从已注册的存储候选区创建的。 要创建自定义商店,请创建并注册商店候选商店。

包含创建和注册商店候选的代码的JavaScript文件必须包含在客户端库文件夹中。 文件夹的类别必须符合以下模式:

contexthub.store.[storeType]

类别的[storeType]部分是在其中注册存储候选项的storeType。 (请参阅注册ContextHub存储候选项)。 例如,对于contexthub.mystore的storeType,客户端库文件夹的类别必须为contexthub.store.contexthub.mystore

创建ContextHub存储候选 creating-a-contexthub-store-candidate

若要创建商店候选,请使用ContextHub.Utils.inheritance.inherit函数扩展一个基础商店:

每个基存储区扩展ContextHub.Store.Core存储。

以下示例创建ContextHub.Store.PersistedStore存储候选的最简单扩展:

myStoreCandidate = function(){};
ContextHub.Utils.inheritance.inherit(myStoreCandidate,ContextHub.Store.PersistedStore);

实际上,您的自定义商店候选者定义了其他功能或覆盖商店的初始配置。 /libs/granite/contexthub/components/stores下的存储库中安装了多个示例存储候选项。 要学习这些示例,请使用CRXDE Lite打开JavaScript文件。

注册ContextHub存储候选 registering-a-contexthub-store-candidate

注册存储候选项,以将其与ContextHub框架集成并允许从中创建存储。 要注册存储候选,请使用ContextHub.Utils.storeCandidates类的registerStoreCandidate函数。

注册候选商店时,需提供商店类型的名称。 从候选项创建存储时,可以使用存储类型标识存储所基于的候选项。

注册候选商店时,需指定其优先级。 当使用与已注册的存储候选相同的存储类型来注册存储候选时,使用具有较高优先级的候选。 因此,您可以使用新实施覆盖现有商店候选。

ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
                                'contexthub.mystorecandidate', 0);

通常只需要一个候选,并且优先级可以设置为0。 但是,如果您感兴趣,可以了解更多高级注册,,这允许根据JavaScript条件(applies)和候选优先级选择少数商店实现之一。

创建ContextHub UI模块类型 creating-contexthub-ui-module-types

当随ContextHub🔗安装的模块类型不符合您的要求时,创建自定义UI模块类型。 要创建UI模块类型,请通过扩展ContextHub.UI.BaseModuleRenderer类并在ContextHub.UI中注册来创建UI模块渲染器。

要创建UI模块渲染器,请创建包含用于渲染UI模块的逻辑的Class对象。 类至少必须执行以下操作:

  • 扩展ContextHub.UI.BaseModuleRenderer类。 此类是所有UI模块渲染器的基本实现。 Class对象定义了一个名为extend的属性,您使用该属性将此类命名为正在扩展的类。

  • 提供默认配置。 创建defaultConfig属性。 此属性是一个对象,其中包含为contexthub.base UI模块定义的属性以及您需要的任何其他属性。

ContextHub.UI.BaseModuleRenderer的源位于/libs/granite/contexthub/code/ui/container/js/ContextHub.UI.BaseModuleRenderer.js。 要注册渲染器,请使用ContextHub.UI类的registerRenderer方法。 提供模块类型的名称。 当管理员基于此渲染器创建UI模块时,他们会指定此名称。

在自动执行的匿名函数中创建并注册renderer类。 以下示例基于contexthub.browserinfo UI模块的源代码。 此UI模块是ContextHub.UI.BaseModuleRenderer类的简单扩展。

;(function() {

    var SurferinfoRenderer = new Class({
        extend: ContextHub.UI.BaseModuleRenderer,

        defaultConfig: {
            icon: 'coral-Icon--globe',
            title: 'Browser/OS Information',

            storeMapping: {
                surferinfo: 'surferinfo'
            },

            template:
                '<p>{{surferinfo.browser.family}} {{surferinfo.browser.version}}</p>' +
                '<p>{{surferinfo.os.name}} {{surferinfo.os.version}}</p>'
        }
    });

    ContextHub.UI.registerRenderer('contexthub.browserinfo', new SurferinfoRenderer());

}());

包含创建和注册渲染程序的代码的JavaScript文件必须包含在客户端库文件夹中。 文件夹的类别必须符合以下模式:

contexthub.module.[moduleType]

类别的[moduleType]部分是在其中注册了模块渲染器的moduleType。 例如,对于contexthub.browserinfomoduleType,客户端库文件夹的类别必须为contexthub.module.contexthub.browserinfo

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2