# @deltabreen/help-nativescript 中文文档
规范地址：https://npmcn.com/package/%40deltabreen/help-nativescript/
版本：0\.1\.1
npm 元数据更新时间：2026-10-31T22:00:17.483Z
中文译文更新时间：2026-10-31T22:55:57.074Z
软件包许可：MIT
本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。
原始 npm 页面：https://www.npmjs.com/package/%40deltabreen/help-nativescript
原文对照：https://npmcn.com/package/%40deltabreen/help-nativescript/?lang=original
项目主页：https://help.deltabreen.eu/docs/apps
## 关键信息（来自 npm 元数据）
- 包体积（解压后）：33.2 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@nativescript/core \>=8\.6
- 首次发布：2026-10-31T21:16:05.967Z
- 最新版本发布：2026-10-31T22:00:17.340Z
- 已发布版本数：3（近 12 个月 3 个）
## 中文简介
DeltaBreen为NativeScript提供的帮助：应用程序中的帮助台。应用程序屏幕上的支持表单和用户自己的票证，登录用户，每部手机的钥匙，以及表单的事件。Plain, Angular, Vue， Svelte和React。
## 安装
```sh
npm install @deltabreen/help-nativescript
```
也可以使用：`pnpm add @deltabreen/help-nativescript`、`yarn add @deltabreen/help-nativescript`、`bun add @deltabreen/help-nativescript`
## README
# DeltaBreen对NativeScript的帮助
在你的应用程序中的帮助台：支持表单和用户自己的票，与你的团队的答复，在屏幕上的 原生脚本应用，支持纯原生脚本、Angular、Vue、Svelte或React。它在web视图中显示帮助自己的表单 你的应用程序在没有你的版本的情况下得到我们的修复，并将它的事件交还给你的代码。
```sh
npm install @deltabreen/help-nativescript
```
在Android上，它添加了 `androidx.webkit` 到你的应用程序，它保留了用户和表单的事件 页面的来源。
## 在你的网站页面上
在你的网站上创建一个页面，只包含表单和用户自己的门票，地址如下 `https://acme.com/app-support` (你的网站的 **安装** TAB有它，用你的键，当网站是 **手机应用程序**）。 然后用 `HelpView`：
```xml
```
在框架中，注册一次视图，然后像使用其他视图一样使用它：
```js
// Angular, in main.ts; the component that shows it lists NO_ERRORS_SCHEMA in its schemas
import { registerElement } from '@nativescript/angular'
import { HelpView } from '@deltabreen/help-nativescript'
registerElement('HelpView', () => HelpView)
//
// Vue, in app.js
import { registerElement } from 'nativescript-vue'
import { HelpView } from '@deltabreen/help-nativescript'
registerElement('HelpView', () => HelpView)
//
// Svelte Native, in app.ts
import { registerNativeViewElement } from 'svelte-native/dom'
import { HelpView } from '@deltabreen/help-nativescript'
registerNativeViewElement('helpView', () => HelpView)
//
// React NativeScript
import { registerElement } from 'react-nativescript'
import { HelpView } from '@deltabreen/help-nativescript'
registerElement('helpView', () => HelpView)
//
```
给它的高度，它应该填充，像任何视图：一行 `GridLayout` 与 `*`，或整页。你的网站 验证域名是什么让你的活键工作，因为它在网站本身。链接到您的网站留在 应用程序;其他任何东西，比如团队回复中的文件，都会在手机浏览器中打开。的表单按钮 添加文件将打开手机自己的选择器。
在iPhone上，这个选择器提供“拍照”功能，iOS会关闭一个打开相机的应用程序，而不会说明原因。添加这个 来 `App_Resources/iOS/Info.plist`， iOS在询问以下问题时应该显示：
```xml
NSCameraUsageDescription
To send a photo to support.
```
## 登录用户
一个用户登录到你的应用程序，不输入他们的电子邮件，就可以看到他们自己的票和你的票 回答。你的 **服务器** 签署一个简短的令牌，说明他们是谁，与您的网站的秘密 （[该指南](https://help.deltabreen.eu/docs/embed#logged-in-users) 有代码)。每次都向服务器请求一个 屏幕打开并将其设置为 `token`;它在脚本运行之前被传递给页面，而不是传递给其他站点。没有 首先，表格将他们视为客人。
## 你的应用程序没有网站
离开 `src` 给出你的网站的关键字：视图携带页面本身。在门户中，选择 **我的应用没有 网站** 为网站。你的实时密钥对登录到你的应用程序的人有效，如果你打开它，对于 **有人有你的应用吗？**，通过为电话制作的键，第一次支持打开：
```ts
import { deviceKey } from '@deltabreen/help-nativescript'
export const help = { siteKey: 'pk_live_…', deviceKey: deviceKey() }
//
```
`deviceKey()` 创建一次密钥并将其保存在应用程序的设置中。将其保存在Keychain或Keystore中 相反，把它递给我 `new SecureStorage()` 从 `@nativescript/secure-storage`． 给出一个登录用户的 `token` 而不是 在有密钥的地方：我们建议尽可能通过您自己的服务器登录您的用户，因为密钥在一个 App可以拿出来，只有登录的用户不能补。
没有网站， `show` 选择表单、票证或两者（默认值），和 `lang`， `accent`， `labels`， `subject` 和 `fields` 元素是自己的吗 [嵌入指南](https://help.deltabreen.eu/docs/embed#the-element). 一、 `deviceKey` 的 `null` 等待：页面在设置后加载。
`pageCss` 是你自己的CSS页面，在我们之后：它的背景和类型，并通过其自定义的形式 属性和部件。把一屏票放在另一个位置， `show="tickets"`：
```xml
```
## 事件
每个事件的 `detail` 上面写着发生了什么：
| 事件 | 当 |
| --- | --- |
| `sent` | 发送了一条消息： `{ number }` |
| `error` | 它不可能是： `{ code }` |
| `replied` | 他们回答了一张罚单： `{ number }` |
| `closed` | 他们标记了一张解决了的罚单： `{ number }` |
| `rated` | 他们给了1分： `{ number, stars }` |
| `unread` | 你的团队有多少回复他们没有读过？ `{ unread }` |
| `view` | 他们打开的票证，或者列表为空： `{ ticket }` |
```ts
helpView.on('unread', ({ detail }) => (badge.text = String(detail.unread)))
```
在屏幕关闭时告诉人们回复，a [webhook](https://help.deltabreen.eu/docs/api#webhooks) (箴 可以发送应用程序自己的通知。
## 你自己的网页视图
`helpPage({ siteKey, … }, { token, deviceKey })` 页面是一个没有网站显示的应用程序吗 `helpScript({ token, deviceKey })` 在网站页面脚本之前运行的内容。页面的事件以JSON形式到达 `deltahelp` 命名 每个，张贴至 `window.webkit.messageHandlers.deltahelp` 在iPhone或 `window.DeltaHelpBridge` 在Android上。
## 常见问题
### @deltabreen/help-nativescript 是什么？
DeltaBreen为NativeScript提供的帮助：应用程序中的帮助台。应用程序屏幕上的支持表单和用户自己的票证，登录用户，每部手机的钥匙，以及表单的事件。Plain, Angular, Vue， Svelte和React。
### 如何安装 @deltabreen/help-nativescript？
在项目目录运行 npm install @deltabreen/help-nativescript，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@nativescript/core（\>=8\.6）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
### @deltabreen/help-nativescript 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
### @deltabreen/help-nativescript 支持 ESM 还是 CommonJS？
以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。
### @deltabreen/help-nativescript 可以商用吗？
@deltabreen/help-nativescript 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
### @deltabreen/help-nativescript 还在维护吗？
最新版本 0\.1\.1 发布于 2026/11/01（2 天前）；至今共发布 3 个版本，其中过去 12 个月发布了 3 个；首次发布于 2026/11/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。