mirror of https://github.com/YunYouJun/valaxy
1.2 KiB
1.2 KiB
| title | title_zh | categories | end | |
|---|---|---|---|---|
| Write an Addon | 编写一个插件 |
|
false |
开始编写
::: tip 约定大于配置
- 插件：
Addon，须以valaxy-addon-开头。 - 插件与主题类似，但做的事情更少。
- 一个站点只能使用一个主题，但可以使用多个插件。
- Addon 无需预编译，直接发布源文件即可。
:::
App.vue如果插件作者希望插件被使用时立刻全局挂载，可以将内容放置于valaxy-addon-<name>/App.vue中，并设置package.json中global: true。components: 放置于components文件夹下的组件将会被自动注册，但不会被挂载。用户可以手动加载使用。
文档正在施工中，您可以参照 插件橱窗 一些已有的插件。
创建插件模板
pnpm create valaxy
# choose template addon
使用生命周期钩子
如示例所示，插件可以使用 valaxy.hook 来挂载生命周期钩子。
实现在构建前/后以及其他节点做一些事情。
请参考 生命周期钩子 了解更多。
<<< @/../packages/valaxy-addon-test/node/index.ts {11-14} [valaxy-addon-test/node/index.ts]