Saltar al contenido principal

Controles del visor

La barra superior del visor incluye seis controles. Todos están visibles por defecto. El campo controls de ViewerUIConfig permite ocultar individualmente los que no se necesiten.


Referencia de controles

ControlTecla / CampoComportamiento
homebooleanVuelve al selector de inicio (pantalla de experiencias). Invoca onHome si se pasó.
helpbooleanAbre/cierra el overlay de ayuda con instrucciones de uso.
comparebooleanActiva el modo «Antes
downloadbooleanDescarga el visual actual como PNG. Respeta el composite del split y aplica marca de agua si la licencia lo exige.
favoritesbooleanAbre/cierra el panel de favoritos (♥). Requiere que el módulo de favoritos esté activo; ver 05-producto-y-favoritos.md.
closebooleanCierra el visor. Dependiendo de la configuración, puede mostrar el formulario NPS y/o el mensaje de gracias antes de terminar. Ver 07-cierre-y-nps.md.

Tabla exhaustiva de tipos en 10-referencia-de-tipos.md.


Uso

controls se anida dentro de ui en StartOptions:

await vto.start({
module: 'hair-color',
colors: TONOS,
ui: {
branding: { name: 'AURA' },
controls: {
home: true,
help: true,
compare: true,
download: true,
favorites: true,
close: true,
},
},
})

Todos los campos son opcionales; omitir un campo equivale a true (visible).


Ocultar controles específicos

Pasa false en los campos que no quieras mostrar:

// Quitar "home" y "download" y dejar el resto
ui: {
branding: { name: 'AURA' },
controls: {
home: false,
download: false,
},
},
// Visor mínimo: solo el botón de cierre
ui: {
branding: { name: 'AURA' },
controls: {
home: false,
help: false,
compare: false,
download: false,
favorites: false,
close: true,
},
},

Notas

  • home invoca onHome (callback de StartOptions) si se pasa. Sin callback, el botón de inicio no provoca ninguna acción adicional más allá de la navegación al selector.
  • compare divide la pantalla horizontalmente; el lado izquierdo muestra el frame sin efecto y el derecho (o viceversa según orientación) muestra el color aplicado.
  • download reutiliza vto.download() internamente: descarga el visual actual (con composite del split si está activo y marca de agua si la licencia lo exige).
  • close desencadena el flujo de cierre configurado con nps y thanks. Ver 07-cierre-y-nps.md para la secuencia completa.