kintone-plugins/kintone-vue-template
Template
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactoring

Browse Source
This commit is contained in:
薛家豪
2025-10-17 14:34:26 +08:00
parent 8e40f9f0e6
commit 7ddaeb4bf8
16 changed files with 339 additions and 265 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -9,6 +9,7 @@ lerna-debug.log*
node_modules
dist
dist-iife
dist-ssr
*.local

35
src/components/Config.vue
View File

@@ -16,44 +16,55 @@
<kuc-spinner :container="mainArea" v-show="loading" ref="spinner"></kuc-spinner>
</template>
<script setup lang="ts">
import type { Setting } from '@/types/model';
import type { Setting } from '@/types';
import { useI18n } from 'vue-i18n';
import type { Spinner } from 'kintone-ui-component';
import { nextTick, onMounted, reactive, ref, shallowRef, watch } from 'vue';
// i18n
// 配置国际化
const { t: $t } = useI18n();
// 定义组件属性
const props = defineProps<{ pluginId: string }>();
// 响应式插件设置数据
const setting: Setting = reactive({
buttonName: '',
message: '',
});
const error = ref('')
const error = ref('');
const loading = ref(false);
const mainArea = shallowRef<HTMLElement | null>(null);
const spinner = shallowRef<Spinner | null>(null);
onMounted(async () => {
// 先将整体页面渲染出来，再弹出 spinner 进行数据读取
// 等待页面完全渲染后再显示加载状态，实现更平滑的用户体验
nextTick(async () => {
loading.value = true;
// 获取已保存的插件配置
const savedSetting = kintone.plugin.app.getConfig(props.pluginId);
setting.buttonName = savedSetting?.buttonName || $t('config.button.default');
setting.message = savedSetting?.message || $t('config.message.default');
// 暂停 1s 用于展示 spinner Demo
// 模拟加载时间，展示 spinner 效果
await new Promise((resolve) => setTimeout(resolve, 1000));
loading.value = false;
});
});
// 使用 loading 状态控制 spinner
// 监听加载状态变化，控制 spinner 显示/隐藏
watch(loading, (load) => {
load ? spinner.value?.open() : spinner.value?.close();
});
/**
* 验证表单输入
* 检查必填字段是否已填写
* @param setting 要验证的设置对象
* @returns 验证是否通过
*/
function validate(setting: Setting): boolean {
if (!setting.buttonName.trim()) {
error.value = 'ボタン名を入力してください。';
@@ -62,19 +73,29 @@ function validate(setting: Setting): boolean {
return true;
}
/**
* 保存配置设置
* 验证输入后将设置保存到插件配置中
*/
async function save() {
// 先进行验证，如果验证失败则终止保存
if (!validate(setting)) {
return;
}
loading.value = true;
// 暂停 1s 用于展示 spinner Demo
// 模拟保存时间，展示 spinner 效果
await new Promise((resolve) => setTimeout(resolve, 1000));
// 保存配置到插件
kintone.plugin.app.setConfig({
buttonName: setting.buttonName,
message: setting.message,
});
}
/**
* 取消操作并返回插件列表
* 重定向到插件管理页面
*/
function cancel() {
window.location.href = `../../${kintone.app.getId()}/plugin/`;
}

23
src/components/basic/PluginInput.vue
View File

@@ -10,33 +10,38 @@ import type { KucEvent } from '@/types/my-kintone';
import type { TextProps, TextInputEventDetail } from 'kintone-ui-component/lib/text';
import { defineProps, defineEmits, computed } from 'vue';
// kuc 不支持 v-model 的写法，所以如果想要使用需要包装一下
// KUC Text 组件不支持 v-model 语法，因此需要进行包装以支持双向绑定
const props = withDefaults(defineProps<TextProps & {
modelValue: string;
}>(), {
// boolean 的处理有点问题，这里手动重新定义
// 布尔值的默认值处理，设置为 undefined 表示未定义
disabled: undefined,
requiredIcon: undefined,
visible: undefined
visible: undefined,
});
const emit = defineEmits<{
(e: 'update:modelValue', value: string): void;
}>();
/**
* 计算属性：生成传递给 KUC Text 组件的属性对象
* 过滤掉未定义的属性，避免传递无效值
*/
const textProps = computed<TextProps>(() => {
const baseProps = {
...props,
label: '', // 在 plugin-label 处显示 label，不传入 text
className: `kuc-text-input${props.className ? ` ${props.className}` : ''}`,
label: '', // 标签由 plugin-label 组件显示，这里设置为空
className: `kuc-text-input${props.className ? ` ${props.className}` : ''}`, // 添加基础样式类
};
// 过滤掉所有值为 undefined 的属性
return Object.fromEntries(
Object.entries(baseProps).filter(([_, value]) => value !== undefined)
) as TextProps;
// 移除值为 undefined 的属性，确保只传递有效属性
return Object.fromEntries(Object.entries(baseProps).filter(([_, value]) => value !== undefined)) as TextProps;
});
/**
* 处理 v-model 事件
*/
const updateValue = ({ detail }: KucEvent<TextInputEventDetail>) => {
emit('update:modelValue', detail.value || '');
};

4
src/components/basic/PluginLabel.vue
View File

@@ -9,7 +9,7 @@
import { defineProps } from 'vue';
const props = defineProps<{
label: string;
requiredIcon?: boolean | undefined,
label: string; // 标签文本内容
requiredIcon?: boolean; // 是否显示必填标记
}>();
</script>

30
src/i18n/index.ts
View File

@@ -1,13 +1,27 @@
import { createI18n } from 'vue-i18n';
import ja from './lang/ja';
import en from './lang/en';
// 国际化配置
// 配置 Vue I18n 实现多语言支持
import { createI18n } from 'vue-i18n';
// 动态导入语言文件
const messages: Record<string, any> = {};
const modules = import.meta.glob('./lang/*.ts', { eager: true });
for (const path in modules) {
const match = path.match(/\.\/lang\/(\w+)\.ts$/);
if (match) {
const langCode = match[1];
const module = modules[path] as any;
messages[langCode] = module.default || module;
}
}
// 创建 i18n 实例配置
const i18n = createI18n({
legacy: false,
legacy: false, // 使用 Composition API 模式
locale: kintone.getLoginUser().language || 'ja',
messages: {
ja,
en,
},
messages,
});
export default i18n;

6
src/i18n/lang/en.ts
View File

@@ -1,14 +1,16 @@
// 英语语言包配置
// 包含配置页面相关的翻译文本
export default {
config: {
title: 'kintone Vue template',
desc: 'kintone Vue template for creating plugin',
button: {
label: 'button name',
default: 'button'
default: 'button',
},
message: {
label: 'message',
default: ''
default: '',
},
},
};

6
src/i18n/lang/ja.ts
View File

@@ -1,14 +1,16 @@
// 日语语言包配置
// 包含配置页面相关的翻译文本
export default {
config: {
title: 'kintone Vue テンプレート',
desc: 'kintoneプラグイン作成用 Vue テンプレート',
button: {
label: 'ボタン名',
default: 'ボタン'
default: 'ボタン',
},
message: {
label: 'メッセージ',
default: ''
default: '',
},
},
};

45
src/js/desktop.ts
View File

@@ -1,35 +1,52 @@
import type { Setting } from '@/types/model';
import type { Setting } from '@/types';
import { KintoneRestAPIClient } from '@kintone/rest-api-client';
import { Button } from 'kintone-ui-component/lib/button';
(function (PLUGIN_ID) {
kintone.events.on('app.record.index.show', () => {
// App id
const appId = kintone.app.getId()?.toString();
if (!appId) return;
// 获取当前应用ID
const appIdNum = kintone.app.getId();
if (!appIdNum) {
return;
};
const appId = appIdNum.toString();
// get setting
// 从插件配置中读取设置信息
const setting: Setting = kintone.plugin.app.getConfig(PLUGIN_ID);
// header space
// 检查按钮是否已存在，防止翻页时重复添加
const btnId = 'template-btn-id';
if (document.getElementById(btnId)) {
return;
};
// 获取 Header 容器元素
const headerSpace = kintone.app.getHeaderMenuSpaceElement();
if (!headerSpace) {
throw new Error('このページではヘッダー要素が利用できません。');
}
const btnId = 'template-btn-id';
// ボタン追加
if (document.getElementById(btnId)) return;
const button = new Kucs[KUC_VERSION].Button({
// 创建按钮
const button = new Button({
text: setting.buttonName,
type: 'submit',
id: btnId,
});
const client = new KintoneRestAPIClient();
button.addEventListener('click', async () => {
try {
// 测试 KintoneRestAPIClient，显示所有已启用的插件名
const client = new KintoneRestAPIClient();
const { plugins } = await client.app.getPlugins({
app: appId
})
alert(setting.message + "\n--------\n【Plugins】 " + plugins.map(p => p.name).join('、'));
app: appId,
});
const pluginsInfo = plugins.map((p) => p.name).join('、');
const message = setting.message + '\n--------\n【Plugins】 ' + pluginsInfo;
alert(message);
} catch (error) {
console.error('Failed to fetch plugins:', error);
}
});
headerSpace.appendChild(button);
});

45
src/js/mobile.ts
View File

@@ -1,35 +1,52 @@
import type { Setting } from '@/types/model';
import type { Setting } from '@/types';
import { KintoneRestAPIClient } from '@kintone/rest-api-client';
import { MobileButton } from 'kintone-ui-component/lib/mobile/button';
(function (PLUGIN_ID) {
kintone.events.on('mobile.app.record.index.show', () => {
// App id
const appId = kintone.mobile.app.getId()?.toString();
if (!appId) return;
// 获取当前应用ID
const appIdNum = kintone.mobile.app.getId();
if (!appIdNum) {
return;
};
const appId = appIdNum.toString();
// get setting
// 从插件配置中读取设置信息
const setting: Setting = kintone.plugin.app.getConfig(PLUGIN_ID);
// header space
// 检查按钮是否已存在，防止翻页时重复添加
const btnId = 'template-btn-id';
if (document.getElementById(btnId)) {
return;
};
// 获取 Header 容器元素
const headerSpace = kintone.mobile.app.getHeaderSpaceElement();
if (!headerSpace) {
throw new Error('このページではヘッダー要素が利用できません。');
}
const btnId = 'template-btn-id';
// ボタン追加
if (document.getElementById(btnId)) return;
const button = new Kucs[KUC_VERSION].MobileButton({
// 创建按钮
const button = new MobileButton({
text: setting.buttonName,
type: 'submit',
id: btnId,
});
const client = new KintoneRestAPIClient();
button.addEventListener('click', async () => {
try {
// 测试 KintoneRestAPIClient，显示所有已启用的插件名
const client = new KintoneRestAPIClient();
const { plugins } = await client.app.getPlugins({
app: appId
})
alert(setting.message + "\n--------\n【Plugins】 " + plugins.map(p => p.name).join('、'));
app: appId,
});
const pluginsInfo = plugins.map((p) => p.name).join('、');
const message = setting.message + '\n--------\n【Plugins】 ' + pluginsInfo;
alert(message);
} catch (error) {
console.error('Failed to fetch plugins:', error);
}
});
headerSpace.appendChild(button);
});

2
src/manifest.json
View File

@@ -5,7 +5,6 @@
"type": "APP",
"desktop": {
"js": [
"js/kuc.min.js",
"js/desktop.js"
],
"css": [
@@ -40,7 +39,6 @@
},
"mobile": {
"js": [
"js/kuc.min.js",
"js/mobile.js"
],
"css": [

11
src/types/index.d.ts vendored
View File

@@ -1,8 +1,3 @@
declare global {
const Kucs: {
[version: string]: any;
};
const KUC_VERSION: string;
const KUC_VERSION_DASHED: string;
}
export {};
// 导出所有类型定义
// 主要导出应用设置相关的类型接口
export * from './model';

4
src/types/model.d.ts vendored
View File

@@ -1,4 +1,8 @@
// 插件设置接口定义
// 描述用户可以在配置页面中设置的参数
export interface Setting {
// 按钮显示名称，用户自定义按钮的文本
buttonName: string;
// 用户自定义的消息内容，在点击按钮时会显示此消息
message: string;
}

14
src/types/my-kintone.d.ts vendored
View File

@@ -1,11 +1,17 @@
// 导入官方 REST API 客户端的类型定义
import { KintoneFormFieldProperty } from '@kintone/rest-api-client';
// KUC 组件事件类型定义
// 定义 kintone UI 组件触发事件的结构
export interface KucEvent<T> {
// 事件详情，包含组件传递的数据
detail: T;
}
// 选择类型字段联合类型
// 定义支持的选择类字段类型，用于类型检查和推断
export type SelectType =
| KintoneFormFieldProperty.CheckBox
| KintoneFormFieldProperty.RadioButton
| KintoneFormFieldProperty.Dropdown
| KintoneFormFieldProperty.MultiSelect;
| KintoneFormFieldProperty.CheckBox // 多选框字段
| KintoneFormFieldProperty.RadioButton // 单选按钮字段
| KintoneFormFieldProperty.Dropdown // 下拉选择字段
| KintoneFormFieldProperty.MultiSelect; // 多选下拉字段

82
vite.config.ts
View File

@@ -1,33 +1,35 @@
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import copy from "rollup-plugin-copy";
import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
import copy from 'rollup-plugin-copy';
import * as path from 'path';
import * as fs from 'fs';
import * as child_process from 'child_process';
import Components from 'unplugin-vue-components/vite';
import RSA from 'node-rsa';
// Read kintone-ui-component version from package.json
// 从 package.json 读取 kintone-ui-component 版本信息
const packageJson = JSON.parse(fs.readFileSync(path.resolve(__dirname, 'package.json'), 'utf-8'));
const kucVersion = packageJson.dependencies['kintone-ui-component'];
const formattedVersion = kucVersion.replace(/\./g, '-'); // e.g., 1.22.0 -> 1-22-0
const dottedVersion = kucVersion; // e.g., 1.22.0 -> 1.22.0
const formattedVersion = kucVersion.replace(/\./g, '-'); // 例如：1.22.0 -> 1-22-0
/**
* Create a private key for a kintone plugin
* 生成 kintone 插件的私钥
*/
export const generatePrivateKey = () => {
const key = new RSA({ b: 1024 });
return key.exportKey("pkcs1-private");
return key.exportKey('pkcs1-private');
};
// Check if private.ppk exists, if not, generate it
// 检查 private.ppk 是否存在，如果不存在则生成
const privateKeyPath = path.resolve(__dirname, 'private.ppk');
if (!fs.existsSync(privateKeyPath)) {
const privateKey = generatePrivateKey();
fs.writeFileSync(privateKeyPath, privateKey);
}
/**
* 自定义插件 vite-plugin-replace-tags：替换 KUC 组件标签为包含版本号的标签，并自动导入组件
*/
function replaceKucTagsPlugin() {
return {
name: 'vite-plugin-replace-tags',
@@ -35,24 +37,28 @@ function replaceKucTagsPlugin() {
if (id.endsWith('.vue')) {
const content = await fs.promises.readFile(id, 'utf-8');
const usedComponent = {}
const usedComponent = {};
// 替换 <kuc-*> 为带有版本号的形式 <kuc-[version]-*>
let res = content
.replace(new RegExp(`</kuc-([a-zA-Z0-9-]+)(?![0-9-])>`, 'g'), (match, p1) => `</kuc-${p1}-${formattedVersion}>`)
.replace(new RegExp(`<kuc-([a-zA-Z0-9-]+)(?![0-9-])([^>]*)>`, 'g'), (match, p1, p2) => {
usedComponent[p1] = true;
return `<kuc-${p1}-${formattedVersion}${p2}>`
return `<kuc-${p1}-${formattedVersion}${p2}>`;
});
// 如果有 KUC 组件，自动生成 import 脚本
if (Object.keys(usedComponent).length) {
let importScript = '<script lang="ts">'
let importScript = '<script lang="ts">';
Object.keys(usedComponent).forEach((key) => {
const keyPascal = key.split('-')
.map(word => word.charAt(0).toUpperCase() + word.slice(1))
.map((word) => word.charAt(0).toUpperCase() + word.slice(1))
.join('');
// 特殊处理 multi-choice 组件名称
if (key === 'multi-choice') {
key = 'multichoice';
}
importScript += `import * as Kuc${keyPascal} from "kintone-ui-component/lib/${key}";`
importScript += `import * as Kuc${keyPascal} from "kintone-ui-component/lib/${key}";`;
});
importScript += '</script>';
res = importScript + res;
@@ -60,11 +66,13 @@ function replaceKucTagsPlugin() {
return res;
}
}
},
};
}
// Function to build IIFE versions of desktop and mobile scripts
/**
* 自定义插件 iife-builder：构建 desktop.ts 和 mobile.ts 的 IIFE 版本
*/
function buildIIFEVersions() {
return {
name: 'iife-builder',
@@ -87,9 +95,9 @@ function buildIIFEVersions() {
}
},
generateBundle(options, bundle) {
// Copy and overwrite the main dist/src/js files with IIFE versions
const desktopIIFEPath = path.resolve(__dirname, 'dist-temp/desktop/desktop.js');
const mobileIIFEPath = path.resolve(__dirname, 'dist-temp/mobile/mobile.js');
// 将 IIFE 版本复制到主构建目录覆盖原有文件
const desktopIIFEPath = path.resolve(__dirname, 'dist-iife/desktop/desktop.js');
const mobileIIFEPath = path.resolve(__dirname, 'dist-iife/mobile/mobile.js');
const destDir = path.resolve(__dirname, 'dist/src/js');
if (fs.existsSync(desktopIIFEPath)) {
@@ -104,12 +112,12 @@ function buildIIFEVersions() {
console.log('Copied mobile.js to dist/src/js/');
}
// Clean up dist-temp directory
if (fs.existsSync(path.resolve(__dirname, 'dist-temp'))) {
fs.rmSync(path.resolve(__dirname, 'dist-temp'), { recursive: true, force: true });
console.log('Cleaned up dist-temp directory');
}
// 清理临时的 dist-iife 目录
if (fs.existsSync(path.resolve(__dirname, 'dist-iife'))) {
fs.rmSync(path.resolve(__dirname, 'dist-iife'), { recursive: true, force: true });
console.log('Cleaned up dist-iife directory');
}
},
};
}
@@ -120,12 +128,14 @@ export default defineConfig({
vue({
template: {
compilerOptions: {
isCustomElement: (tag) => tag.startsWith("kuc-"),
}
}
// 将以 kuc- 开头的标签识别为自定义元素，避免 Vue 的警告
isCustomElement: (tag) => tag.startsWith('kuc-'),
},
},
}),
Components(),
Components(), // 自动导入 Vue 组件
copy({
// 将打包 plugin 需要的文件复制到 dist 里面
targets: [
{ src: 'dist/index.html', dest: 'dist/src/html', rename: 'config.html' },
{ src: 'src/manifest.json', dest: 'dist/src' },
@@ -136,11 +146,11 @@ export default defineConfig({
],
hook: 'writeBundle' // 指定在何时复制文件
}),
replaceKucTagsPlugin()
replaceKucTagsPlugin(), // 自定义标签替换插件
],
resolve: {
alias: {
'@': path.resolve(__dirname, 'src'),
'@': path.resolve(__dirname, 'src'), // 配置 @ 别名指向 src 目录
},
},
build: {
@@ -150,15 +160,11 @@ export default defineConfig({
},
output: {
entryFileNames: (chunkInfo) => {
return 'src/js/[name].js'; // 默认处理为 JS 文件
return 'src/js/[name].js'; // 将入口文件输出为 JS 文件
},
assetFileNames: 'src/[ext]/[name].[ext]',
assetFileNames: 'src/[ext]/[name].[ext]', // 设置资源文件输出路径
},
},
sourcemap: 'inline',
sourcemap: 'inline', // 生成内联 sourcemap 用于调试
},
define: {
KUC_VERSION: JSON.stringify(dottedVersion),
KUC_VERSION_DASHED: JSON.stringify(formattedVersion)
}
})
});

29
vite.desktop.config.ts
View File

@@ -1,33 +1,26 @@
import * as path from 'path';
import * as fs from 'fs';
// Read kintone-ui-component version from package.json
const packageJson = JSON.parse(fs.readFileSync(path.resolve(__dirname, 'package.json'), 'utf-8'));
const kucVersion = packageJson.dependencies['kintone-ui-component'];
const dottedVersion = kucVersion; // e.g., 1.22.0 -> 1.22.0
/**
* 将桌面端 desktop.ts 文件打包为立即执行函数表达式 (IIFE) 格式
*/
export default {
build: {
lib: {
entry: path.resolve(__dirname, 'src/js/desktop.ts'),
name: 'DesktopPlugin',
formats: ['iife'],
fileName: () => 'desktop.js'
fileName: () => 'desktop.js', // 输出文件名，和 manifest.json 中的 name 一致
},
rollupOptions: {
external: ['kintone'],
external: ['kintone'], // kintone 是网站提供的 api，需要处理
output: {
globals: {
kintone: 'kintone'
}
}
kintone: 'kintone',
},
},
},
sourcemap: false,
emptyOutDir: false,
outDir: path.resolve(__dirname, 'dist-temp/desktop')
emptyOutDir: false, // 不清空输出目录，随后拷贝到 dist 目录中之后自动删除
outDir: path.resolve(__dirname, 'dist-iife/desktop'), // 输出到 dist-iife 目录
},
define: {
KUC_VERSION: JSON.stringify(dottedVersion),
KUC_VERSION_DASHED: JSON.stringify(dottedVersion.replace(/\./g, '-'))
}
}
};

29
vite.mobile.config.ts
View File

@@ -1,33 +1,26 @@
import * as path from 'path';
import * as fs from 'fs';
// Read kintone-ui-component version from package.json
const packageJson = JSON.parse(fs.readFileSync(path.resolve(__dirname, 'package.json'), 'utf-8'));
const kucVersion = packageJson.dependencies['kintone-ui-component'];
const dottedVersion = kucVersion; // e.g., 1.22.0 -> 1.22.0
/**
* 将移动端 mobile.ts 文件打包为立即执行函数表达式 (IIFE) 格式
*/
export default {
build: {
lib: {
entry: path.resolve(__dirname, 'src/js/mobile.ts'),
name: 'MobilePlugin',
formats: ['iife'],
fileName: () => 'mobile.js'
fileName: () => 'mobile.js', // 输出文件名，和 manifest.json 中的 name 一致
},
rollupOptions: {
external: ['kintone'],
external: ['kintone'], // kintone 是网站提供的 api，需要处理
output: {
globals: {
kintone: 'kintone'
}
}
kintone: 'kintone',
},
},
},
sourcemap: false,
emptyOutDir: false,
outDir: path.resolve(__dirname, 'dist-temp/mobile')
emptyOutDir: false, // 不清空输出目录，随后拷贝到 dist 目录中之后自动删除
outDir: path.resolve(__dirname, 'dist-iife/mobile'), // 输出到 dist-iife 目录
},
define: {
KUC_VERSION: JSON.stringify(dottedVersion),
KUC_VERSION_DASHED: JSON.stringify(dottedVersion.replace(/\./g, '-'))
}
}
};