Expo Dom

作者 expocd752143d19eMIT2.6K 个星标收录于 2026年10月8日更新于 2026年10月8日仓库昨天更新

Framework (OSS). Use Expo DOM components to run web code in a webview on native and as-is on web. Migrate web code to native incrementally. For the end-to-end migration of a whole web app, use the expo-web-to-native skill.

AI 生成的概览

说明如何使用 Expo DOM 组件,让 Web 代码在原生端以 WebView 运行、在 Web 端原样渲染。

功能
该技能介绍 Expo DOM 组件:在文件顶部添加 'use dom' 指令后,Web 代码可在 iOS 和 Android 上通过 WebView 运行,在 Web 上则原样渲染。内容涵盖 DOM 组件的规则、dom 属性及其选项、以 props 传入异步原生函数、使用仅支持 Web 的库、CSS 处理、Expo Router 用法、环境检测、资源引用以及各平台行为。它产出的是说明与代码示例,而不是文件或脚本。
适用场景
适用于在 Expo 应用中引入仅支持 Web 的库(如图表或语法高亮库)、将现有 React Web 组件逐步迁移到原生端,或嵌入 HTML/CSS、iframe、Canvas、WebGL 内容。也适合在判断是否应采用 WebView 方案而非原生组件时参考。
运行要求
需要一个使用 React Native 和 expo/dom 模块的 Expo 项目;该技能不附带脚本,只有说明和代码示例。文档中提到的可选反馈命令通过 npx 运行,需要网络访问。

What are DOM Components?

DOM components allow web code to run verbatim in a webview on native platforms while rendering as-is on web. This enables using web-only libraries like recharts, react-syntax-highlighter, or any React web library in your Expo app without modification.

When to Use DOM Components

Use DOM components when you need:

  • Web-only libraries — Charts (recharts, chart.js), syntax highlighters, rich text editors, or any library that depends on DOM APIs
  • Migrating web code — Bring existing React web components to native without rewriting
  • Complex HTML/CSS layouts — When CSS features aren't available in React Native
  • iframes or embeds — Embedding external content that requires a browser context
  • Canvas or WebGL — Web graphics APIs not available natively

When NOT to Use DOM Components

Avoid DOM components when:

  • Native performance is critical — Webviews add overhead
  • Simple UI — React Native components are more efficient for basic layouts
  • Deep native integration — Use local modules instead for native APIs
  • Layout routes — _layout files cannot be DOM components

Basic DOM Component

Create a new file with the 'use dom'; directive at the top:

tsx
// components/WebChart.tsx"use dom";
export default function WebChart({  data,}: {  data: number[];  dom: import("expo/dom").DOMProps;}) {  return (    <div style={{ padding: 20 }}>      <h2>Chart Data</h2>      <ul>        {data.map((value, i) => (          <li key={i}>{value}</li>        ))}      </ul>    </div>  );}

Rules for DOM Components

  1. Must have 'use dom'; directive at the top of the file
  2. Single default export — One React component per file
  3. Own file — Cannot be defined inline or combined with native components
  4. Serializable props only — Strings, numbers, booleans, arrays, plain objects
  5. Include CSS in the component file — DOM components run in isolated context

The dom Prop

Every DOM component receives a special dom prop for webview configuration. Always type it in your props:

tsx
"use dom";
interface Props {  content: string;  dom: import("expo/dom").DOMProps;}
export default function MyComponent({ content }: Props) {  return <div>{content}</div>;}

Common dom Prop Options

tsx
// Disable body scrolling<DOMComponent dom={{ scrollEnabled: false }} />
// Flow under the notch (disable safe area insets)<DOMComponent dom={{ contentInsetAdjustmentBehavior: "never" }} />
// Control size manually<DOMComponent dom={{ style: { width: 300, height: 400 } }} />
// Combine options<DOMComponent  dom={{    scrollEnabled: false,    contentInsetAdjustmentBehavior: "never",    style: { width: '100%', height: 500 }  }}/>

Exposing Native Actions to the Webview

Pass async functions as props to expose native functionality to the DOM component:

