La creación de interfaces de usuario con el servicio HTML sigue muchos de los mismos patrones y prácticas que otros tipos de desarrollo web. Sin embargo, hay algunos aspectos que son exclusivos del entorno de Apps Script o que vale la pena destacar. A continuación, analizaremos algunas prácticas recomendadas que debes tener en cuenta cuando desarrolles tus propias IU de servicio HTML.
Separa HTML, CSS y JavaScript
Mantener todo el código HTML, CSS y JavaScript en un solo archivo puede dificultar la lectura y el desarrollo de tu proyecto. Si bien Apps Script requiere que el código del cliente se coloque en archivos .html, puedes separar tu CSS y JavaScript del cliente en archivos diferentes y, luego, incluirlos en la página HTML principal con una función personalizada.
En el siguiente ejemplo, se define una función include() personalizada del servidor en el archivo Code.gs para importar el contenido de los archivos Stylesheet.html y JavaScript.html en el archivo Page.html. Cuando se llama con scriptlets de impresión, esta función importa el contenido del archivo especificado en el archivo actual. Ten en cuenta que los archivos incluidos contienen etiquetas <style> y <script> porque son fragmentos de HTML y no archivos .css o .js puros.
Code.gs
function doGet(request) {
return HtmlService.createTemplateFromFile('Page')
.evaluate();
}
function include(filename) {
return HtmlService.createHtmlOutputFromFile(filename)
.getContent();
}Page.html
<!DOCTYPE html>
<html>
<head>
<base target="_top">
<?!= include('Stylesheet'); ?>
</head>
<body>
<h1>Welcome</h1>
<p>Please enjoy this helpful script.</p>
<?!= include('JavaScript'); ?>
</body>
</html>Stylesheet.html
<style>
p {
color: green;
}
</style>JavaScript.html
<script>
window.addEventListener('load', function() {
console.log('Page is loaded');
});
</script>Carga datos de forma asíncrona, no en plantillas
El HTML basado en plantillas se puede usar para compilar rápidamente interfaces simples, pero su uso debe limitarse para garantizar que la IU sea responsiva. El código de las plantillas se ejecuta una vez cuando se carga la página, y no se envía contenido al cliente hasta que se completa el procesamiento. Tener tareas de larga duración en el código de tu scriptlet puede hacer que la IU parezca lenta.
Usa etiquetas de scriptlet para tareas rápidas y únicas, como incluir otro contenido o establecer valores estáticos. Todos los demás datos se deben cargar con llamadas a google.script.run.
Codificar de esta manera asíncrona es más difícil, pero permite que la IU se cargue más rápido y le da la oportunidad de mostrar un spinner o algún otro mensaje de carga al usuario.
No: Carga en plantillas
<p>List of things:</p>
<? var things = getLotsOfThings(); ?>
<ul>
<? for (var i = 0; i < things.length; i++) { ?>
<li><?= things[i] ?></li>
<? } ?>
</ul>Sugerencia: Carga de forma asíncrona
<p>List of things:</p>
<ul id="things">
<li>Loading...</li>
</ul>
<script
src="//ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js">
</script>
<script>
// The code in this function runs when the page is loaded.
$(function() {
google.script.run.withSuccessHandler(showThings)
.getLotsOfThings();
});
function showThings(things) {
var list = $('#things');
list.empty();
for (var i = 0; i < things.length; i++) {
list.append('<li>' + things[i] + '</li>');
}
}
</script>Carga recursos con HTTPS
Si tu página se publica con el nuevo IFRAME
modo de zona de pruebas, incluir archivos JavaScript o CSS que no se publiquen con HTTPS generará errores como el que se muestra a continuación.
Contenido mixto: La página en "https://…" se cargó a través de HTTPS, pero solicitó una secuencia de comandos no segura "http://…". Se bloqueó esta solicitud; el contenido se debe entregar a través de HTTPS.
La mayoría de las bibliotecas populares admiten HTTP y HTTPS, por lo que el cambio suele ser solo cuestión de insertar una "s" adicional en la URL.
Usa la declaración del tipo de documento HTML5
Si tu página se publica con el modo de zona de pruebas IFRAME más reciente, asegúrate de incluir el siguiente fragmento de código en la parte superior de tu archivo HTML.
<!DOCTYPE html>
Esta declaración de tipo de documento le indica al navegador que diseñaste la página para navegadores modernos y que no debe renderizarla con el modo no estándar. Incluso si no planeas aprovechar los elementos HTML5 modernos o las APIs de JavaScript, esto te ayudará a garantizar que tu página se muestre correctamente.
Carga JavaScript al final
Muchos desarrolladores web recomiendan cargar el código JavaScript en la parte inferior de la página para aumentar la capacidad de respuesta, y esto es aún más importante con el servicio HTML. Si mueves tus etiquetas de <script> al final de la página, el contenido HTML se renderizará antes de que se procese JavaScript, lo que te permitirá mostrar un indicador de carga o algún otro mensaje al usuario.
Aprovecha jQuery
jQuery es una biblioteca de JavaScript popular que simplifica muchas tareas comunes en el desarrollo web.