gridsum-vue3-pc 1.0.0

package/template/base/src/components/basic-layout.vue

@@ -0,0 +1,484 @@
+<template>
+  <el-container class="app-container">
+    <el-header class="app-header">
+      <div class="app-header-left">
+        <img src="/logo.svg" width="22" height="22" class="header-logo" alt="logo" />
+        <div class="app-header-title">{{ title }}</div>
+      </div>
+      <div class="app-header-actions">
+        <LanguageSwitch />
+        <el-tooltip :content="isDark ? $t('layout.lightMode') : $t('layout.darkMode')" placement="bottom">
+          <el-button class="header-btn" text @click="toggleDark">
+            <el-icon><Moon v-if="!isDark" /><Sunny v-else /></el-icon>
+          </el-button>
+        </el-tooltip>
+        <el-tooltip :content="isFullscreen ? $t('layout.exitFullscreen') : $t('layout.fullscreen')" placement="bottom">
+          <el-button class="header-btn" text @click="toggleFullscreen">
+            <el-icon><FullScreen v-if="!isFullscreen" /><Aim v-else /></el-icon>
+          </el-button>
+        </el-tooltip>
+        <el-dropdown trigger="click" class="notification-dropdown">
+          <el-badge :value="unreadCount" :hidden="unreadCount === 0" class="notification-badge">
+            <el-button class="header-btn" text>
+              <el-icon><Bell /></el-icon>
+            </el-button>
+          </el-badge>
+          <template #dropdown>
+            <el-dropdown-menu class="notification-menu">
+              <el-dropdown-item v-for="notif in notifications" :key="notif.id" :divided="notif !== notifications[0]">
+                <div class="notification-item" @click="markRead(notif.id)">
+                  <div class="notif-dot" :class="{ unread: !notif.read }" />
+                  <div class="notif-content">
+                    <div class="notif-title">{{ notif.title }}</div>
+                    <div class="notif-time">{{ notif.time }}</div>
+                  </div>
+                </div>
+              </el-dropdown-item>
+              <el-dropdown-item v-if="notifications.length === 0" disabled>
+                <span class="no-notif">{{ $t('layout.noNotifications') }}</span>
+              </el-dropdown-item>
+            </el-dropdown-menu>
+          </template>
+        </el-dropdown>
+        <el-dropdown @command="handleCommand">
+          <span class="user-dropdown-link">
+            {{ userInfo?.displayName || userInfo?.username || $t('user.notLoggedIn') }}
+            <el-icon><ArrowDown /></el-icon>
+          </span>
+          <template #dropdown>
+            <el-dropdown-menu>
+              <el-dropdown-item command="logout">{{ $t('user.logout') }}</el-dropdown-item>
+            </el-dropdown-menu>
+          </template>
+        </el-dropdown>
+      </div>
+    </el-header>
+    <el-container>
+      <el-aside :width="isCollapse ? '64px' : '200px'" class="app-sidebar">
+        <div class="collapse-btn" @click="isCollapse = !isCollapse">
+          <el-icon>
+            <Fold v-if="!isCollapse" />
+            <Expand v-else />
+          </el-icon>
+        </div>
+        <el-menu
+          :default-active="activeMenu"
+          :collapse="isCollapse"
+          router
+          class="app-menu"
+        >
+          <el-menu-item index="/">
+            <el-icon><HomeFilled /></el-icon>
+            <template #title>{{ $t('menu.home') }}</template>
+          </el-menu-item>
+          <el-sub-menu index="/system" v-if="isAdmin">
+            <template #title>
+              <el-icon><Setting /></el-icon>
+              <span>{{ $t('menu.system') }}</span>
+            </template>
+            <el-menu-item index="/user">
+              <el-icon><User /></el-icon>
+              <template #title>{{ $t('menu.user') }}</template>
+            </el-menu-item>
+            <el-menu-item index="/role">
+              <el-icon><Key /></el-icon>
+              <template #title>{{ $t('menu.role') }}</template>
+            </el-menu-item>
+            <el-menu-item index="/admin">
+              <el-icon><Setting /></el-icon>
+              <template #title>{{ $t('menu.admin') }}</template>
+            </el-menu-item>
+          </el-sub-menu>
+        </el-menu>
+      </el-aside>
+      <el-main class="app-main">
+        <div class="breadcrumb-bar">
+          <el-breadcrumb separator="/">
+            <el-breadcrumb-item :to="{ path: '/' }">{{ $t('menu.home') }}</el-breadcrumb-item>
+            <el-breadcrumb-item v-for="b in breadcrumbs" :key="b.path" :to="b.path !== route.path ? { path: b.path } : undefined">
+              {{ b.title }}
+            </el-breadcrumb-item>
+          </el-breadcrumb>
+        </div>
+        <div class="app-content">
+          <router-view v-slot="{ Component }">
+            <keep-alive :max="10">
+              <transition name="page-fade" mode="out-in">
+                <component :is="Component" />
+              </transition>
+            </keep-alive>
+          </router-view>
+        </div>
+      </el-main>
+    </el-container>
+  </el-container>
+</template>
+
+<script setup lang="ts">
+import { ref, computed, onMounted } from 'vue';
+import { useRoute } from 'vue-router';
+import {
+  ArrowDown, HomeFilled, Setting, User, Key, Fold, Expand,
+  Moon, Sunny, FullScreen, Aim, Bell,
+} from '@element-plus/icons-vue';
+import { useUserStore } from '@/store/modules/user';
+import { storeToRefs } from 'pinia';
+import { useI18n } from 'vue-i18n';
+import LanguageSwitch from './LanguageSwitch.vue';
+
+const { t } = useI18n();
+const route = useRoute();
+const userStore = useUserStore();
+const { userInfo } = storeToRefs(userStore);
+
+const title = import.meta.env.VITE_APP_TITLE || 'Vue3 PC Template';
+
+const isCollapse = ref(false);
+const activeMenu = computed(() => route.path);
+const isFullscreen = ref(false);
+
+const isAdmin = computed(() => userStore.isAdmin());
+
+const isDark = ref(false);
+
+const breadcrumbs = computed(() => {
+  const paths = route.path.split('/').filter(Boolean);
+  const result: { path: string; title: string }[] = [];
+  let accumulator = '';
+  for (const p of paths) {
+    accumulator += `/${p}`;
+    const meta = route.matched.find(r => r.path === accumulator)?.meta;
+    const titleKey = meta?.titleKey as string | undefined;
+    const title = titleKey ? t(titleKey) : p;
+    result.push({ path: accumulator, title });
+  }
+  return result;
+});
+
+interface Notification {
+  id: number;
+  title: string;
+  time: string;
+  read: boolean;
+}
+
+const notifications = ref<Notification[]>([
+  { id: 1, title: t('admin.logLogin', { user: userInfo.value?.username || 'admin' }), time: '10:32', read: false },
+  { id: 2, title: t('admin.logCreateUser', { user: 'admin', target: 'zhangsan' }), time: '10:15', read: false },
+  { id: 3, title: t('admin.logUpdateRole', { user: 'admin', target: 'user' }), time: '09:50', read: true },
+]);
+
+const unreadCount = computed(() => notifications.value.filter(n => !n.read).length);
+
+const markRead = (id: number) => {
+  const n = notifications.value.find(item => item.id === id);
+  if (n) n.read = true;
+};
+
+const toggleDark = () => {
+  isDark.value = !isDark.value;
+  document.documentElement.classList.toggle('dark', isDark.value);
+  localStorage.setItem('theme', isDark.value ? 'dark' : 'light');
+};
+
+const toggleFullscreen = () => {
+  if (!document.fullscreenElement) {
+    document.documentElement.requestFullscreen();
+    isFullscreen.value = true;
+  } else {
+    document.exitFullscreen();
+    isFullscreen.value = false;
+  }
+};
+
+const handleCommand = (command: string) => {
+  if (command === 'logout') {
+    userStore.logout();
+  }
+};
+
+onMounted(() => {
+  const saved = localStorage.getItem('theme');
+  if (saved === 'dark') {
+    isDark.value = true;
+    document.documentElement.classList.add('dark');
+  }
+
+  document.addEventListener('fullscreenchange', () => {
+    isFullscreen.value = !!document.fullscreenElement;
+  });
+});
+</script>
+
+<style scoped lang="scss">
+.app-container {
+  height: 100vh;
+}
+
+.app-header {
+  display: flex;
+  align-items: center;
+  justify-content: space-between;
+  background: #fff;
+  color: #1a1a2e;
+  padding: 0 24px;
+  z-index: 100;
+  position: relative;
+  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.05);
+  height: 56px !important;
+
+  .app-header-left {
+    display: flex;
+    align-items: center;
+    gap: 12px;
+  }
+
+  .header-logo {
+    flex-shrink: 0;
+  }
+
+  .app-header-title {
+    font-size: 17px;
+    font-weight: 700;
+    letter-spacing: 0.5px;
+    background: linear-gradient(135deg, #667eea, #764ba2);
+    -webkit-background-clip: text;
+    -webkit-text-fill-color: transparent;
+    background-clip: text;
+  }
+
+  .app-header-actions {
+    display: flex;
+    align-items: center;
+    gap: 8px;
+  }
+
+  .header-btn {
+    color: #606266;
+    font-size: 18px;
+    padding: 6px;
+    border-radius: 8px;
+    transition: all 0.2s;
+
+    &:hover {
+      color: #409eff;
+      background: rgba(64, 158, 255, 0.06);
+    }
+  }
+
+  .user-dropdown-link {
+    cursor: pointer;
+    display: flex;
+    align-items: center;
+    gap: 6px;
+    padding: 4px 8px;
+    border-radius: 8px;
+    font-size: 14px;
+    color: #303133;
+    transition: all 0.2s;
+
+    &:hover {
+      background: rgba(64, 158, 255, 0.06);
+    }
+  }
+}
+
+.app-sidebar {
+  background: #fff;
+  border-right: 1px solid #e8e8e8;
+  transition: width 0.3s;
+  position: relative;
+  display: flex;
+  flex-direction: column;
+  overflow: hidden;
+
+  .collapse-btn {
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    height: 44px;
+    cursor: pointer;
+    border-bottom: 1px solid #e8e8e8;
+    color: #909399;
+    transition: all 0.2s;
+
+    &:hover {
+      background: #f5f7fa;
+      color: #409eff;
+    }
+  }
+
+  .app-menu {
+    flex: 1;
+    overflow-y: auto;
+    overflow-x: hidden;
+    border-right: none;
+  }
+}
+
+.app-main {
+  background: #f0f2f5;
+  padding: 0;
+  display: flex;
+  flex-direction: column;
+  overflow: auto;
+}
+
+.app-content {
+  padding: 16px;
+  flex: 1;
+  display: flex;
+  flex-direction: column;
+}
+
+.breadcrumb-bar {
+  display: flex;
+  align-items: center;
+  height: 44px;
+  padding: 0 24px;
+  background: #fff;
+  border-bottom: 1px solid #e8e8e8;
+  flex-shrink: 0;
+}
+
+.notification-badge {
+  :deep(.el-badge__content) {
+    top: 4px;
+    right: 4px;
+  }
+}
+
+.notification-menu {
+  max-height: 300px;
+  overflow-y: auto;
+  min-width: 280px;
+}
+
+.notification-item {
+  display: flex;
+  gap: 10px;
+  padding: 4px 0;
+  cursor: pointer;
+  width: 100%;
+}
+
+.notif-dot {
+  width: 8px;
+  height: 8px;
+  border-radius: 50%;
+  background: transparent;
+  flex-shrink: 0;
+  margin-top: 6px;
+
+  &.unread {
+    background: #409eff;
+  }
+}
+
+.notif-content {
+  flex: 1;
+  min-width: 0;
+}
+
+.notif-title {
+  font-size: 13px;
+  color: #303133;
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+}
+
+.notif-time {
+  font-size: 11px;
+  color: #909399;
+  margin-top: 2px;
+}
+
+.no-notif {
+  color: #909399;
+  font-size: 13px;
+}
+
+.page-fade-enter-active,
+.page-fade-leave-active {
+  transition: opacity 0.25s ease, transform 0.25s ease;
+}
+
+.page-fade-enter-from {
+  opacity: 0;
+  transform: translateY(8px);
+}
+
+.page-fade-leave-to {
+  opacity: 0;
+  transform: translateY(-8px);
+}
+
+html.dark .app-header {
+  background: #161b22;
+  color: #c9d1d9;
+  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.3);
+
+  .header-btn {
+    color: #8b949e;
+
+    &:hover {
+      color: #58a6ff;
+      background: rgba(88, 166, 255, 0.1);
+    }
+  }
+
+  .user-dropdown-link {
+    color: #c9d1d9;
+
+    &:hover {
+      background: rgba(88, 166, 255, 0.1);
+    }
+  }
+
+  .notif-title {
+    color: #c9d1d9;
+  }
+
+  .notif-time,
+  .no-notif {
+    color: #8b949e;
+  }
+}
+
+html.dark .app-sidebar {
+  background: #161b22;
+  border-right-color: #21262d;
+
+  .collapse-btn {
+    border-bottom-color: #21262d;
+    color: #8b949e;
+
+    &:hover {
+      background: #1c2128;
+      color: #58a6ff;
+    }
+  }
+
+  .app-menu {
+    border-right: none;
+  }
+}
+
+html.dark .app-main {
+  background: #0d1117;
+}
+
+html.dark .breadcrumb-bar {
+  background: #161b22;
+  border-bottom-color: #21262d;
+
+  :deep(.el-breadcrumb__inner) {
+    color: #8b949e !important;
+  }
+
+  :deep(.el-breadcrumb__inner.is-link:hover) {
+    color: #58a6ff !important;
+  }
+}
+</style>

