Cómo personalizar la interfaz de usuario de CODE y ocultar barras de herramientas específicas

Respuesta breve: En CODE, cambie el estilo general de la barra de herramientas con la configuración de vista Compacta o con pestañas. Para ocultar una pestaña del cuaderno o un comando, la opción compatible es la API PostMessage del host WOPI; los menús normales del visor no eliminan permanentemente los comandos individuales para todos los usuarios. Los administradores pueden configurar el modo de interfaz predeterminado para un servidor, mientras que los hosts que integran CODE pueden enviar mensajes para ocultar o mostrar comandos a nivel de sesión.

Seleccione el método que mejor se ajuste a su acceso. Si solo necesita más espacio para el documento, contraiga la barra de herramientas o cambie a la vista compacta. Si su integración con WOPI debe omitir la pestaña Ayuda o un comando de formato, envíe el PostMessage correspondiente una vez que el editor esté listo. Si su objetivo es impedir una acción como imprimir, descargar o editar, utilice también la capacidad o el permiso de WOPI pertinente; ocultar un botón modifica la presentación, no la autorización.

Elige la personalización adecuada

El manual del SDK correspondiente indica Hide_NotebookTabque está disponible a partir de la versión 24.04.11.1 y Hide_Commanda partir de la versión 24.04.11.2. Los paquetes de lanzamiento de CODE y las compilaciones del integrador pueden diferir, así que compruebe la versión del servidor que utiliza antes de confiar en un mensaje de la API.

Cambiar la vista predeterminada entre vista compacta y vista con pestañas.

La vista compacta utiliza un menú y una barra de herramientas más pequeña. La vista con pestañas agrupa los controles en las pestañas de la barra de herramientas. La configuración del servidor es user_interface.mode, con valores admitidos compacty tabbed. Las etiquetas antiguas como classicy notebookbarestán obsoletas en favor de estos nombres.

Para una configuración predeterminada controlada por el administrador, edite la <mode>entrada existente dentro de la <user_interface>sección de coolwsd.xml:

<user_interface>
  <mode type="string" desc="Controls the user interface style. The 'default' means: Take the value from ui_defaults, or decide for one of compact or tabbed (default|compact|tabbed)" default="default">tabbed</mode>
</user_interface>

Utilice compacten lugar de tabbedpara el menú compacto. En un archivo de configuración real, modifique la entrada de modo existente en lugar de agregar una segunda. La ruta de configuración exacta y el procedimiento de reinicio dependen de si CODE está instalado como paquete, contenedor o a través de otra plataforma. Siga el método de configuración de esa implementación, reinicie o recargue el servicio según sea necesario y abra una nueva sesión de documento para confirmar la configuración predeterminada.

Esto establece un modo de interfaz predeterminado; no oculta un comando específico. Un usuario o integrador puede tener preferencias de interfaz guardadas que prevalecen, según la configuración del estado de la interfaz de usuario guardada del servidor. Si un navegador se vuelve a abrir repetidamente con una vista diferente, pruebe con una nueva sesión y verifique el comportamiento de las preferencias del usuario del integrador antes de modificar más configuraciones del servidor.

Contraer la barra de herramientas sin eliminar los comandos

Cuando el objetivo es simplemente aumentar el espacio del documento, suele ser suficiente con minimizar la barra de pestañas. El Collapse_Notebookbarmensaje del SDK oculta los botones de la barra de pestañas; los nombres de las pestañas permanecen visibles para que los usuarios puedan volver a expandir los controles. El mismo mensaje también oculta la tira de botones en la vista compacta. Este cambio de visualización es reversible, no una forma de deshabilitar las funciones de edición.

En una interfaz compatible, el usuario también puede contraer o expandir la barra de notas interactuando con su tira de pestañas. El comportamiento exacto al hacer clic o doble clic puede variar según la vista y la forma de soltar el botón. Si los usuarios necesitan restaurar una barra contraída, mantengan visibles los nombres de las pestañas y prueben la acción en la misma versión de CODE que utilizan.

Ocultar una pestaña o comando en una integración WOPI

