Modyo Docs

# Widgets

Los widgets te permiten crear micro frontends para tus sitios y aplicaciones. Usar Widgets extienden las capacidades de tus sitios y te permite tener mayor control ya que puedes agregar más funcionalidades manteniendo cada widget como una entidad separada de tu sitio.

Al entrar en la sección Widgets del sitio, se puede ver un listado de todos los widgets que se han creado. En la barra superior se puede filtrar el listado de widgets por estado, autor, tags, o hacer una búsqueda de texto por el nombre del widget.

En la vista de edición del widget, se puede ver la barra superior de acciones, el área de trabajo y la columna de propiedades.

En la barra superior se encuentran las siguientes secciones:

  • Borrador: Este estado aparece cuando recién se haya creado un widget o cuando se haya despublicado.
  • Publicado: Este estado aparece luego de haber hecho una publicación y cuando las versiones editable y publicada son iguales.
  • Cambios pendientes: Este estado aparece si es que ya hay una versión publicada, pero hay cambios pendientes de publicar en versión editable.
  • En revisión: Este estado aparece cuando esté habilitada la revisión en equipo y se haya enviado a revisión la versión editable.
  • Aprobado: Este estado aparece cuando esté habilitada la revisión en equipo y se cumplen las condiciones de revisión del elemento. Si está en este estado, las plantillas están listas para ser publicadas.

A la derecha, encuentras las siguientes acciones: Vista previa: Abre en una nueva pestaña la vista previa de la versión editable del widget.

Atención

Puedes previsualizar los widgets como usuario sin sesión o usuario con sesión de Modyo. Para esto, es recomendable iniciar o cerrar la sesión de Modyo en el sitio antes de entrar al modo vista previa. Esto se debe a que iniciar o cerrar sesión dentro del modo de vista previa puede generar errores de seguridad como x-frame-options o mixed-content, dependiendo de la configuración de dominios personalizados y SSL del sitio.

Diferencias: Te lleva a la vista de diferencias, en la cual puedes comparar los cambios que hay entre múltiples versiones del widget.

Por defecto comienzas comparando la versión publicada con la versión editable. Usa los selectores de versiones para comparar con versiones de respaldo. Si el ícono no aparece, significa que no hay versión publicada de este widget.

Actividad: Te permite desplegar una pestaña lateral que muestra la actividad y comentarios del widget.

Otras opciones: Permite archivar y crear una copia del widget actual.

Botón principal:

  • Guardar: Guarda los cambios actuales.
  • Enviar a revisión: Si está habilitada la revisión en equipo, puedes enviar el widget a revisión y notificar a los revisores que el widget está listo para ser revisado.
  • Publicar: Te lleva a la vista de publicación conjunta donde puedes publicar tus widgets.

Otras acciones principales:

  • Despublicar: Si el widget está publicado, puedes sacarlo de producción usando esta opción.
  • Forzar publicación: Si eres administrador del sitio, puedes utilizar esta opción para publicar inmediatamente un widget, incluso si está habilitada la Revisión en Equipo.

Tip

Sólo se pueden archivar los widgets que han sido despublicados previamente.

Tip

Los widgets archivados no aparecerán en el listado inicial ni tampoco en el modal de selección de widgets en el Page Builder. Para restaurar un widget archivado, se debe entrar a la vista de edición, usando la opción Restaurar en la esquina superior derecha de la vista.

Una vez que un widget está publicado, este será visible en el modal de selección de widgets personalizados en el Page Builder.

Tip

Para aprender más sobre el flujo de publicación, revise la sección de Versionado.

En el área de trabajo se puede ver:

  • Pestañas de código: Se tiene a disposición una pestaña de JavaScript, CSS, y HTML para construir widgets.
  • Gestor de archivos: Al hacer click, se levanta el modal de gestión de archivos, donde se puede filtrar y buscar los archivos que has subido en el Gestor de Archivos y copiar su URL para usarlos en el widget. También se puede subir nuevos archivos desde este modal.
  • Atajos de teclado: Muestra una pequeña ventana informativa con algunos atajos de teclado útiles.
  • Snippets: Muestra una lista de los snippets disponibles desde el Template Builder y se copia su código para referenciarlos en el widget.
  • Cambios: Si se han guardado cambios y no han publicado, mostrará este listado de todas las veces guardadas cada uno de los archivos (JS, CSS, y HTML). Al hacer click en una sub-versión, se cambia el contenido de la pestaña por el contenido de la sub-versión que se hizo click.

Tip

Para no perder los cambios que tienes actualmente, se debe guardar antes de saltar entre sub-versiones, de tal forma que siempre pueda volver a la última versión guardada en la lista de cambios.

Tip

Cuando se publica el widget, no se observarán cambios disponibles. Esto es porque cada versión parte sin cambios desde la versión productiva. Si se restaura el widget a una versión anterior, también lo harán las sub-versiones, por lo que se puede acceder a todas las instancias en que se guardaron cambios en esa versión.

