NarraLeaf
NarraLeaf Desktop

安装

安装 NarraLeaf CLI、运行时包与 peer dependencies

NarraLeaf 项目会用到两个包入口:

  • narraleaf-cli 提供 narraleaf 命令
  • narraleaf 提供主进程运行时、渲染入口和构建配置类型

安装 CLI

当你需要初始化、运行、检查或打包 NarraLeaf 项目时,请使用 CLI

npm install -g narraleaf-cli
yarn global add narraleaf-cli
pnpm add -g narraleaf-cli

安装完成后,命令名称是 narraleaf

narraleaf --version

在项目中安装

如果你要把 NarraLeaf 加入已有应用,请安装运行时包及其 peer dependencies

npm install narraleaf narraleaf-react react react-dom electron electron-builder
npm install -D narraleaf-cli typescript
yarn add narraleaf narraleaf-react react react-dom electron electron-builder
yarn add -D narraleaf-cli typescript
pnpm add narraleaf narraleaf-react react react-dom electron electron-builder
pnpm add -D narraleaf-cli typescript

注意: 当前运行时面向 React 19 与 Electron 34 兼容项目

包入口

NarraLeaf 暴露三个运行时入口:

import { AppConfig } from "narraleaf";
import { render, useApp } from "narraleaf/renderer";
import { BuildTarget } from "narraleaf/config";
  • narraleafnarraleaf/main 暴露主进程 API
  • narraleaf/renderer 暴露渲染器 helpers、hooks 和类型
  • narraleaf/config 暴露构建配置 helpers 与 target 类型

下一步

本页目录