API

模块

nsh 应用用到的一切都从一小组模块导入。这些模块全部是原生的:响应式图、渲染器和每个模块都在运行时内部用 Rust 实现,打包器会把 import ... from "nsh/..." 原样保留为导入,而不会把代码复制进你的 bundle。你的 bundle 里只有你自己的代码。

import { mount, signal } from "nsh";
import { createNativeValue } from "nsh/animated";
import { windowSize } from "nsh/device";
import { Button, SafeAreaView } from "nsh/ui/mobile";

#两层模块

  • nsh 和 nsh/<module> 是基础能力和运行环境:响应式、列表、画布、动画、手势、设备信息。所有 UI 套件都构建在它们之上。
  • nsh/ui/<set> 是面向某一种设备形态的完整 UI。目前只有 nsh/ui/mobile:导航、模态框、状态栏、系统对话框,以及 Button、TextField 等组件(见组件)。

nsh 没有“大而全”的汇总模块:每个 API 只存在于一个地方。平台专有的 API 位于 nsh/ios 和 nsh/android;这两个模块在所有平台上都可以导入,因此同一个 bundle 可以在所有平台运行(在其他平台上调用它们什么也不做,isAvailable 告诉你当前是否在该平台上)。

类型声明由运行时生成:nsh init、nsh build、nsh dev 和 nsh trace 会在应用旁边写出 .nsh/types,所以 TypeScript 声明始终与你所用的运行时一致(见项目结构)。

#全部模块

模块导出页面
nshsignal、computed、effect、batch、untracked、cleanup、context、split、mount;View、Text、Scroll、Input;元素、样式、事件和 JSX 的类型(YNode、ViewStyle 等)nsh
nsh/animatedcreateNativeValue、NativeValue、NativeNode、Animated、Easing、LayoutAnimationnsh/animated
nsh/listList(虚拟化、可复用单元格的列表)nsh/list
nsh/canvasCanvas、Path2D、CanvasRenderingContext2D、CanvasGradientnsh/canvas
nsh/devicewindowSize、colorScheme、fontScale、Platform、PixelRatio、I18nManagernsh/device
nsh/gesturePanRespondernsh/gesture
nsh/imageImage(元素)、Image.getSize、Image.prefetchnsh/image
nsh/nativenativeComponent(宿主应用注册的原生组件)nsh/native
nsh/accessibilityAccessibilityInfo、screenReaderEnabled、reduceMotionnsh/accessibility
nsh/iosisAvailable、InputAccessoryViewnsh/ios
nsh/androidisAvailable、Toast、BackHandler、setStatusBarBackgroundColornsh/android
nsh/webviewWebViewnsh/webview
nsh/videoVideonsh/video
nsh/ui/mobile导航(createNavigator、Stack、Screen、Modal)、SafeAreaView、StatusBar、Alert、ActionSheet、Keyboard、Button、TextField 等组件
全局对象fetch、URL、TextEncoder、Blob、FormData、AbortController、定时器、console、requestAnimationFrame 等(无需导入)Web API

以下参考页面不对应模块:

页面内容
样式参考每个样式键的类型和含义
Tailwind 参考class 支持的 Tailwind 工具类和变体

#宿主元素

宿主元素和其他一切一样是需要导入的组件:View、Text、Scroll、Input 来自 nsh,Image 来自 nsh/image,List 来自 nsh/list,Canvas、WebView、Video 来自各自的模块,Modal 来自 nsh/ui/mobile,InputAccessoryView 来自 nsh/ios。只有 If 和 Each 是全局组件。编译器会就地创建这些元素,所以导入在运行时没有任何开销。它们的属性见元素。