meteor-admin-sdk
这个 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;
})
中查看更多示例 文档.