En las tres pestañas del widget se puede hacer uso de Liquid. Para más información revise la documentación asociada a Liquid.

En la columna de propiedades se pueden ver:

  • Nombre: Permite cambiar el nombre del widget
  • Tags: Permite añadir tags a un widget. Los tag son de uso administrativo y sirven para buscar y filtrar los widgets y así poder encontrarlos rápidamente.
  • Páginas que usan este widget: Verás un listado de páginas que están usando este widget. Mientras veas páginas en este listado, no podrás despublicar ni archivar el widget.

Atención

Si eliminas un widget de una página y publicas, seguirás viendo esa página en este listado dado que el widget sigue referenciado en los respaldos de esa página. Desde la versión 9.1.10 en adelante, puedes despublicar cualquier widget publicado, incluso si está en uso. Las referencias activas en las páginas quedarán inactivas, por lo que no verás el widget en el sitio si lo despublicaste. Además, podrás archivar cualquier widget que no esté publicado, de tal forma que si aun existen referencias en algunas páginas del widget que quieres archivar, estas se eliminarán al momento de archivar el widget.

# Crear un Widget

Para crear un nuevo Widget y tener un micro frontend para tus sitios y publicaciones, sigue estos pasos:

  1. Dentro del menú principal de Modyo Platform, expande Channels y haz click en tu sitio.
  2. Haz click en Widgets.
  3. Haz click en el botón + Nuevo Widget.
  4. Escribe el nombre de tu widget y haz click en Crear.
  5. Personaliza tu widget usando HTML, CSS, JavaScript, o Liquid.
  6. Una vez terminado, haz click en Publicar.

# Variables del Widget

En la pestaña de variables puedes ver el listado de variables creadas en el widget, y sus respectivas acciones para:

  • Copiar el código liquid para usar esa variable.
  • Modificar la variable
  • Eliminar la variable.

Junto al nombre de cada variable verás un indicador "sobreescrita" si es que la variable también existe a nivel de cuenta o sitio en las variables globales.

Al modificar una variable, podrás decidir el nombre y valor por defecto que tomará esa variable en el widget. Además, podrás decidir si quieres disponibilizar un listado de valores para que al momento de instanciar el widget en una página, se pueda elegir entre estos distintos valores.

Cuando usas el listado de posibles valores, debes dejar cada valor en una linea nueva, y dejar un * delante del valor que quieres que sea tomado como valor por defecto.

Al momento de instanciar el widget en una página, verás que ahora todas las variables que se están usando (ya sean de cuenta, sitio o de widget) se listarán como "deshabilitadas" con su valor por defecto. Si quieres sobreescribir el valor de una variable en particular para esa instancia del widget en esa página, debes seleccionar el checkbox a la izquierda de la variable y cambiar el valor que toma.

Atención

Al instanciar el widget en una página se listarán todas las variables que ese widget está usando, por lo que si no ves alguna de las variables que están definidas en el widget, es muy probable que no se esté usando la variable en el código del widget.

# Carga síncrona

Atención

Esta es una funcionalidad experimental y puede estar sujeta a cambios.

Puedes decidir si quieres cargar tus widgets de forma sincrónica, es decir, que el código HTML, CSS, y JavaScript de tu widget se carguen junto con el resto de la página desde el servidor, o bien, que se carguen de forma asincrónica, de tal manera que se cargará todo el contenido estático de la página y una vez que el documento principal esté cargado, el contenido de tu widget se cargará mediante JavaScript. Por defecto, todos los widgets se cargan de forma asincróica.

Para cambiar la forma en que se carga cada widget, debes ir a la vista de edición de la página que contiene el widget, seleccionar el widget y marcar o desmarcar la opción "Carga síncrona".

Atención

Debes tener en consideración que usar widgets muy pesados de forma sincrónica puede hacer que se vea disminuido el rendimiento de tu página, por lo que debes decidir con cuidado cuales widgets se cargarán de forma síncrona y cuales de forma asíncrona.

# Usar Internacionalización (i18n)

Con i18n puedes configurar y agregar nuevos idiomas a tus widgets.

Para manejar la internacionalización en los Widgets de nuestro catálogo de experiencias usamos el paquete Vue I18n (opens new window) instalado mediante el plugin vue-cli-plugin-i18n (opens new window), pueden revisar su documentación aquí (opens new window). Al instalar el plugin, se crea una carpeta para los idiomas llamada locales y un archivo de configuración llamado i18n.js.



 

 
 
 

├── src/
│   ├── App.vue
│   ├── i18n.js
│   ├── main.js
│   ├── locales/
│   │   ├── en-US.json
│   │   └── es-CL.json

Tip

Para saber más sobre internacionalización y vue-i18n, ver Internationalization with vue-i18n (opens new window) de VueSchool (opens new window)

# Configuración