tsx
// app/index.tsx (native)import { Alert } from "react-native";import DOMComponent from "@/components/dom-component";
export default function Screen() {  return (    <DOMComponent      showAlert={async (message: string) => {        Alert.alert("From Web", message);      }}      saveData={async (data: { name: string; value: number }) => {        // Save to native storage, database, etc.        console.log("Saving:", data);        return { success: true };      }}    />  );}
tsx
// components/dom-component.tsx"use dom";
interface Props {  showAlert: (message: string) => Promise<void>;  saveData: (data: {    name: string;    value: number;  }) => Promise<{ success: boolean }>;  dom?: import("expo/dom").DOMProps;}
export default function DOMComponent({ showAlert, saveData }: Props) {  const handleClick = async () => {    await showAlert("Hello from the webview!");    const result = await saveData({ name: "test", value: 42 });    console.log("Save result:", result);  };
  return <button onClick={handleClick}>Trigger Native Action</button>;}

Using Web Libraries

DOM components can use any web library:

tsx
// components/syntax-highlight.tsx"use dom";
import SyntaxHighlighter from "react-syntax-highlighter";import { docco } from "react-syntax-highlighter/dist/esm/styles/hljs";
interface Props {  code: string;  language: string;  dom?: import("expo/dom").DOMProps;}
export default function SyntaxHighlight({ code, language }: Props) {  return (    <SyntaxHighlighter language={language} style={docco}>      {code}    </SyntaxHighlighter>  );}
tsx
// components/chart.tsx"use dom";
import {  LineChart,  Line,  XAxis,  YAxis,  CartesianGrid,  Tooltip,} from "recharts";
interface Props {  data: Array<{ name: string; value: number }>;  dom: import("expo/dom").DOMProps;}
export default function Chart({ data }: Props) {  return (    <LineChart width={400} height={300} data={data}>      <CartesianGrid strokeDasharray="3 3" />      <XAxis dataKey="name" />      <YAxis />      <Tooltip />      <Line type="monotone" dataKey="value" stroke="#8884d8" />    </LineChart>  );}

CSS in DOM Components

CSS imports must be in the DOM component file since they run in isolated context:

tsx
// components/styled-component.tsx"use dom";
import "@/styles.css"; // CSS file in same directory
export default function StyledComponent({  dom,}: {  dom: import("expo/dom").DOMProps;}) {  return (    <div className="container">      <h1 className="title">Styled Content</h1>    </div>  );}

Or use inline styles / CSS-in-JS:

tsx
"use dom";
const styles = {  container: {    padding: 20,    backgroundColor: "#f0f0f0",  },  title: {    fontSize: 24,    color: "#333",  },};
export default function StyledComponent({  dom,}: {  dom: import("expo/dom").DOMProps;}) {  return (    <div style={styles.container}>      <h1 style={styles.title}>Styled Content</h1>    </div>  );}

Expo Router in DOM Components

The expo-router <Link /> component and router API work inside DOM components:

tsx
"use dom";
import { Link, useRouter } from "expo-router";
export default function Navigation({  dom,}: {  dom: import("expo/dom").DOMProps;}) {  const router = useRouter();
  return (    <nav>      <Link href="/about">About</Link>      <button onClick={() => router.push("/settings")}>Settings</button>    </nav>  );}

Router APIs That Require Props

These hooks don't work directly in DOM components because they need synchronous access to native routing state:

  • useLocalSearchParams()
  • useGlobalSearchParams()
  • usePathname()
  • useSegments()
  • useRootNavigation()
  • useRootNavigationState()

Solution: Read these values in the native parent and pass as props:

tsx
// app/[id].tsx (native)import { useLocalSearchParams, usePathname } from "expo-router";import DOMComponent from "@/components/dom-component";
export default function Screen() {  const { id } = useLocalSearchParams();  const pathname = usePathname();
  return <DOMComponent id={id as string} pathname={pathname} />;}
tsx
// components/dom-component.tsx"use dom";
interface Props {  id: string;  pathname: string;  dom?: import("expo/dom").DOMProps;}
export default function DOMComponent({ id, pathname }: Props) {  return (    <div>      <p>Current ID: {id}</p>      <p>Current Path: {pathname}</p>    </div>  );}

Detecting DOM Environment

Check if code is running in a DOM component:

tsx
"use dom";
import { IS_DOM } from "expo/dom";
export default function Component({  dom,}: {  dom?: import("expo/dom").DOMProps;}) {  return <div>{IS_DOM ? "Running in DOM component" : "Running natively"}</div>;}

Assets

Prefer requiring assets instead of using the public directory:

tsx
"use dom";
// Good - bundled with the componentconst logo = require("../assets/logo.png");
export default function Component({  dom,}: {  dom: import("expo/dom").DOMProps;}) {  return <img src={logo} alt="Logo" />;}

Usage from Native Components

Import and use DOM components like regular components:

tsx
// app/index.tsximport { View, Text } from "react-native";import WebChart from "@/components/web-chart";import CodeBlock from "@/components/code-block";
export default function HomeScreen() {  return (    <View style={{ flex: 1 }}>      <Text>Native content above</Text>
      <WebChart data={[10, 20, 30, 40, 50]} dom={{ style: { height: 300 } }} />
      <CodeBlock        code="const x = 1;"        language="javascript"        dom={{ scrollEnabled: true }}      />
      <Text>Native content below</Text>    </View>  );}

Platform Behavior

PlatformBehavior
iOSRendered in WKWebView
AndroidRendered in WebView
WebRendered as-is (no webview wrapper)

On web, the dom prop is ignored since no webview is needed.

Tips

  • DOM components hot reload during development
  • Keep DOM components focused — don't put entire screens in webviews
  • Use native components for navigation chrome, DOM components for specialized content
  • Test on all platforms — web rendering may differ slightly from native webviews
  • Large DOM components may impact performance — profile if needed
  • The webview has its own JavaScript context — cannot directly share state with native

Submitting Feedback

If you encounter errors, misleading or outdated information in this skill, report it so Expo can improve:

bash
npx --yes submit-expo-feedback@latest --category skills --subject "expo-dom" "<actionable feedback>"

Only submit when you have something specific and actionable to report. Include as much relevant context as possible. If an AI agent repeatedly failed or the user had to take over an Expo task, load the expo-skill-feedback skill and follow its eval-candidate flow instead of reusing the command above.

来源与署名

来源:expo/skills位于plugins/expo/skills/expo-dom提交cd75214

许可证: MIT

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架