Reference version

This documentation is available as Markdown for AI agents and LLMs. See the full Markdown index or append .md to any documentation URL.

Expo DevClient iconExpo DevClient

一个允许创建开发构建并包含实用开发工具的库。

Android
iOS
tvOS
Recommended version:
~57.0.1

expo-dev-client 为你的调试构建添加了各种有用的开发工具:

Expo 文档将包含 expo-dev-client 的调试构建称为开发构建

安装

Terminal
npx expo install expo-dev-client

如果你要在一个现有的 React Native 应用中安装,请先在你的项目中安装expo。然后,按照在现有 React Native 项目中安装 expo-dev-client中的说明进行操作。

应用配置中的配置

如果你在项目中使用配置插件(Continuous Native Generation (CNG)),可以使用其内置的 config plugin 来配置开发客户端启动器。该插件允许你配置各种无法在运行时设置的属性,这些属性需要构建一个新的应用二进制文件后才会生效。如果你的应用使用 CNG,那么你需要手动配置该库。

Example app.json with config plugin

app.json
{ "expo": { "plugins": [ [ "expo-dev-client", { "launchMode": "most-recent", "defaultLaunchURL": "http://localhost:8081", "android": { "defaultLaunchURL": "http://10.0.0.2:8081" } } ] ] } }

Configurable properties

NameDefaultDescription
launchMode"most-recent"

决定是启动最近一次打开的项目,还是跳转到启动器屏幕。

  • most-recent - 尝试直接启动到之前打开的项目;如果无法连接,则回退到启动器屏幕。
  • launcher - 打开启动器屏幕。
addGeneratedSchemetrue

默认情况下,expo-dev-client 会注册一个自定义 URL scheme 来打开项目。将此属性设为 false 可禁用该 scheme。

defaultLaunchURL-

直接启动到此 URL,而不是跳转到启动器屏幕。 如果 launchMode 设置为 most-recent,则启动器会将 defaultLaunchURL 作为回退选项。

android.launchMode"most-recent"
Only for:
Android

决定在 Android 上是启动最近一次打开的项目,还是跳转到启动器屏幕。仅为 Android 覆盖顶层的 launchMode 设置。

  • most-recent - 尝试直接启动到之前打开的项目;如果无法连接,则回退到启动器屏幕。
  • launcher - 打开启动器屏幕。
ios.launchMode"most-recent"
Only for:
iOS

决定在 iOS 上是启动最近一次打开的项目,还是跳转到启动器屏幕。仅为 iOS 覆盖顶层的 launchMode 设置。

  • most-recent - 尝试直接启动到之前打开的项目;如果无法连接,则回退到启动器屏幕。
  • launcher - 打开启动器屏幕。
android.defaultLaunchURL-
Only for:
Android

直接启动到此 URL,而不是跳转到启动器屏幕。 如果 launchMode 设置为 most-recent,则启动器会将 defaultLaunchURL 作为回退选项。

ios.defaultLaunchURL-
Only for:
iOS

直接启动到此 URL,而不是跳转到启动器屏幕。 如果 launchMode 设置为 most-recent,则启动器会将 defaultLaunchURL 作为回退选项。

TV 支持

  • 此库仅在 SDK 54 及更高版本中支持 TV。
    • Android TV:支持所有操作,与 Android 手机类似。
    • Apple TV:支持使用本地或隧道化打包器进行基本操作。尚不支持 EAS 认证以及 EAS 构建和更新列表。

API

import * as DevClient from 'expo-dev-client';

Methods

DevClient.closeMenu()

A method that closes development client menu when called.

Returns:
void

DevClient.hideMenu()

A method that hides development client menu when called.

Returns:
void

DevClient.openMenu()

A method that opens development client menu when called.

Returns:
void

DevClient.registerDevMenuItems(items)

ParameterType
itemsExpoDevMenuItem[]

A method that allows to specify custom entries in the development client menu.

Returns:
Promise<void>

Types

ExpoDevMenuItem

An object representing the custom development client menu entry.

PropertyTypeDescription
callback() => void

Callback to fire, when user selects an item.

namestring

Name of the entry, will be used as label.

shouldCollapse(optional)boolean

A boolean specifying if the menu should close after the user interaction.

Default:false