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

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

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

安装

Terminal
npx expo install expo-dev-client

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

在应用配置中配置

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

Example app.json with config plugin

app.json
{ "expo": { "plugins": [ [ "expo-dev-client", { "launchMode": "most-recent" } ] ] } }

Configurable properties

NameDefaultDescription
launchMode"most-recent"

决定是启动最近打开的项目,还是导航到启动器屏幕。

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

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

TV 支持

  • 此库仅在 SDK 54 及更高版本中支持 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