package/template/base/src/composables/useCrud.ts

@@ -0,0 +1,172 @@
+import { ref, reactive } from 'vue';
+import { ElMessage, ElMessageBox } from 'element-plus';
+import { useI18n } from 'vue-i18n';
+import http from '@/services/http';
+import type { ResponseData } from '@/services/http';
+import type { PaginatedData } from '@/services/user';
+import type { FormInstance, FormRules } from 'element-plus';
+
+export interface CrudOptions<T extends { id?: string | number }> {
+  url: string;
+  formDefaults: T;
+  rules?: FormRules<T>;
+  name?: string;
+}
+
+export function useCrud<T extends { id?: string | number }>(options: CrudOptions<T>) {
+  const { url, formDefaults, name, rules } = options;
+  const { t } = useI18n();
+
+  const list = ref<T[]>([]);
+  const loading = ref(false);
+  const page = ref(1);
+  const pageSize = ref(10);
+  const total = ref(0);
+  const keyword = ref('');
+
+  const dialogVisible = ref(false);
+  const isEdit = ref(false);
+  const selectedIds = ref<(string | number)[]>([]);
+
+  const formRef = ref<FormInstance>();
+  const form = reactive({ ...formDefaults }) as T;
+
+  const fetchData = async () => {
+    loading.value = true;
+    try {
+      const res: ResponseData<PaginatedData<T>> = await http.get(url, {
+        params: { page: page.value, pageSize: pageSize.value, keyword: keyword.value },
+      });
+      if (res.code === 0 || res.code === 200) {
+        list.value = res.data.list;
+        total.value = res.data.total;
+      }
+    } catch {
+      ElMessage.error(t('common.error'));
+    } finally {
+      loading.value = false;
+    }
+  };
+
+  const handleSearch = () => {
+    page.value = 1;
+    fetchData();
+  };
+
+  const handleSizeChange = (size: number) => {
+    pageSize.value = size;
+    page.value = 1;
+    fetchData();
+  };
+
+  const handleCurrentChange = (p: number) => {
+    page.value = p;
+    fetchData();
+  };
+
+  const openAdd = () => {
+    isEdit.value = false;
+    Object.assign(form, { ...formDefaults });
+    dialogVisible.value = true;
+  };
+
+  const openEdit = (row: T) => {
+    isEdit.value = true;
+    Object.assign(form, { ...row });
+    dialogVisible.value = true;
+  };
+
+  const handleDelete = async (row: T) => {
+    try {
+      await ElMessageBox.confirm(
+        t(`${name || 'common'}.deleteConfirm`),
+        t('common.warning'),
+        { type: 'warning' },
+      );
+      await http.delete(`${url}/${row.id}`);
+      ElMessage.success(t(`${name || 'common'}.deleteSuccess`));
+      fetchData();
+    } catch (e: any) {
+      if (e !== 'cancel') {
+        ElMessage.error(t('common.error'));
+      }
+    }
+  };
+
+  const handleBatchDelete = async () => {
+    if (selectedIds.value.length === 0) {
+      ElMessage.warning(t('common.selectItems'));
+      return;
+    }
+    try {
+      await ElMessageBox.confirm(
+        t('common.batchDeleteConfirm'),
+        t('common.warning'),
+        { type: 'warning' },
+      );
+      const res: ResponseData<any> = await http.delete(`${url}/batch`, { data: { ids: selectedIds.value } });
+      if (res.code !== 0 && res.code !== 200) {
+        ElMessage.error(res.message || t('common.error'));
+        return;
+      }
+      if (res.message && res.message.length > 0) {
+        ElMessage.warning(res.message);
+      } else {
+        ElMessage.success(t(`${name || 'common'}.deleteSuccess`));
+      }
+      selectedIds.value = [];
+      fetchData();
+    } catch (e: any) {
+      if (e !== 'cancel') {
+        ElMessage.error(t('common.error'));
+      }
+    }
+  };
+
+  const handleSubmit = async () => {
+    const valid = await formRef.value?.validate().catch(() => false);
+    if (!valid) return;
+
+    try {
+      let res: ResponseData<T>;
+      if (isEdit.value) {
+        res = await http.put(`${url}/${form.id}`, form);
+      } else {
+        res = await http.post(url, form);
+      }
+      if (res.code === 0 || res.code === 200) {
+        ElMessage.success(t(`${name || 'common'}.${isEdit.value ? 'editSuccess' : 'addSuccess'}`));
+        dialogVisible.value = false;
+        fetchData();
+      } else {
+        ElMessage.error(res.message || t('common.error'));
+      }
+    } catch {
+      ElMessage.error(t('common.error'));
+    }
+  };
+
+  return {
+    list,
+    loading,
+    page,
+    pageSize,
+    total,
+    keyword,
+    dialogVisible,
+    isEdit,
+    selectedIds,
+    formRef,
+    form,
+    rules,
+    fetchData,
+    handleSearch,
+    handleSizeChange,
+    handleCurrentChange,
+    openAdd,
+    openEdit,
+    handleDelete,
+    handleBatchDelete,
+    handleSubmit,
+  };
+}

