如何在 Vue 3、Angular 14 或 React 中创建离线屏幕

本教程将教您如何使用 Network API 在 Vue 3、Angular 14 和 React 应用程序中创建离线屏幕。 Network API 提供网络和连接信息，使我们能够处理离线场景并提供更好的用户体验。要进行更深入的可达性检查， @capgo/capacitor-network-diagnostics 可以测试 URL 可达性、TCP 端口和 WebSocket 握手，从本机 code 中测试。

先决条件

在开始之前，请确保您安装了以下内容：

Node.js (版本 14 或更高)
Vue CLI
Angular CLI
Create React App

设置项目

首先，让我们使用各个框架的脚手架工具创建一个新的项目。

Vue 3

打开终端并运行以下命令创建一个新的 Vue 3 项目：

vue create offline-screen-vue3

选择默认预设并等待项目创建完成。

Angular 14

打开终端并运行以下命令创建一个新的 Angular 14 项目：

ng new offline-screen-angular14

遵循提示，到询问额外功能时，使用 键选择“路由”。等待项目创建完成。 React

打开终端并运行以下命令创建一个新的 React 项目：

等待项目创建完成。

npx create-react-app offline-screen-react

spacebar

安装网络API

现在，让我们安装 @capacitor/network 包，提供网络API。

打开您的终端并导航到您的项目目录。然后，运行以下命令安装包：

npm install @capacitor/network

对于Capacitor项目，还要运行以下命令同步本机项目文件：

npx cap sync

确保您已全局安装Capacitor CLI，通过运行：

npm install -g @capacitor/cli

实现离线屏幕

下一步，我们将在每个框架中实现离线屏幕功能。我们将在用户脱机时显示一个简单的消息。

Vue 3

在您的Vue 3项目中，打开 src/main.js 文件并导入 Network 模块 @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);
};

在您的应用程序模板 (App.vue）中，添加一个 <div> 元素，id 为 offline-screen 以显示离线屏幕消息：

<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>

现在，当用户脱机时，会显示离线屏幕。当用户重新上线时，离线屏幕会被隐藏。

Angular 14

在您的Angular 14项目中，打开 src/app/app.component.ts 文件并导入 Network 模块从 @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);
  };

}

在您的应用程序模板 (app.component.html）中，添加一个 <div> 元素，id 为 offline-screen 显示离线屏幕消息:

<div id="offline-screen">
  <h1>You are offline</h1>
  <p>Please check your internet connection and try again.</p>
</div>

<!-- Your application content -->

添加以下样式到文件: app.component.css 文件:

#offline-screen {
  display: none;
  text-align: center;
  padding: 20px;
  background-color: #f2f2f2;
}

#offline-screen h1 {
  font-size: 24px;
}

#offline-screen p {
  font-size: 16px;
}

现在，当用户脱离网络时，会显示离线屏幕。当用户重新上线时，离线屏幕会被隐藏。

React

在您的React项目中，打开文件并导入模块 src/App.js 模块 Network 添加以下样式到文件: @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

文件: App.css 现在，当用户脱离网络时，会显示离线屏幕。当用户重新上线时，离线屏幕会被隐藏。

#offline-screen {
  display: none;
  text-align: center;
  padding: 20px;
  background-color: #f2f2f2;
}

#offline-screen h1 {
  font-size: 24px;
}

#offline-screen p {
  font-size: 16px;
}

支持的方法和接口

offlineScreenMessage: __CAPGO_KEEP_0__

The Network API 提供了多种方法和接口来帮助您处理网络连接。以下是其中一些关键的：

getStatus()：查询当前网络连接的状态。
addListener('networkStatusChange', ...)：监听网络连接的变化。

从 Vue、Angular、React 中的 Offline Screen 继续进行，使用 Capacitor

如果您正在使用 Offline Screen 在 Vue、Angular、React 中，使用 Capacitor 来规划原生媒体和界面行为，连接它到使用 @capgo/capacitor-live-activities 为原生能力在使用 @capgo/capacitor-live-activities 中 @capgo/capacitor-live-activities 为 @capgo/capacitor-live-activities 的实现细节使用 @capgo/capacitor-video-player 使用 @capgo/capacitor-video-player 的原生能力 @capgo/capacitor-video-player 使用 @capgo/capacitor-video-player 的实现细节使用 @capgo/capacitor-native-navigation 使用 @capgo/capacitor-native-navigation 的原生能力