Comment créer un écran hors ligne en Vue 3, Angular 14 ou React
Dans ce tutoriel, nous allons apprendre à créer un écran hors ligne dans des applications Vue 3, Angular 14 et React à l'aide du Network API. Le Network API fournit des informations sur le réseau et la connectivité, ce qui nous permet de gérer les scénarios hors ligne et d'offrir une meilleure expérience utilisateur. Pour des vérifications de joignabilité plus approfondies au-delà d'un simple indicateur en ligne/hors ligne, @capgo/capacitor-network-diagnostics peut tester la joignabilité des URL, les ports TCP et les poignées WebSocket depuis le natif code.
Prerequisites
Avant de commencer, assurez-vous d'avoir installé les éléments suivants :
- Node.js (version 14 ou supérieure)
- Vue CLI
- Angular CLI
- Créer une React App
Mise en place du projet
Créez d’abord un nouveau projet à l’aide de l’outil de scaffolding correspondant à chaque framework.
Vue 3
Ouvrez votre terminal et exécutez la commande suivante pour créer un nouveau projet Vue 3 :
vue create offline-screen-vue3
Choisissez le preset par défaut et attendez que le projet soit créé.
Angular 14
Ouvrez votre terminal et exécutez la commande suivante pour créer un nouveau projet Angular 14 :
ng new offline-screen-angular14
Suivez les prompts, et lorsqu'on vous demande des fonctionnalités supplémentaires, sélectionnez « Routing » en appuyant sur la barre d'espace. Attendez la création du projet.
React
Ouvrez votre terminal et exécutez la commande suivante pour créer un nouveau projet React :
npx create-react-app offline-screen-react
Attendez la création du projet.
Installation du API Network
Maintenant, installons le @capacitor/network package, qui fournit l’API Network.
Ouvrez votre terminal et accédez au répertoire de votre projet. Ensuite, exécutez la commande suivante pour installer le package :
npm install @capacitor/network
Pour les projets Capacitor, exécutez également la commande suivante pour synchroniser les fichiers du projet natif :
npx cap sync
Assurez-vous d'avoir installé Capacitor CLI globalement en exécutant :
npm install -g @capacitor/cli
Implémenter l'écran hors ligne
Ensuite, nous allons implémenter la fonctionnalité d'écran hors ligne dans chaque framework. Nous afficherons un message simple lorsque l'utilisateur passe hors ligne.
Vue 3
Dans votre projet Vue 3, ouvrez le fichier src/main.js et importez le module Network depuis @capacitor/network:
import { createApp } from 'vue';
import { Network } from '@capacitor/network';
const app = createApp(App);
// Your application setup
app.mount('#app');
Network.addListener('networkStatusChange', status => {
if (status.connected) {
// User is back online
// Hide the offline screen
document.getElementById('offline-screen').style.display = 'none';
} else {
// User is offline
// Display the offline screen
document.getElementById('offline-screen').style.display = 'block';
}
});
const logCurrentNetworkStatus = async () => {
const status = await Network.getStatus();
console.log('Network status:', status);
};
Dans le template de votre application (App.vue), ajoutez un <div> élément avec un id de offline-screen pour afficher le message de l'écran hors ligne :
<template>
<div id="app">
<div id="offline-screen">
<h1>You are offline</h1>
<p>Please check your internet connection and try again.</p>
</div>
<!-- Your application content -->
</div>
</template>
<style>
#offline-screen {
display: none;
text-align: center;
padding: 20px;
background-color: #f2f2f2;
}
#offline-screen h1 {
font-size: 24px;
}
#offline-screen p {
font-size: 16px;
}
</style>
Désormais, l'écran hors ligne s'affiche dès que l'utilisateur perd sa connexion. Lorsque l'utilisateur revient en ligne, l'écran hors ligne est masqué.
Angular 14
Dans votre projet Angular 14, ouvrez le src/app/app.component.ts et importez le module Network depuis @capacitor/network:
import { Component } from '@angular/core';
import { Network } from '@capacitor/network';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent {
constructor() {
Network.addListener('networkStatusChange', status => {
if (status.connected) {
// User is back online
// Hide the offline screen
document.getElementById('offline-screen').style.display = 'none';
} else {
// User is offline
// Display the offline screen
document.getElementById('offline-screen').style.display = 'block';
}
});
}
logCurrentNetworkStatus = async () => {
const status = await Network.getStatus();
console.log('Network status:', status);
};
}
Dans le template de votre application (app.component.html), ajoutez un <div> élément avec un id de offline-screen pour afficher le message de l'écran hors ligne :
<div id="offline-screen">
<h1>You are offline</h1>
<p>Please check your internet connection and try again.</p>
</div>
<!-- Your application content -->
Ajoutez les styles suivants au app.component.css fichier :
#offline-screen {
display: none;
text-align: center;
padding: 20px;
background-color: #f2f2f2;
}
#offline-screen h1 {
font-size: 24px;
}
#offline-screen p {
font-size: 16px;
}
Désormais, l'écran hors ligne s'affiche dès que l'utilisateur perd sa connexion. Lorsque l'utilisateur revient en ligne, l'écran hors ligne est masqué.
React
Dans votre projet React, ouvrez le src/App.js et importez le module Network depuis @capacitor/network:
import React, { useEffect } from 'react'
import { Network } from '@capacitor/network'
function App() {
useEffect(() => {
Network.addListener('networkStatusChange', (status) => {
if (status.connected) {
// User is back online
// Hide the offline screen
document.getElementById('offline-screen').style.display = 'none'
}
else {
// User is offline
// Display the offline screen
document.getElementById('offline-screen').style.display = 'block'
}
})
}, [])
const logCurrentNetworkStatus = async () => {
const status = await Network.getStatus()
console.log('Network status:', status)
}
return (
<div id="app">
<div id='offline-screen'>
<h1>You are offline</h1>
<p>Please check your internet connection and try again.</p>
</div>
{/* Your application content */}
</div>
)
}
export default App
Ajoutez les styles suivants au App.css fichier :
#offline-screen {
display: none;
text-align: center;
padding: 20px;
background-color: #f2f2f2;
}
#offline-screen h1 {
font-size: 24px;
}
#offline-screen p {
font-size: 16px;
}
Désormais, l'écran hors ligne s'affiche dès que l'utilisateur perd sa connexion. Lorsque l'utilisateur revient en ligne, l'écran hors ligne est masqué.
Méthodes et interfaces associées
Le réseau API fournit plusieurs méthodes et interfaces pour vous aider à gérer la connexion réseau. Voici les principales :
getStatus(): Interroger l'état actuel de la connexion réseau.addListener('networkStatusChange', ...): Écouter les changements de la connexion réseau.
Continuez avec l'écran hors ligne en Vue, Angular, React avec Capacitor
Si vous utilisez Écran hors ligne en Vue, Angular et React avec Capacitor pour planifier le comportement des médias et de l'interface natifs, connectez-l’à Utiliser @capgo/capacitor-live-activities pour la capacité native dans Utiliser @capgo/capacitor-live-activities @capgo/capacitor-live-activities pour le détail d'implémentation dans @capgo/capacitor-live-activities Utiliser @capgo/capacitor-video-player pour la fonctionnalité native dans la section Utiliser @capgo/capacitor-video-player, @capgo/capacitor-video-player pour les détails d'implémentation dans @capgo/capacitor-video-player, et Utilisation de @capgo/capacitor-native-navigation pour la fonctionnalité native dans Using @capgo/capacitor-native-navigation.