Tipos de módulos de IU de ContextHub de muestra sample-contexthub-ui-module-types

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

Temas:

Creado para:

Desarrollador

ContextHub proporciona varios módulos de IU de ejemplo que puede utilizar en sus soluciones. Se proporciona la siguiente información:

Las principales características del módulo IU de.
Dónde encontrar el código fuente para poder abrirlo con fines de aprendizaje.
Cómo configurar el módulo de IU.

Para obtener información sobre cómo agregar módulos de interfaz de usuario a ContextHub, consulte Agregar un módulo de interfaz de usuario. Para obtener información sobre el desarrollo de módulos de interfaz de usuario, consulte Creación de tipos de módulos de interfaz de usuario de ContextHub.

Tipo de módulo de IU de contexthub.base contexthub-base-ui-module-type

El tipo de módulo de IU de contexthub.base es el tipo base para todos los demás tipos de módulos de IU. De este modo, proporciona funciones genéricas para procesar los datos del almacén.

Estas son las funciones disponibles:

Título e icono: Especifique un título para el módulo de interfaz de usuario y un icono. Se puede hacer referencia al icono mediante una dirección URL o desde la biblioteca de iconos de la IU de Coral.
Datos de almacén: Identifique uno o más almacenes de los que desee recuperar datos.
Contenido: especifique el contenido que aparece en el módulo de la interfaz de usuario tal como aparece en la barra de herramientas de ContextHub.
Contenido de ventana emergente: Especifique el contenido que aparece en una ventana emergente cuando se hace clic o se pulsa el módulo de la interfaz de usuario.
Modo de pantalla completa: Controle si el modo de pantalla completa está permitido.

El código fuente se encuentra en /libs/granite/contexthub/code/ui/container/js/ContextHub.UI.BaseModuleRenderer.js.

Configuración configuration

Configure el módulo de la interfaz de usuario contexthub.base mediante un objeto JavaScript en formato JSON. Incluya cualquiera de las siguientes propiedades para configurar las funciones del módulo de interfaz de usuario:

imagen: Una dirección URL a una imagen para mostrarla como icono.
icono: El nombre de una clase Coral UI icon. Si especifica un valor para las propiedades icon e image, se utiliza la imagen.
título: Un título para el módulo de interfaz de usuario. El título aparece cuando el puntero se detiene sobre el icono del módulo de interfaz de usuario.
pantalla completa: Valor booleano que indica si el módulo de interfaz de usuario admite el modo de pantalla completa. Use true para admitir la pantalla completa y false para evitar el modo de pantalla completa.
plantilla: Una plantilla de Handlebars que especifica el contenido que se procesará en la barra de herramientas de ContextHub. Use como máximo dos etiquetas <p>.
storeMapping: una asignación de clave/almacén. Utilice la clave de las plantillas de Handlebar para acceder a los datos de tienda de ContextHub asociados.
lista: Una matriz de elementos que se mostrarán como una lista en una ventana emergente cuando se haga clic en el módulo de la interfaz de usuario. Si incluye este elemento, no incluya popTemplate. El valor es una matriz de objetos con las siguientes claves:
- Título: el texto que se mostrará para este elemento
- image: (opcional) dirección URL de una imagen que se debe mostrar a la izquierda
- icon: (opcional) una clase de icono de CUI que se debe mostrar a la izquierda; se ignora si se especifica una imagen
- selected: (Opcional) un valor booleano que especifica si este elemento se debe mostrar como seleccionado (true=selected). De forma predeterminada, los elementos seleccionados aparecen en negrita. Usar una propiedad listType para configurar otras apariencias (ver a continuación).
listType: estilo que se va a usar para los elementos de la lista emergente. Utilice uno de los siguientes valores:
- marca de verificación
- casilla de verificación
- radio
popoverTemplate: Una plantilla Handlebars que especifica el contenido que se procesará en la ventana emergente cuando se haga clic en el módulo UI. Si incluye este elemento, no incluya el elemento list.

Ejemplos example

El ejemplo siguiente configura un módulo de interfaz de usuario contexthub.base para mostrar información de un almacén de contexthub.emulators. El elemento template muestra cómo obtener datos del almacén utilizando la clave que establece el elemento 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>"
}

Tipo de módulo de IU de contexthub.browserinfo contexthub-browserinfo-ui-module-type

El módulo de IU contexthub.browserinfo muestra información sobre el explorador web y el sistema operativo del cliente. La información se obtiene del almacén surferinfo, según el candidato del almacén contexthub.surferinfo.

