# @appsemble/preact 中文文档

规范地址：https://npmcn.com/package/%40appsemble/preact/

版本：0\.40\.9
npm 元数据更新时间：2026-10-29T22:57:28.984Z
中文译文更新时间：2026-11-08T01:18:11.307Z
软件包许可：LGPL-3\.0-only

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40appsemble/preact
原文对照：https://npmcn.com/package/%40appsemble/preact/?lang=original
项目主页：https://appsemble.app/
源码仓库：https://gitlab.com/appsemble/appsemble

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：15 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：preact ^10，@appsemble/sdk 0\.40\.9
- 首次发布：2020-03-20T17:06:56.330Z
- 最新版本发布：2026-10-29T22:57:28.637Z
- 近 30 天下载量：1939（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：367（近 12 个月 62 个）

## 中文简介

使用 Preact 构建自己的块

## 安装

```sh
npm install @appsemble/preact
```

也可以使用：`pnpm add @appsemble/preact`、`yarn add @appsemble/preact`、`bun add @appsemble/preact`

## README

# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.40.9/config/assets/logo.svg) 应用 Preact SDK

> 使用 Preact 构建自己的块

[![npm](https://img.shields.io/npm/v/@appsemble/preact)](https://www.npmjs.com/package/@appsemble/preact) [![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.40.9/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.40.9) [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io/)

## 目录

-   [安装](https://npmcn.com/package/%40appsemble/preact/#readme-installation)
-   [使用量](https://npmcn.com/package/%40appsemble/preact/#readme-usage)
    -   [`bootstrap()`](https://npmcn.com/package/%40appsemble/preact/#readme-bootstrap)
    -   [`useBlock()`](https://npmcn.com/package/%40appsemble/preact/#readme-useblock)
    -   [`<FormattedMessage />`](https://npmcn.com/package/%40appsemble/preact/#readme-formattedmessage-)
-   [许可证](https://npmcn.com/package/%40appsemble/preact/#readme-license)

## 安装

```sh
npm install @appsemble/preact preact
```

## 使用量

此软件包集成 [预录](https://preactjs.com/) 与 [`@appsemble/sdk`](https://www.npmjs.com/package/@appsemble/sdk)请阅读文档 更了解如何使用它.

### `bootstrap()`

拖曳函数将 Preact 组件作为参数并生成 。 它需要像样的东西 块上下文作为其道具,随 `ready()` 函数。 这个 `ready()` 函数需要 当块完成渲染时调用。 行动不会在页面上完成, 直到所有街区都准备好了.

```tsx
import { bootstrap } from '@appsemble/preact';
import { useEffect } from 'preact/hooks';

bootstrap(({ actions }) => {
  useEffect(() => {
    ready();
  }, []);

  return (
    <button onClick={() => actions.onClick()} type="button">
      Hello world!
    </button>
  );
});
```

**说明**: 剧本只装入一次. 部件会被拖入每个实例 由应用程序创建者加载的块类型.

### `useBlock()`

获取块背景。 用于在树下树下生产的组件 提供组件 [`bootstrap`](https://npmcn.com/package/%40appsemble/preact/#readme-bootstrap)

```tsx
import { useBlock } from '@appsemble/preact';
import { type VNode } from 'preact';

export function MyButton(): VNode {
  const { actions } = useBlock();

  return (
    <button onClick={() => actions.onClick()} type="button">
      Hello world!
    </button>
  );
}
```

### `<FormattedMessage />`

此帮助组件会生成一个已翻译的消息ID .

```tsx
import { FormattedMessage } from '@appsemble/preact';
import { type VNode } from 'preact';

interface MyButtonProps {
  readonly name: string;
}

export function MyButton({ name }: MyButtonProps): VNode {
  return (
    <button type="button">
      <FormattedMessage id="myButtonLabel" values={{ name }} />
    </button>
  );
}
```

## 许可证

[LGPL-3.0 仅限](https://gitlab.com/appsemble/appsemble/-/blob/0.40.9/LICENSE.md) © [应用](https://appsemble.com/)

## 常见问题

### @appsemble/preact 是什么？

使用 Preact 构建自己的块

### 如何安装 @appsemble/preact？

在项目目录运行 npm install @appsemble/preact，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：preact（^10）、@appsemble/sdk（0\.40\.9）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @appsemble/preact 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @appsemble/preact 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @appsemble/preact 可以商用吗？

@appsemble/preact 使用 LGPL-3\.0-only 许可。弱 Copyleft：作为库被调用时通常不要求开源你自己的代码，但修改库本身需以 LGPL 开源；前端打包合并后的适用边界存在不同理解。以上为概括，不构成法律意见，请以许可原文为准。

### @appsemble/preact 的下载量有多少？

根据 npm 官方下载统计，@appsemble/preact 在 2026/10/07 – 2026/11/05 这 30 天内被下载 1,939 次，日均约 65 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @appsemble/preact 还在维护吗？

最新版本 0\.40\.9 发布于 2026/10/30（9 天前）；至今共发布 367 个版本，其中过去 12 个月发布了 62 个；首次发布于 2020/03/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。