package/template/base/src/env.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="vite/client" />
+
+interface ImportMetaEnv {
+  readonly VITE_APP_TITLE: string;
+  readonly VITE_APP_LOCALE: string;
+  readonly VITE_APP_MOCK: string;
+  readonly VITE_APP_PORT: string;
+  readonly VITE_APP_API_BASE_URL: string;
+}
+
+interface ImportMeta {
+  readonly env: ImportMetaEnv;
+}
+
+declare module '*.svg' {
+  const content: string;
+  export default content;
+}
+
+declare module '*.png' {
+  const content: string;
+  export default content;
+}
+
+declare module '*.jpg' {
+  const content: string;
+  export default content;
+}

package/template/base/src/env.ts

@@ -0,0 +1,24 @@
+import { z } from 'zod';
+
+const envSchema = z.object({
+  VITE_APP_TITLE: z.string().default('Vue3 PC Template'),
+  VITE_APP_LOCALE: z.enum(['zh-CN', 'en']).default('zh-CN'),
+  VITE_APP_MOCK: z
+    .string()
+    .transform((v) => v === 'true')
+    .default('true'),
+  VITE_APP_PORT: z.coerce.number().int().positive().default(3000),
+  VITE_APP_API_BASE_URL: z.string().default('http://localhost:8080'),
+});
+
+const parsed = envSchema.safeParse(import.meta.env);
+
+if (!parsed.success) {
+  console.error('[env] Invalid environment variables:');
+  for (const issue of parsed.error.issues) {
+    console.error(`  - ${issue.path.join('.')}: ${issue.message}`);
+  }
+  throw new Error('Environment variable validation failed');
+}
+
+