文档AEM 6.5用户指南

ContextHub UI模块类型示例 sample-contexthub-ui-module-types

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 开发人员

ContextHub提供了几个可在解决方案中使用的示例UI模块。 提供了以下信息：

  • UI模块的主要功能。
  • 在何处查找源代码，以便打开它进行学习。
  • 如何配置UI模块。

有关将UI模块添加到ContextHub的信息，请参阅添加UI模块。 有关开发UI模块的信息，请参阅创建ContextHub UI模块类型。

contexthub.base UI模块类型 contexthub-base-ui-module-type

contexthub.base UI模块类型是所有其他UI模块类型的基类型。 因此，它提供了用于呈现存储数据的通用功能。

可以使用以下功能：

  • 标题和图标： ​指定UI模块的标题和图标。 可以使用URL或Coral UI图标库引用该图标。
  • 存储数据： ​标识一个或多个要从中检索数据的存储。
  • 内容： ​指定显示在ContextHub工具栏中的UI模块中的内容。
  • 弹出窗口内容： ​指定单击或点按UI模块时弹出窗口中显示的内容。
  • 全屏模式： ​控制是否允许全屏模式。

源代码位于/libs/granite/contexthub/code/ui/container/js/ContextHub.UI.BaseModuleRenderer.js。

配置 configuration

使用JSON格式的JavaScript对象配置contexthub.base UI模块。 包括以下任意属性来配置UI模块功能：

  • 图像： ​要显示为图标的图像的URL。

  • 图标： Coral UI图标类的名称。 如果同时为图标和图像属性指定值，则会使用图像。

  • 标题： UI模块的标题。 当指针悬停在UI模块图标上时，将显示标题。

  • 全屏： ​布尔值，指示UI模块是否支持全屏模式。 使用true支持全屏模式，使用false阻止全屏模式。

  • 模板： ​指定在ContextHub工具栏中呈现的内容的Handlebars模板。 最多使用两个<p>标记。

  • storeMapping： ​密钥/存储映射。 使用手柄栏模板中的键访问关联的ContextHub存储数据。

  • 列表： ​在单击UI模块时作为列表在弹出框中显示的项数组。 如果包含此项目，请不要包含poverTemplate。 该值是一个包含以下键的对象数组：

    • 标题：为此项目显示的文本
    • 图像： （可选）应在左侧显示的图像的URL
    • 图标： （可选）应在左侧显示的CUI图标类；如果指定了图像，则忽略此类别
    • selected： （可选）一个布尔值，它指定是否将此项显示为选定项(true=selected)。 默认情况下，选定的项目会以粗体字体显示。 使用listType属性配置其他外观（请参阅下文）。

  • listType： ​用于弹出框列表项的样式。 使用以下值之一：

    • 复选标记
    • 复选框
    • 无线电

  • poverTemplate： ​一个Handlebars模板，它指定单击UI模块时要在弹出窗口中呈现的内容。 如果您包含此项，请不要包含list项。

示例 example

以下示例将contexthub.base UI模块配置为显示contexthub.emulators存储中的信息。 template项演示了如何使用storeMapping项建立的键从存储中获取数据。

{
   "icon": "coral-Icon--move",
    "title": "Screen Resolution",
    "storeMapping": {
      "emulator": "emulators"
    },
    "template": "<p>{{{ i18n \"Resolution\"}}}</p><p>{{{emulator.currentDevice.width}}} x {{{emulator.currentDevice.height}}}</p>"
}

chlimage_1-76

contexthub.browserinfo UI模块类型 contexthub-browserinfo-ui-module-type

contexthub.browserinfo UI模块显示有关客户端Web浏览器和操作系统的信息。 基于contexthub.surferinfo存储候选，从surferinfo存储中获取信息。

chlimage_1-77

UI模块的源代码位于/libs/granite/contexthub/components/modules/browserinfo。 尽管contexthub.browserinfo扩展了contexthub.base UI模块，但它不会覆盖或提供其他功能。 该实施提供了用于呈现浏览器信息的默认配置。

配置 configuration-1

contexthub.browserinfo UI模块的实例不需要详细信息配置的值。 以下JSON文本表示模块的默认配置。

