51f2f22f69
* feat: add KV interface to iframe, fix path alias bug * update template README's publish instruction * chore: update dependencies and sveltekit template
1.7 KiB
Kunkun Custom UI Extension Template (Vue)
Custom UI Extension Documentation
This is a template for a custom UI extension.
This type of extension is basically a static website. You can use any frontend framework you like, this template uses Vue.
It is assumed that you have some knowledge of frontend development with Vue.
Development
Development is the same as developing a normal website.
pnpm install
pnpm dev
pnpm build
- To develop and preview the extension in Kunkun, you need to run the
Add Dev Extensioncommand in Kunkun, and register this extension's path.
In package.json, "devMain" is the url for development server, and "main" is the path to static .html file for production.
To load the extension in development mode, you have to enable it with Toggle Dev Extension Live Load Mode command in Kunkun. A Live badge will be shown on the commands. This indicates that dev extensions will be loaded from devMain instead of main.
Advanced
Multi-Command
To support multiple commands, you will need multiple .html files as entrypoints, and register each command in package.json.
It is recommended to use a meta-framework and build with SSG rendering mode, which comes with routing and will output multiple .html files.
Kunkun provides meta-framework templates for Nuxt, Next, SvelteKit.
Verify Build and Publish
npx kksh@latest verify --publish # run basic verification
See Documentation for more details on how to publish your extension. You will need to publish your extension package to npm or jsr first with GitHub actioin, then register it on Kunkun's website.