En el archivo de configuración obtendremos el idioma del sitio que tenemos en la plataforma. Primero se inicializa la constante LANG en el archivo i18n.js.




 






 




import Vue from 'vue';
import VueI18n from 'vue-i18n';

const LANG = window.liquid ? window.liquid.lang : 'es-CL';

Vue.use(VueI18n);

//... more code

export default new VueI18n({
  locale: LANG,
  fallbackLocale: 'es-CL',
  messages: loadLocaleMessages(),
});

La variable liquid.lang la tenemos que crear en Modyo Platform. Para crear esta variable, sigue estos pasos:

  1. En tu navegador, inicia sesión en Modyo Platform.
  2. Expande Channels, y haz click en Sitios.
  3. Haz click en Plantillas.
  4. Abre la Vista theme en la sección Vistas -> Javascript -> theme.
  5. Agrega el siguiente código:
window.liquid = {
 lang: '{{@site.language}}' === 'en' ? 'en-US' : 'es-CL'
};

Este código asigna a la variable liquid.lang el lenguaje, dependiendo del valor de @site.language usando Liquid.

# Agregar un idioma

Para agregar un idioma nuevo al sitio, simplemente creamos un archivo JSON en la carpeta locales donde su nombre es el código del idioma a añadir. Por ejemplo, si queremos agregar portugués de Brasil, agrega pt-BR.json:




 


├── src/
│   ├── locales/
│   │   ├── en-US.json
│   │   ├── pt-BR.json <-- new language
│   │   └── es-CL.json

Atención

La estructura del archivo de idioma tiene que ser un objeto json:

# Validación de formularios

Para poder localizar los mensajes de error que el validador nos muestra, tenemos que hacer una pequeña modificación al archivo de configuración de i18n.js.

  1. Importamos los mensajes de error en los idiomas que necesitamos.
  2. En la función loadLocaleMessages, agregamos los mensajes del validador en el idioma que corresponde.
  3. Retornamos el objeto messages modificado.
import esCL from 'vee-validate/dist/locale/es-CL.json';
import enUS from 'vee-validate/dist/locale/en-US.json';
import ptBR from 'vee-validate/dist/locale/pt-BR.json';

function loadLocaleMessages() {
  const locales = require.context('./locales', true, /[A-Za-z0-9-_,\s]+\.json$/i);
  const messages = {};
  locales.keys().forEach((key) => {...});
 
  messages['es-CL'] = {
    ...messages['es-CL'],
    validations: esCL.messages,
  };

  messages['en-US'] = {
    ...messages['en-US'],
    validations: enUS.messages,
  };

  messages['pt-BR'] = {
    ...messages['pt-BR'],
    validations: ptBR.messages,
  };

  return messages;
}

# Usar Liquid en Widgets

Crea un objeto javascript en Snippets para poder hacer uso de Liquid en tus Widgets.

Los Widgets, al estar desacoplados de la plataforma, tienen la desventaja de no poder usar Liquid directamente y no tenemos acceso a liquid drops, para poder trabajar con ellos los tendremos que hacer disponibles mediante javascript desde la plataforma. Liquid Markup es una parte importante de la plataforma, de como construimos las vistas, y accedemos al contenido en ella. También nos da acceso a drops, variables de contexto que nos permiten interactuar con nuestras vistas de manera más dinámica. Por ejemplo, se puede determinar que contenido mostrar al usuario según el segmento al que pertenece, ocultar un menú según la página que se este visitando, etc.

Sigue estos pasos para crear un snippet con variables de Liquid:

  1. En el menú lateral en la plataforma, expande Channels y haz click en Sitios.

  2. Haz click en tu sitio.

  3. En el menú de tu sitio, haz click en Plantillas y selecciona Snippets.

  4. Agrega un nuevo Snippet Personalizado. Para éste ejemplo al snippet lo nombramos liquid2js_js, pero puede tener cualquier nombre.

  5. Abre el apartado de javascript y pega el código:

   window.liquid = {
     lang: '{{@site.language}}' === 'en' ? 'en-US' : 'es-CL',
     request: {
       path: "{{request.path}}",
     },
   };

En este snippet creamos un objecto llamado liquid con scope de window que contenga el lenguaje y el request path del sitio. Desde nuestro Widget ahora podemos acceder a estos datos utilizando el objeto creado en el paso anterior. Por ejemplo, si quieres obtener los lenguajes del sitio desde el Widget, puedes hacerlo con:

const languages = window.liquid.lang;

Atención

En modo de desarrollo no tendremos acceso a este objeto ya que estamos trabajando localmente, es por eso que la recomendación es asignar valores por defecto al definir estas variables localmente.

En el siguiente ejemplo, const lang toma el valor de window.liquid.lang, si no existe el objeto, asigna el valor "es-CL" por defecto:

const lang = window.liquid !== "undefined" ? window.liquid.lang : "es-CL";

← Modyo Command Line Interface →