@shopware-ag/meteor-admin-sdk

中文文档
6.16.0发布于 2026/11/02MITTypeScriptESM + CJS构建来源已验证

用于商店软件管理的Meteor SDK。

中文使用文档
文档目录3 节
  1. 安装
  2. 功能
  3. 示例

meteor-admin-sdk

Tests NPM Package

这个 meteor-admin-sdk 是一个面向所有人的JavaScript库 Shopware 6 应用程序和插件开发人员想要一个简单的方法来扩展和自定义管理。

看文档

安装

使用NPM:

将其安装到您的 package.json

npm i --save @shopware-ag/meteor-admin-sdk

然后把它导入到你的应用中:

// import everything
import * as sw from '@shopware-ag/meteor-admin-sdk';

// or import only needed functionality
import { notification }  from '@shopware-ag/meteor-admin-sdk';

使用CDN:

从CDN导入源文件

// use the latest version available
<script src="https://unpkg.com/@shopware-ag/meteor-admin-sdk/cdn"></script>

// use a fix version (example here: 1.2.3)
<script src="https://unpkg.com/@shopware-ag/[email protected]/cdn"></script>

然后你可以用全局变量访问它 sw.

sw.notification.dispatch({
  title: 'My first notification',
  message: 'This was really easy to do'
})

功能

  • 🏗 适用于Shopware 6应用程序和插件: 你可以为你的插件或应用程序使用SDK。API的使用是相同的。
  • 🎢 浅学习曲线: 你不需要对商店软件管理的内部知识有广泛的了解。我们的SDK将复杂的东西隐藏在漂亮的API后面。
  • 🧰 许多扩展功能: 从抛出通知,访问上下文信息或扩展当前UI。SDK的功能集将逐步扩展,为您的想法和解决方案提供更多的可能性和灵活性。
  • 🪨 具有良好向后兼容性的稳定API: 不要再害怕Shopware更新了。此SDK中的破坏性更改是一个例外。如果你使用SDK,你的应用和插件将在更长的时间内保持稳定,而不需要任何代码维护。
  • 🧭 类型安全: 整个SDK都是用TypeScript编写的,它为你的应用和插件提供了强大的自动补全支持和更多的安全性。
  • 💙 开发经验: 从一开始就拥有出色的开发经验。它会在未来变得越来越好。
  • 🪶 轻: 整个库是完全可动摇的和无依赖的。每个功能都可以被细粒度地导入,以保持你的包尽可能的小和快。

示例

抛出一个通知:

sw.notification.dispatch({
  title: 'My first notification',
  message: 'This was really easy to do'
})

获取系统货币:

const currency = await sw.context.getCurrency();

订阅UI区域设置更改:

let currentLocale = 'en-GB';

sw.context.subscribeLocale(({ locale }) => {
  currentLocale = locale;
})

中查看更多示例 文档.

版本与发布记录

@shopware-ag/meteor-admin-sdk 共发布 81 个版本,首次发布于 2024/01/15;过去 12 个月发布了 19 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
6.16.0latest2026/11/021 天前
6.15.02026/10/011 个月前
6.14.12026/08/282 个月前
6.14.02026/08/202 个月前
6.13.02026/08/122 个月前
6.12.02026/08/062 个月前

其他发布通道:alpha → 5.5.0-iap.8。

关于 @shopware-ag/meteor-admin-sdk 的常见问题

@shopware-ag/meteor-admin-sdk 是什么?

用于商店软件管理的Meteor SDK。

如何安装 @shopware-ag/meteor-admin-sdk?

在项目目录运行 npm install @shopware-ag/meteor-admin-sdk,或使用 pnpm add / yarn add / bun add。

@shopware-ag/meteor-admin-sdk 支持 TypeScript 吗?

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

@shopware-ag/meteor-admin-sdk 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@shopware-ag/meteor-admin-sdk 可以商用吗?

@shopware-ag/meteor-admin-sdk 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@shopware-ag/meteor-admin-sdk 还在维护吗?

最新版本 6.16.0 发布于 2026/11/02(1 天前);至今共发布 81 个版本,其中过去 12 个月发布了 19 个;首次发布于 2024/01/15。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。