Con este toolkit se puede integrar fácilmente las características más notables de un PWA. Esta solución se integra fácilmente en proyectos antiguos con jQuery o en nuevos frameworks Javascript. Este proyecto está en desarrollo. No dude en probarlo y enviar sus Issus y Pull Resquests en Github.
🚀 Descubre el repositorio en GitHub.
📱 Prueba la Demo (repositorio de la demo).
Caracteristicas
- Web App Manifest
- Estructura de ficheros de iconos
- Precaching
- Estrategias de almacenamiento en caché
- Notificaciones Push
Documentación
Empieza con un Ejemplo
Importante: Para que este ejemplo funcione a la perfección, debe ser utilizado en localhost o en un dominio https y el index.html debe encontrarse en la raíz del sitio..
Clone jfa-pwa-toolkit desde el repositorio de Github y crear un archivo index.html y un offline.html archivo.
$ git clone --branch v1.0-beta [email protected]:jfadev/jfa-pwa-toolkit.git $ mv jfa-pwa-toolkit my-pwa $ cd my-pwa/ $ touch index.html $ touch offline.html
Sencillo index.html skeleton (esqueleto completo en la documentación).
Pega este esqueleto en su index.html archivo.
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no" name="viewport">
<!-- Theme color -->
<meta name="theme-color" content="#000" />
<!-- PWA Manifest -->
<link rel="manifest" href="/pwa/manifest.json"></link>
<!-- Favicon -->
<link rel="icon" type="image/png" href="/pwa/icons/chrome/chrome-favicon-16-16.png">
<!-- Icons -->
<!-- Splash Screen -->
<title>JFA PWA Toolkit Example</title>
</head>
<body>
<!-- Load JFA PWA Toolkit Configs -->
<script type="text/javascript" src="/pwa/config.js"></script>
<!-- Load JFA PWA Toolkit Lib -->
<script type="text/javascript" src="/pwa/pwa.js"></script>
<!-- Register principal Service Worker -->
<script type="text/javascript">
PWA.ServiceWorker.register();
</script>
</body>
</html>
Pegar, por ejemplo, este simple html en su offline.html archivo.
<!DOCTYPE html>
<html lang="en-us">
<head>
<title>OFFLINE - JFA PWA Toolkit Example</title>
</head>
<body>
<p>No Internet connection!</p>
</body>
</html>
Simple example of manifest.json. Use app.webmanifest instead of manifest.json if you prefer.
{
"dir": "ltr",
"lang": "en-us",
"name": "Your App Name",
"scope": "/",
"display": "standalone",
"start_url": "/",
"short_name": "Your App Short Name",
"description": "Your App Description.",
"orientation": "any",
"theme_color": "#000",
"background_color": "#000",
"related_applications": [],
"prefer_related_applications": false,
"icons": [{
"src": "/pwa/icons/windows10/Square71x71Logo.scale-400.png",
"sizes": "284x284"
},
]
}
Ejemplo de un simple config.js
const PWA_CONFIG = {
app: {
name: 'your-app-name',
version: 'v1'
},
sw: {
filepath: '/sw.js',
offline_route: '/offline.html'
},
cache: {
images: {
active: true,
maxentries: 50,
maxageseconds: 24 * 60 * 60
},
statics: {
active: true,
maxentries: 50,
maxageseconds: 24 * 60 * 60
},
fonts: {
active: true,
maxentries: 50,
maxageseconds: 24 * 60 * 60
},
routes: {
networkfirst: {
active: true,
regex: /.*/
}
}
}
}
Ejemplos de código JS
Juega con más funciones con la variable de acceso global PWA en su código Javascript como en los siguientes ejemplos
Este ejemplo usa la biblioteca jQuery. En la documentación podrá encontrar ejemplos en puro ES6
Botón para suscribirse a Notificaciones Push
$('#btn1').click(() => {
if (
PWA.Notification.isDefault() ||
PWA.Notification.isGranted()
) {
PWA.Push.getSubscription((subscription) => {
if (subscription) {
$('#msg1').html('You are now subscribed to receive Push Notifications!');
} else {
PWA.Push.subscribe((r) => {
$('#msg1').html('Congratulations! You are subscribed to receive Push Notifications!');
});
}
});
} else {
$('#msg1').html("You've turned off Push Notifications. Allow Push Notifications in your browser settings.");
}
});
Checkbox para suscribirse / darse de baja de Notificaciones Push
$('#switch2').click(() => {
if (
PWA.Notification.isDefault() ||
PWA.Notification.isGranted()
) {
PWA.Push.getSubscription((subscription) => {
if (subscription) {
PWA.Push.unsubscribe((r) => {
$('#msg2').html('You have been unsubscribed to receive Push Notifications!');
});
} else {
PWA.Push.subscribe((r) => {
$('#msg2').html('You have been unsubscribed to receive Push Notifications!');
});
}
});
} else {
$('#msg2').html("You've turned off Push Notifications. Allow Push Notifications in your browser settings.");
}
});
Muestra pop-up solicitando permiso para permitir mostrar Notificaciones
$('#btn3').click(() => {
PWA.Notification.requestPermission((status) => {
$('#msg3').html(status);
});
});
Obtener el estado de permiso de Notificaciones
$('#btn4').click(() => {
var permission = PWA.Notification.getPermission();
$('#msg4').html(permission);
});
Mostrar Notificación enviadas por el navegador
$('#btn5').click(() => {
const options = {
body: 'Extra content to display within the notification',
icon: '../images/touch/chrome-touch-icon-192x192.png'
};
PWA.Notification.show('Notification Title', options, sent => {
if (sent) {
$('#msg5').html('The Notification has been sent');
}
});
});
Comprobar si el navegador soporta los Service Workers
$('#btn6').click(() => {
if (PWA.Navigator.isSupportedServiceWorker()) {
$('#msg6').html('This browser support Service Workers!');
} else {
$('#msg6').html('This browser does not support Service Workers.');
}
});
Comprobar si el navegador soporta las Notificaciones
$('#btn7').click(() => {
if (PWA.Navigator.isSupportedNotification()) {
$('#msg7').html('This browser support Notifications!');
} else {
$('#msg7').html('This browser does not support Notifications.');
}
});
Comprobar si el navegador está offline
$('#btn8').click(() => {
if (PWA.Navigator.isOffline()) {
$('#msg8').html('No Internet connection!');
} else {
$('#msg8').html('You have an Internet connection!');
}
});
Borrar la caché de la aplicación del navegador
$('#btn9').click(() => {
PWA.Navigator.clearCache();
});
Patio de Recreo
Juega con la biblioteca de PWA y aprende a usarla con facilidad.