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:
~56.0.19

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

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

安装

Terminal
npx expo install expo-dev-client

当你使用 EAS Build 创建构建时,请在 eas.json 中的某个构建配置文件里将 developmentClient 设置为 true。如果不这样做,EAS Build 会生成一个不包含开发工具的独立构建。例如:

eas.json
{ "build": { "development": { "developmentClient": true, "distribution": "internal" %%placeholder-start%%... %%placeholder-end%% } } %%placeholder-start%%... %%placeholder-end%% }

有关更多信息,请参阅 eas.json 参考文档中的 developmentClient 属性

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

在 app 配置中进行配置

如果你在项目中使用 config plugins(Continuous Native Generation (CNG)),你可以使用其内置的 config plugin 来配置 development client 启动器。该插件允许你配置各种无法在运行时设置、且需要构建新的应用二进制文件才能生效的属性。如果你的应用使用 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" }, "toolsButton": true, "skipOnboarding": false, "showMenuAtLaunch": true } ] ] } }

Configurable properties

NameDefaultDescription
launchMode"most-recent"

决定是启动最近打开的项目,还是进入启动器屏幕。

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

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

defaultLaunchURL-

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

toolsButtontrue

是否显示悬浮工具按钮。

skipOnboardingfalse

跳过应用首次启动时在开发者菜单中显示的引导屏幕。

showMenuAtLaunchtrue

在启动应用后立即显示开发者菜单。

TV 支持

  • Android TV:支持所有操作,类似于 Android 手机。
  • Apple TV:支持使用本地或隧道式 packager 的基本操作。目前尚不支持 EAS 身份验证,以及列出 EAS 构建和更新。

API

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

Methods

DevClient.closeMenu()

Android
iOS
tvOS

A method that closes development client menu when called.

Returns:
void

DevClient.hideMenu()

Android
iOS
tvOS

A method that hides development client menu when called.

Returns:
void

DevClient.openMenu()

Android
iOS
tvOS

A method that opens development client menu when called.

Returns:
void

DevClient.registerDevMenuItems(items)

Android
iOS
tvOS
ParameterType
itemsExpoDevMenuItem[]

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

Returns:
Promise<void>

Types

ExpoDevMenuItem

Android
iOS
tvOS

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