El código fuente del módulo de interfaz de usuario se encuentra en /libs/granite/contexthub/components/modules/browserinfo. Aunque contexthub.browserinfo amplía el módulo de interfaz de usuario de contexthub.base, no reemplaza ni proporciona funciones adicionales. La implementación proporciona una configuración predeterminada para procesar la información del explorador.

Configuración configuration-1

Las instancias del módulo de IU contexthub.browserinfo no requieren un valor para la Configuración detallada. El siguiente texto JSON representa la configuración predeterminada del módulo.

{
   "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>"
}

Tipo de módulo de IU de contexthub.datetime contexthub-datetime-ui-module-type

El módulo de interfaz de usuario contexthub.datetime muestra la fecha y la hora almacenadas en un almacén denominado datetime que se basa en el candidato del almacén contexthub.datetime.

El módulo proporciona un formulario emergente que le permite cambiar la fecha y la hora en el almacén.

El origen del módulo de interfaz de usuario contexthub.datetime se encuentra en /libs/granite/contexthub/components/modules/datetime.

Configuración configuration-2

Las instancias del módulo de IU contexthub.datetime no requieren un valor para la Configuración detallada. El siguiente texto JSON representa la configuración predeterminada del módulo.

{
   "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>"
}

Tipo de módulo de IU de contexthub.location contexthub-location-ui-module-type

El módulo de interfaz de usuario contexthub.location muestra la longitud y latitud del cliente. El módulo proporciona una ventana emergente que muestra un mapa de Google en el que puede hacer clic para cambiar la ubicación actual. El módulo obtiene información de un almacén de ContextHub denominado geolocation que se basa en el candidato de almacén contexthub.geolocation.

chlimage_1-80

El origen del módulo de interfaz de usuario se encuentra en /etc/cloudsettings/default/contexthub/geolocation.

Configuración configuration-4

Las instancias del módulo de IU contexthub.location no requieren un valor para la Configuración detallada. El siguiente texto JSON representa la configuración predeterminada del módulo.

{
 "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"
}

Tipo de módulo de interfaz de usuario contexthub.screen-orientation contexthub-screen-orientation-ui-module-type

El módulo de interfaz de usuario contexthub.screen-orientation muestra la orientación de pantalla actual del cliente. Aunque está desactivado de forma predeterminada, el módulo proporciona una ventana emergente que permite seleccionar una orientación. El módulo obtiene información de un almacén de ContextHub denominado emulators que se basa en el candidato del almacén granite.emulators.

El origen del módulo de interfaz de usuario se encuentra en /libs/granite/contexthub/components/modules/screen-orientation.

Configuración configuration-5

Las instancias del módulo de IU contexthub.screen-orientation no requieren un valor para la Configuración detallada. El siguiente texto JSON representa la configuración predeterminada del módulo. La propiedad clickable es false de manera predeterminada. Si reemplaza la configuración predeterminada para establecer clickable en true, al hacer clic en el módulo se muestra una ventana emergente en la que puede seleccionar la orientación.

{
   "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"
}

El módulo de IU de contexthub.tagcloud muestra información sobre las etiquetas. En la barra de herramientas, el módulo de IU muestra el número de etiquetas. La ventana emergente muestra una nube de etiquetas y un cuadro de texto para añadir nuevas etiquetas. El módulo de interfaz de usuario obtiene información de un almacén de ContextHub denominado tagcloud que se basa en el candidato de almacén contexthub.tagcloud.

chlimage_1-82

El origen del módulo de interfaz de usuario se encuentra en /libs/granite/contexthub/components/modules/tagcloud.

Configuración configuration-6

Las instancias del módulo de IU de contexthub.tagcloud no requieren un valor para la Configuración detallada. El siguiente texto JSON representa la configuración predeterminada del módulo.

{
   "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>"
}

Tipo de módulo de IU de granite.profile granite-profile-ui-module-type

El módulo de interfaz de usuario de ContextHub granite.profile muestra el nombre para mostrar del usuario actual. La ventana emergente muestra el nombre de inicio de sesión del usuario y le permite cambiar el valor del nombre para mostrar. El módulo de interfaz de usuario obtiene información de un almacén de ContextHub denominado profile que se basa en el candidato de almacén granite.profile.

chlimage_1-83

El origen del módulo de interfaz de usuario se encuentra en /libs/granite/contexthub/components/modules/profile.

Configuración configuration-7

Las instancias del módulo de interfaz de usuario grantie.profile no requieren un valor para la Configuración detallada. El siguiente texto JSON representa la configuración predeterminada del módulo.

{
   "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