{
   "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.datetime UI模块类型 contexthub-datetime-ui-module-type

contexthub.datetime UI模块显示存储在名为datetime的存储区中的日期和时间，该存储区基于contexthub.datetime存储候选项。

chlimage_1-78

此模块提供了一个弹出窗体，通过该窗体可以更改存储中的日期和时间。

contexthub.datetime UI模块的源位于/libs/granite/contexthub/components/modules/datetime。

配置 configuration-2

contexthub.datetime UI模块的实例不需要详细信息配置的值。 以下JSON文本表示模块的默认配置。

{
   "icon":"coral-Icon--clock",
   "title":"DATE&TIME",
   "clickable":true,
   "storeMapping":{"d":"datetime"},
   "template":"<p class=\"contexthub-module-line1\">{{i18n \"Date&Time\"}}</p><p class=\"contexthub-module-line2\">{{d.formatted.locale.date}} {{d.formatted.locale.time}}</p>",
   "popoverTemplate":"<div class=\"datetime center\"><div class=\"coral-DatePicker-calendar\" data-init=\"datepicker\"><input class=\"coral-Textfield\" type=\"datetime\" value=\"{{d.formatted.iso}}\"><button class=\"coral-Button coral-Button--secondary coral-Button--square\" title=\"{{i18n \"Datetime picker\"}}\"><i class=\"coral-Icon coral-Icon--calendar coral-Icon--sizeS\"></i></button></div></div>"
}

contexthub.location UI模块类型 contexthub-location-ui-module-type

contexthub.location UI模块显示客户端的经度和纬度。 该模块提供了一个弹出窗口，用于显示Google地图，单击该弹出窗口可更改当前位置。 模块从名为geolocation的ContextHub存储中获取基于contexthub.geolocation存储候选的信息。

chlimage_1-80

UI模块的源位于/etc/cloudsettings/default/contexthub/geolocation。

配置 configuration-4

contexthub.location UI模块的实例不需要详细信息配置的值。 以下JSON文本表示模块的默认配置。

{
 "icon":"coral-Icon--compass",
 "title":"Location",
 "clickable":true,
 "editable":{"key":"/geolocation","disabled":[],"hidden":["/geolocation/generatedThumbnail","/geolocation/city","/geolocation/country"]},
 "fullscreen":true,
 "storeMapping":{"g":"geolocation"},
 "template":"<p>{{i18n \"Location\"}}</p><p>{{g.address.postalCode}} {{g.address.city}}{{#if g.address.city}}{{#if g.address.region}},{{/if}}{{/if}} {{g.address.region}}</p>",
 "list":[
  {"title":"Basel, Switzerland",
  "data":{"longitude":7.58929,"latitude":47.554746,"city":"Basel","country":"Switzerland"}},
  {"title":"Melbourne, Australia",
  "data":{"longitude":144.96328,"latitude":-37.814107,"city":"Melbourne","country":"Australia"}},
  {"title":"Beijing, China",
  "data":{"longitude":116.407526,"latitude":39.90403,"city":"Beijing","country":"China"}},
  {"title":"New York, NY, USA",
  "data":{"longitude":-74.005973,"latitude":40.714353,"city":"New York","country":"United States"}},
  {"title":"Paris, France",
  "data":{"longitude":2.352222,"latitude":48.856614,"city":"Paris","country":"France"}},
  {"title":"Rio de Janeiro, Brazil",
  "data":{"longitude":-43.20071,"latitude":-22.913395,"city":"Rio","country":"Brazil"}},
  {"title":"San Jose, CA, USA",
  "data":{"longitude":-121.894955,"latitude":37.339386,"city":"San Jose","country":"United States"}},
  {"title":"Tokyo, Japan",
  "data":{"longitude":139.691706,"latitude":35.689487,"city":"Shinjuku","country":"Japan"}}
 ],
 "listType":"checkmark"
}

contexthub.screen-orientation UI模块类型 contexthub-screen-orientation-ui-module-type

contexthub.screen-orientation UI模块显示客户端的当前屏幕方向。 尽管默认情况下处于禁用状态，但模块提供了一个弹出窗口，允许您选择方向。 模块从名为emulators的ContextHub存储中获取基于granite.emulators存储候选的信息。

chlimage_1-81

UI模块的源位于/libs/granite/contexthub/components/modules/screen-orientation。

配置 configuration-5

contexthub.screen-orientation UI模块的实例不需要详细信息配置的值。 以下JSON文本表示模块的默认配置。 默认情况下，clickable属性为false。 如果覆盖默认配置以将clickable设置为true，则单击模块将显示一个弹出窗口，您可以在其中选择方向。

{
   "icon":"coral-Icon--rotateRight",
   "title":"Screen Orientation",
   "clickable":false,
   "storeMapping":{"emulator":"emulators"},
   "template":"<p>{{{ i18n \"Screen Orientation\" }}}</p><p>{{{ emulator.currentDevice.orientation }}}",
   "listReference":"/emulators/orientations",
   "listType":"checkmark"
}

contexthub.tagcloud UI模块类型 contexthub-tagcloud-ui-module-type

contexthub.tagcloud UI模块可显示有关标记的信息。 在工具栏上，UI模块显示标记数量。 弹出窗口将显示一个tagcloud和一个用于添加新标记的文本框。 UI模块从名为tagcloud的ContextHub存储中获取基于contexthub.tagcloud存储候选的信息。

chlimage_1-82

UI模块的源位于/libs/granite/contexthub/components/modules/tagcloud。

配置 configuration-6

contexthub.tagcloud UI模块的实例不需要详细信息配置的值。 以下JSON文本表示模块的默认配置。

{
   "icon":"coral-Icon--tag",
   "title":"TagCloud",
   "clickable":true,
   "storeMapping":{"t":"tagcloud"},
   "maxTags":20,
   "template":"<p class=\"contexthub-module-line1\">{{i18n \"TagCloud\"}}</p><p class=\"contexthub-module-line2\">{{stats.total}} {{i18n \"Tags\"}}</p>",
   "popoverTemplate":"<div class=\"contexthub-popover-content center\"><p class=\"stats\">{{stats.total}} {{i18n \"Tags\"}} | {{stats.hits}} {{i18n \"Hits\"}} | {{i18n \"Last tag\"}}: {{#if stats.recent}}{{stats.recent}}{{else}}{{i18n \"Unknown\"}}{{/if}}</p><p class=\"tagcloud\">{{#each tags}}<span class=\"tag{{this.weight}}\">{{this.name}}</span> {{/each}}</p><div class=\"coral-InputGroup\"><input type=\"text\" class=\"coral-InputGroup-input coral-Textfield tag-name\" placeholder=\"{{i18n \"Add a namespace:my/tag\"}}\" pattern=\"^[A-Za-z0-9_\\-]+(:[A-Za-z0-9_\\-\\/]+)?$\" title=\"{{i18n \"namespace:my/tag\"}}\"><span class=\"coral-InputGroup-button\"><button class=\"coral-Button coral-Button--secondary coral-Button--square contexthub-new-tag\" type=\"button\" title=\"{{i18n \"increment\"}}\"><i class=\"coral-Icon coral-Icon--sizeS coral-Icon--add\"></i></button></span></div></div>"
}

granite.profile UI模块类型 granite-profile-ui-module-type

granite.profile ContextHub UI模块显示当前用户的显示名称。 弹出窗口将显示用户的登录名，并允许您更改显示名的值。 UI模块从名为profile的ContextHub存储中获取基于granite.profile存储候选的信息。

chlimage_1-83

UI模块的源位于/libs/granite/contexthub/components/modules/profile。

配置 configuration-7

grantie.profile UI模块的实例不需要详细信息配置的值。 以下JSON文本表示模块的默认配置。

{
   "icon":"coral-Icon--user",
   "title":"Profile",
   "clickable":true,
   "editable":{
      "key":"/profile",
      "disabled":["/profile/authorizableId"],
      "hidden":["/profile/avatar","/profile/path"]},
   "storeMapping":{"p":"profile"},
   "template":"<p class=\"contexthub-module-line1\">{{i18n \"Persona\"}}</p><p class=\"contexthub-module-line2\">{{p.displayName}}</p>",
   "listType":"checkmark"
}
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2