{"_id":"@capacitor-ohos/toast","_rev":"2-8b300c81aac4a465ea7ce7650500e279","name":"@capacitor-ohos/toast","dist-tags":{"latest":"8.0.2"},"versions":{"8.0.1":{"name":"@capacitor-ohos/toast","version":"8.0.1","keywords":["capacitor","plugin","native"],"author":{"url":"Group","name":"Huawei Device Co., Ltd and iSoftStone Information Technology"},"license":"MIT","_id":"@capacitor-ohos/toast@8.0.1","maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"}],"bugs":{"url":"https://gitcode.com/CPF-Ionic/capacitor-toast/issues"},"dist":{"shasum":"6241c02c3bcae14648218593723822cb208751a9","tarball":"https://registry.npmjs.org/@capacitor-ohos/toast/-/toast-8.0.1.tgz","fileCount":10,"integrity":"sha512-EXGaKX89kweTR8I2q5q8/UbfArx5ee7z8WFx8xZClqqj3Io9Gh4Qj0McN06KNJS2aKjp2/uUVFLlQLcF+ZQ19Q==","signatures":[{"sig":"MEYCIQDkFbWYNRFq4/3pFF+4HH9BpOyRGoj/f572W886QQPu8QIhAPnGu7YcfAFk5uYvgc+TvnZR4w4BVieUCpPdDvhMp6VQ","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":29697},"gitHead":"2367a47a63b9b5d69c99b96d823ad4b5104af00b","_npmUser":{"name":"luqi_tan","email":"295099422@qq.com"},"capacitor":{"id":"@capacitor/toast","platforms":["openharmony"]},"repository":{"url":"gitcode:CPF-Ionic/capacitor-toast","type":"git"},"_npmVersion":"10.5.1","description":"The Toast API provides a notification pop up for displaying important information to a user. Just like real toast!","directories":{},"_nodeVersion":"22.0.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/toast_8.0.1_1777544810218_0.6381217698798776","host":"s3://npm-registry-packages-npm-production"}},"8.0.2":{"name":"@capacitor-ohos/toast","version":"8.0.2","description":"The Toast API provides a notification pop up for displaying important information to a user. Just like real toast!","capacitor":{"id":"@capacitor/toast","platforms":["openharmony"]},"repository":{"type":"git","url":"gitcode:CPF-Ionic/capacitor-toast"},"bugs":{"url":"https://gitcode.com/CPF-Ionic/capacitor-toast/issues"},"keywords":["capacitor","plugin","native"],"author":{"name":"Huawei Device Co., Ltd and iSoftStone Information Technology","url":"Group"},"license":"MIT","_id":"@capacitor-ohos/toast@8.0.2","gitHead":"6be757e65913731297cbc9d184c80f6cd9e80f04","_nodeVersion":"22.0.0","_npmVersion":"10.5.1","dist":{"integrity":"sha512-gb0Gg5YYPtJCUo78PVzLI0+2IQbn7qEl5ommcwB30E6NfNJKdyUMceWArzBLvQftzwlU3DCmq1H57gOarewc4Q==","shasum":"f50248c521a691d4822218942383c06bb19dd6cf","tarball":"https://registry.npmjs.org/@capacitor-ohos/toast/-/toast-8.0.2.tgz","fileCount":10,"unpackedSize":29721,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIGp0/9mcz2mTTX/H/Bno3m/CW7cBg+gi1kYqYrL1gRjsAiBGb1wNwFTPtOE0bvRDORb30LSJ+jWEp7a6U2TsN9KzcQ=="}]},"_npmUser":{"name":"luqi_tan","email":"295099422@qq.com"},"directories":{},"maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/toast_8.0.2_1784794778147_0.6978125005668654"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-30T10:26:50.086Z","modified":"2026-07-23T08:19:38.427Z","8.0.1":"2026-04-30T10:26:50.508Z","8.0.2":"2026-07-23T08:19:38.274Z"},"bugs":{"url":"https://gitcode.com/CPF-Ionic/capacitor-toast/issues"},"author":{"name":"Huawei Device Co., Ltd and iSoftStone Information Technology","url":"Group"},"license":"MIT","keywords":["capacitor","plugin","native"],"repository":{"type":"git","url":"gitcode:CPF-Ionic/capacitor-toast"},"description":"The Toast API provides a notification pop up for displaying important information to a user. Just like real toast!","maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"}],"readme":"# <center>@capacitor/toast</center>\r\n[![zh-CN](https://img.shields.io/badge/lang-中文-blue.svg)](README.md)\r\n[![en](https://img.shields.io/badge/lang-English-blue.svg)](README.en.md)\r\n\r\n本项目基于 [@capacitor/toast@8.0.0](https://www.npmjs.com/package/@capacitor/toast/v/8.0.0) 开发。\r\n\r\n## 简介\r\n\r\n@capacitor/toast提供了一个通知弹窗，用于向用户显示信息，兼容capacitor的Android、iOS等主流移动平台，本文档只说明在OpenHarmony系统中的使用。\r\n\r\n本插件用于在屏幕上显示短暂的消息提示，常用于显示简短的通知或反馈信息，适配OpenHarmony系统的消息提示场景，调用便捷、轻量。\r\n\r\n## 支持平台\r\n\r\n- **OpenHarmony**：5.0+\r\n\r\n## 下载安装\r\n\r\n通过命令行或手动引入即可快速安装插件，支持从npm仓库获取。\r\n\r\n### 命令行安装（推荐）\r\n\r\n安装hionic CLI：\r\n\r\n```bash\r\nnpm install -g hionic\r\n```\r\n\r\n以下两种方式中**任选其一**即可，无需重复操作：\r\n\r\nnpm安装：\r\n\r\n```bash\r\n# 安装插件\r\nnpm install @capacitor/toast\r\n\r\n# 同步插件\r\nhionic sync openharmony\r\n```\r\n\r\nhionic CLI安装：\r\n\r\n```bash\r\nhionic plugin add @capacitor/toast\r\n```\r\n\r\n### 手动引入安装\r\n\r\n根据插件源码中 `plugin.xml` 配置在项目中引入插件，步骤如下：\r\n\r\n#### 1. 添加插件配置\r\n\r\n根据 `plugin.xml` 的 `config-json` 项，通过 `target` 字段找到 `entry` 模块中 `capacitor.plugins.json` 文件，并根据 `param`\r\n标签添加配置如下：\r\n\r\n```json\r\n{\r\n  \"pkg\": \"@capacitor/toast\",\r\n  \"classpath\": \"Toast\"\r\n}\r\n```\r\n\r\n#### 2. 修改 CMake 配置\r\n\r\n根据 `plugin.xml` 的 `CMakeLists` 项，通过 `modules-name` 字段找到模块 `capacitor`，路径为 `target` 字段的\r\n`CMakeLists.txt` 文件，并添加 `add_subdirectory` 和 `target_link_libraries` 如下：\r\n\r\n```cmake\r\n#START_ADD_SUBDIRECTORY\r\n// ...\r\nadd_subdirectory(Toast)\r\n// ...\r\n#END_ADD_SUBDIRECTORY\r\n\r\n// ...\r\n\r\ntarget_link_libraries(capacitor PUBLIC\r\n  // ...\r\n  \"-Wl,--whole-archive\"\r\n  // ...\r\n  Toast\r\n  // ...\r\n  \"-Wl,--no-whole-archive\"\r\n)\r\n```\r\n\r\n#### 3. 复制源码文件\r\n\r\n根据 `plugin.xml` 的 `source-file` 项，根据 `src` 字段找到需要复制的文件，并根据 `modules-name` 字段和 `target-dir`\r\n字段找到文件复制的具体模块和目录，具体操作如下：\r\n\r\n将源码中src/main/cpp/Toast目录下的Toast.h、Toast.cpp、CMakeLists.txt文件引入到capacitor模块中src/main/cpp/Toast目录下。\r\n\r\n将源码中src/main/ets/components/Toast目录下的Toast.ets文件引入到capacitor模块中src/main/ets/components/Toast目录下。\r\n\r\n#### 4. 添加 ArkTS 配置\r\n\r\n在 `capacitor` 模块的 `build-profile.json5` 文件中，`buildOption/arkOptions/runtimeOnly/sources`\r\n配置项数组中加入步骤3中拷贝的ets文件路径，具体配置如下：\r\n\r\n```json\r\n{\r\n  \"buildOption\": {\r\n    // ...\r\n    \"arkOptions\": {\r\n      \"runtimeOnly\": [\r\n        // ...\r\n        \"./src/main/ets/components/Toast/Toast.ets\"\r\n        // ...\r\n      ]\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n## 卸载\r\n\r\n```bash\r\n# 卸载 toast 插件\r\nhionic plugin remove @capacitor/toast\r\n```\r\n\r\n## 约束与限制\r\n\r\n### 兼容性\r\n\r\n在以下版本中已测试通过：\r\n\r\n1. capacitor: 8.0.0-ohos-8.0.0; SDK: 5.0.5(17); IDE: DevEco Studio: 6.0.0; ROM: 5.1.0.150;\r\n\r\n## 使用示例\r\n\r\n### 示例1：显示简单文本消息\r\n\r\n```typescript\r\nimport { Toast } from '@capacitor/toast';\r\n\r\nconst showHelloToast = async () => {\r\n  await Toast.show({\r\n    text: 'Hello!',\r\n  });\r\n};\r\n```\r\n\r\n### 示例2：自定义时长和位置\r\n\r\n```typescript\r\nimport { Toast } from '@capacitor/toast';\r\n\r\n// 显示底部、长时间的提示消息\r\nconst showLongBottomToast = async () => {\r\n  await Toast.show({\r\n    text: '操作成功！',\r\n    duration: 'long',\r\n    position: 'bottom'\r\n  });\r\n};\r\n\r\n// 显示顶部、短时间的提示消息\r\nconst showShortTopToast = async () => {\r\n  await Toast.show({\r\n    text: '请检查输入',\r\n    duration: 'short',\r\n    position: 'top'\r\n  });\r\n};\r\n```\r\n\r\n## 使用说明\r\n\r\nToast是插件导出对象，可直接导入使用，导入后即可调用插件提供的所有方法，调用便捷高效，所有API均基于Promise实现，支持异步调用，适用于各类简短消息提示场景。\r\n\r\n## 核心 API：Toast 对象\r\n\r\nToast 是插件导出对象，可直接导入使用，导入后即可调用插件提供的所有方法，调用便捷高效。\r\n\r\n### 方法列表与说明\r\n\r\n| 方法名       | 调用方式                    | 入参类型                        | 功能描述                             |\r\n|-----------|-------------------------|-----------------------------|----------------------------------|\r\n| show(...) | Toast.show(ShowOptions) | [ShowOptions](#showoptions) | 在屏幕上显示一个 Toast 消息，支持配置显示文本、时长和位置 |\r\n\r\n### 接口定义\r\n\r\n#### ShowOptions\r\n\r\n调用 `show` 方法时的入参对象，用于配置Toast的显示效果和内容。\r\n\r\n| 参数       | 类型                      | 描述                                           | 必填 | 默认值      |\r\n|----------|-------------------------|----------------------------------------------|----|----------|\r\n| text     | string                  | 在 Toast 上显示的文本，建议简洁明了，避免过长                   | 是  | 无        |\r\n| duration | 'short'丨'long'          | Toast 显示的持续时间，'short'对应2000ms，'long'对应3500ms | 否  | 'short'  |\r\n| position | 'top'丨'center'丨'bottom' | Toast 在屏幕上的显示位置，支持顶部、中间、底部三种                 | 否  | 'bottom' |\r\n\r\n## 目录结构\r\n\r\n```plaintext\r\n|---- 目录\r\n|     |---- src/main  # 插件的实现代码\r\n|           |----cpp  # C++ 代码\r\n|           |----ets   # ArkTS 代码\r\n|     |---- README.md          # 说明文档\r\n|     |---- package.json       # 配置文件\r\n|     |---- plugin.xml         # 插件配置文件\r\n```\r\n\r\n## 贡献代码\r\n\r\n使用过程中发现任何问题都可以提 [Issue](https://gitcode.com/CPF-Ionic/capacitor-toast/issues)\r\n，当然，也非常欢迎发 [PR](https://gitcode.com/CPF-Ionic/capacitor-toast/pulls) 共建。\r\n\r\n## 许可证\r\n\r\n本插件基于 **MIT License** 开源，详见 [LICENSE](./LICENSE) 文件。\r\n","readmeFilename":"README.md"}