La ocultación por sesión requiere una aplicación anfitriona que incruste CODE en un iframe y pueda enviarle mensajes. No es una configuración de propósito general que se pueda pegar en coolwsd.xml. La API PostMessage utiliza mensajes con un MessageId, una marca de tiempo y opcionalmente Values. El host WOPI debe completar el intercambio de disponibilidad antes de enviar comandos del editor. Configure WOPI PostMessageOriginpara la página anfitriona y utilice el origen exacto del iframe de CODE como destino del mensaje del navegador; no utilice un origen de destino comodín.

Después de que el host haya recibido el App_LoadingStatusevento de disponibilidad apropiado y lo haya enviado Host_PostmessageReady, puede enviar un mensaje para ocultarlo. Por ejemplo, las siguientes llamadas ocultan la pestaña Ayuda y el comando de subrayado para la sesión del editor abierta:

const frame = document.getElementById("collaboraFrame");
const collaboraOrigin = "https://office.example.com";

function sendToCollabora(MessageId, Values = {}) {
  frame.contentWindow.postMessage({
    MessageId,
    SendTime: Date.now(),
    Values
  }, collaboraOrigin);
}

// Call after the WOPI PostMessage readiness exchange.
sendToCollabora("Hide_NotebookTab", { id: "Help" });
sendToCollabora("Hide_Command", { id: ".uno:Underline" });

Reemplaza office.example.comcon el origen de tu propio iframe de CODE. El ejemplo ilustra la estructura del mensaje; intégralo en el ciclo de vida real del iframe del host y valida el origen de los mensajes entrantes antes de responder. La documentación de CODE indica que los mensajes del host enviados con anterioridad Host_PostmessageReadypueden ser ignorados.

¿Qué mensaje deberías usar?

• Hide_NotebookTab: Úselo para una pestaña completa en la vista de pestañas. Es idel ID de la pestaña, como por ejemplo Help. Show_NotebookTabrevierte el cambio. La pestaña permanece oculta durante la sesión hasta que llega un mensaje para mostrarla.
• Hide_Command: Úselo cuando el comando deba desaparecer del menú, la barra de herramientas y los menús contextuales. Un ejemplo de ID es .uno:Underline. Show_Commandlo invierte. Úselo solo cuando el resultado deseado sea eliminar ese comando de todas esas superficies.
• Hide_ButtonÚselo cuando desee ocultar un solo botón en lugar de todas las entradas de la interfaz de usuario para el comando. Su ID es el ID de un botón de la barra de herramientas, no necesariamente el nombre del comando UNO. Collabora documenta que estos ID suelen ser estables, pero no se garantiza su estabilidad; confírmelos en el código fuente para su compilación y formato de dispositivo específicos.
• Hide_MenubarEsto oculta la barra de menús por completo. No es un control por comando y no debe confundirse con ocultar una pestaña de la barra de notas.

La API postMessage está diseñada para un host de integración. Si utiliza Nextcloud, ownCloud u otra plataforma, compruebe si su conector ofrece una configuración compatible antes de crear código personalizado para el host. Evite inyectar CSS en la página del editor: es inestable entre versiones y solo oculta los controles visualmente.

Comprueba que el cambio se ajusta a tu caso de uso.

Abra un documento de prueba con el mismo navegador, tipo de documento, permisos y versión de CODE que sus usuarios. Confirme el modo seleccionado, compruebe que solo se oculte la pestaña o el comando deseado y pruebe el mensaje o la acción de expansión de la barra de herramientas correspondiente. Repita el proceso para Writer, Calc e Impress si su integración abarca las tres aplicaciones; los comandos disponibles y los identificadores de la barra de herramientas no son necesariamente idénticos entre los módulos.

Si el control oculto sigue apareciendo, compruebe que el host envió el comando Host_PostmessageReady, que su origen WOPI PostMessageOriginy de destino del iframe son correctos y que el mensaje utilizó el ID y la ortografía esperados. Compruebe también la versión del servidor con respecto a la línea base de características documentada. Una ocultación visual exitosa no elimina el comando del motor de documentos subyacente ni establece una restricción de seguridad. Utilice los permisos WOPI y la política de backend para el control de acceso.

Referencias oficiales

• Manual del SDK de Collabora Online, 24.04: configuración y API PostMessage
• Documentación de la API PostMessage del SDK en línea de Collabora
• Notas de la versión CODE 26.04
• Notas de la versión CODE 21.11: Alternancia entre vista compacta y vista con pestañas