Template
1
0
mirror of https://github.com/un-pany/v3-admin-vite.git synced 2025-04-21 11:29:20 +08:00

Compare commits

..

No commits in common. "main" and "v3.3.0" have entirely different histories.
main ... v3.3.0

264 changed files with 7414 additions and 13504 deletions

View File

@ -1,24 +1,13 @@
# 配置项文档https://editorconfig.org修改配置后重启编辑器
## 告知 EditorConfig 插件,当前即是根文件
root = true
## 适用全部文件
[*]
### 设置字符集
charset = utf-8
### 缩进风格 space | tab建议 space
indent_style = space
### 缩进的空格数
indent_size = 2
### 换行符类型 lf | cr | crlf一般都是设置为 lf
end_of_line = lf
### 是否在文件末尾插入空白行
insert_final_newline = true
### 是否删除一行中的前后空格
trim_trailing_whitespace = true
## 适用 .md 文件
[*.md]
insert_final_newline = false
trim_trailing_whitespace = false

7
.env
View File

@ -1,7 +0,0 @@
# 所有环境的环境变量(命名必须以 VITE_ 开头)
## 项目标题
VITE_APP_TITLE = V3 Admin Vite
## 路由模式 hash 或 html5
VITE_ROUTER_HISTORY = hash

View File

@ -1,7 +1,13 @@
# 开发环境的环境变量(命名必须以 VITE_ 开头)
# 请勿改动这一项,该项也不可以通过 import.meta.env.NODE_ENV 调用
NODE_ENV = development
## 后端接口地址(如果解决跨域问题采用反向代理就只需写相对路径)
VITE_BASE_URL = /api/v1
# 下面是自定义的环境变量,可以修改(命名必须以 VITE_ 开头)
## 开发环境域名和静态资源公共路径(一般 / 或 ./ 都可以)
VITE_PUBLIC_PATH = /
# 后端接口公共路径(如果解决跨域问题采用反向代理就只需写公共路径)
VITE_BASE_API = '/api/v1'
# 路由模式 hash 或 html5
VITE_ROUTER_HISTORY = 'hash'
# 开发环境地址前缀(一般 '/''./' 都可以)
VITE_PUBLIC_PATH = '/'

View File

@ -1,7 +1,13 @@
# 生产环境的环境变量(命名必须以 VITE_ 开头)
# 请勿改动这一项,该项也不可以通过 import.meta.env.NODE_ENV 调用
NODE_ENV = production
## 后端接口地址(如果解决跨域问题采用 CORS 就需要写绝对路径)
VITE_BASE_URL = https://apifoxmock.com/m1/2930465-2145633-default/api/v1
# 下面是自定义的环境变量,可以修改(命名必须以 VITE_ 开头)
## 打包构建静态资源公共路径(例如部署到 https://un-pany.github.io/v3-admin-vite/ 域名下就需要填写 /v3-admin-vite/
VITE_PUBLIC_PATH = /v3-admin-vite/
# 后端接口公共路径(如果解决跨域问题采用 CORS 就需要写全路径)
VITE_BASE_API = 'https://mock.mengxuegu.com/mock/63218b5fb4c53348ed2bc212/api/v1'
# 路由模式 hash 或 html5
VITE_ROUTER_HISTORY = 'hash'
# 打包路径(就是网站前缀,例如部署到 https://un-pany.github.io/v3-admin-vite/ 域名下,就需要填写 /v3-admin-vite/
VITE_PUBLIC_PATH = '/v3-admin-vite/'

View File

@ -1,7 +1,13 @@
# 预发布环境的环境变量(命名必须以 VITE_ 开头)
# 请勿改动这一项,该项也不可以通过 import.meta.env.NODE_ENV 调用
NODE_ENV = production
## 后端接口地址(如果解决跨域问题采用 CORS 就需要写绝对路径)
VITE_BASE_URL = https://apifoxmock.com/m1/2930465-2145633-default/api/v1
# 下面是自定义的环境变量,可以修改(命名必须以 VITE_ 开头)
## 打包构建静态资源公共路径(例如部署到 https://un-pany.github.io/ 域名下就需要填写 /
VITE_PUBLIC_PATH = /
# 后端接口公共路径(如果解决跨域问题采用 CORS 就需要写全路径)
VITE_BASE_API = 'https://mock.mengxuegu.com/mock/63218b5fb4c53348ed2bc212/api/v1'
# 路由模式 hash 或 html5
VITE_ROUTER_HISTORY = 'hash'
#打包路径(就是网站前缀,例如部署到 https://un-pany.github.io/v3-admin-vite/ 域名下,就需要填写 /v3-admin-vite/
VITE_PUBLIC_PATH = '/v3-admin-vite/'

7
.eslintignore Normal file
View File

@ -0,0 +1,7 @@
# Eslint 会忽略的文件
.DS_Store
node_modules
dist
dist-ssr
*.local

83
.eslintrc.js Normal file
View File

@ -0,0 +1,83 @@
module.exports = {
root: true,
env: {
browser: true,
node: true,
es6: true
},
globals: {
// script setup
defineProps: "readonly",
defineEmits: "readonly",
defineExpose: "readonly",
withDefaults: "readonly"
},
extends: [
"plugin:vue/vue3-essential",
"eslint:recommended",
"@vue/typescript/recommended",
"@vue/prettier",
"@vue/eslint-config-typescript"
// unplugin-auto-import 自动生成的文件
// "./types/.eslintrc-auto-import.json"
],
parser: "vue-eslint-parser",
parserOptions: {
parser: "@typescript-eslint/parser",
ecmaVersion: 2020,
sourceType: "module",
jsxPragma: "React",
ecmaFeatures: {
jsx: true,
tsx: true
}
},
rules: {
// TS
"@typescript-eslint/no-explicit-any": "off",
"no-debugger": "off",
"@typescript-eslint/explicit-module-boundary-types": "off",
"@typescript-eslint/ban-types": "off",
"@typescript-eslint/ban-ts-comment": "off",
"@typescript-eslint/no-empty-function": "off",
"@typescript-eslint/no-non-null-assertion": "off",
"@typescript-eslint/no-unused-vars": [
"error",
{
argsIgnorePattern: "^_",
varsIgnorePattern: "^_"
}
],
"no-unused-vars": [
"error",
{
argsIgnorePattern: "^_",
varsIgnorePattern: "^_"
}
],
// Vue
"vue/no-v-html": "off",
"vue/require-default-prop": "off",
"vue/require-explicit-emits": "off",
"vue/multi-word-component-names": "off",
"vue/html-self-closing": [
"error",
{
html: {
void: "always",
normal: "always",
component: "always"
},
svg: "always",
math: "always"
}
],
// Prettier
"prettier/prettier": [
"error",
{
endOfLine: "auto"
}
]
}
}

1
.github/FUNDING.yml vendored
View File

@ -1 +0,0 @@
custom: https://github.com/un-pany/v3-admin-vite/issues/69

View File

@ -14,18 +14,18 @@ jobs:
with:
persist-credentials: false
- name: Setup Node.js
- name: Setup Node.js 16.13.0
uses: actions/setup-node@master
with:
node-version: 22.12.0
node-version: "16.13.0"
- name: Setup pnpm
uses: pnpm/action-setup@v2
with:
version: 10.2.0
version: latest
- name: Build
run: pnpm install && pnpm build
run: pnpm install && pnpm build:prod
- name: Deploy
uses: JamesIves/github-pages-deploy-action@releases/v3

View File

@ -1,27 +0,0 @@
name: Release
permissions:
contents: write
on:
push:
tags:
- "v*"
jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set node
uses: actions/setup-node@v4
with:
registry-url: https://registry.npmjs.org/
node-version: lts/*
- run: npx changelogithub
env:
GITHUB_TOKEN: ${{ secrets.V3_ADMIN_VITE }}

30
.gitignore vendored
View File

@ -1,18 +1,34 @@
# Common
dist
node_modules
.eslintcache
vite.config.*.timestamp*
# Git 会忽略的文件
# MacOS
.DS_Store
node_modules
dist
dist-ssr
.eslintcache
# Local env files
*.local
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*
# Use the pnpm
# Editor directories and files
.vscode/*
!.vscode/extensions.json
!.vscode/settings.json
.idea
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
# Use the PNPM
package-lock.json
yarn.lock

View File

@ -1,4 +1,4 @@
# 全局 ts 类型检查(此操作会增加 git commit 时长)
npx vue-tsc
# 执行 lint-staged 中配置的任务
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
npx lint-staged

5
.npmrc
View File

@ -1,5 +0,0 @@
# China mirror of npm
registry = https://registry.npmmirror.com
# 安装依赖时锁定版本号
save-exact = true

8
.prettierignore Normal file
View File

@ -0,0 +1,8 @@
# Prettier 会忽略的文件
.DS_Store
node_modules
dist
dist-ssr
*.local
*.d.ts

View File

@ -1,10 +1,10 @@
{
"recommendations": [
"vue.volar",
"editorconfig.editorconfig",
"dbaeumer.vscode-eslint",
"antfu.unocss",
"vitest.explorer",
"wiensss.region-highlighter"
"esbenp.prettier-vscode",
"vue.vscode-typescript-vue-plugin",
"vue.volar",
"antfu.unocss"
]
}

View File

@ -1,15 +0,0 @@
{
"Vue3 Composable 代码结构一键生成": {
"prefix": "Vue3 Composable",
"body": [
"const refName1 = ref<string>(\"这是一个响应式变量\")\n",
"export function useName() {",
"\tconst refName2 = ref<string>(\"这是一个响应式变量\")\n",
"\tconst fnName = () => {}\n",
"\treturn { refName1, refName2, fnName }",
"}",
"$1"
],
"description": "Vue3 Composable"
}
}

75
.vscode/settings.json vendored
View File

@ -1,53 +1,30 @@
{
// Use workspace TypeScript version
"typescript.tsdk": "node_modules/typescript/lib",
// Disable the default formatter, use eslint instead
"prettier.enable": false,
"editor.formatOnSave": false,
// Auto fix
"editor.tabSize": 2,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit",
"source.organizeImports": "never"
"source.fixAll.eslint": true
},
// Silent the stylistic rules in you IDE, but still auto fix them
"eslint.rules.customizations": [
{ "rule": "style/*", "severity": "off", "fixable": true },
{ "rule": "format/*", "severity": "off", "fixable": true },
{ "rule": "*-indent", "severity": "off", "fixable": true },
{ "rule": "*-spacing", "severity": "off", "fixable": true },
{ "rule": "*-spaces", "severity": "off", "fixable": true },
{ "rule": "*-order", "severity": "off", "fixable": true },
{ "rule": "*-dangle", "severity": "off", "fixable": true },
{ "rule": "*-newline", "severity": "off", "fixable": true },
{ "rule": "*quotes", "severity": "off", "fixable": true },
{ "rule": "*semi", "severity": "off", "fixable": true }
],
// Enable eslint for all supported languages
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact",
"vue",
"html",
"markdown",
"json",
"jsonc",
"yaml",
"toml",
"xml",
"gql",
"graphql",
"astro",
"svelte",
"css",
"less",
"scss",
"pcss",
"postcss"
]
"[vue]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[typescript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[json]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[jsonc]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[html]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[css]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[scss]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
}

View File

@ -1,16 +0,0 @@
{
"Vue3 SFC 代码结构一键生成": {
"prefix": "Vue3 SFC",
"body": [
"<script lang=\"ts\" setup></script>\n",
"<template>",
"\t<div class=\"app-container\">",
"\t\t...",
"\t</div>",
"</template>\n",
"<style lang=\"scss\" scoped></style>",
"$1"
],
"description": "Vue3 SFC"
}
}

View File

@ -1,6 +1,6 @@
MIT License
Copyright (c) 2022-present pany <https://github.com/pany-ang>
Copyright (c) 2022 pany <https://github.com/pany-ang>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

265
README.md
View File

@ -1,227 +1,138 @@
<div align="center">
<img alt="logo" width="120" height="120" src="./src/common/assets/images/layouts/logo.png">
<img alt="V3-Admin-Vite-Logo" width="120" height="120" src="./src/assets/layout/logo.png">
<h1>V3 Admin Vite</h1>
<span>English | <a href="./README.zh-CN.md">中文</a></span>
</div>
[![github release](https://img.shields.io/github/v/release/un-pany/v3-admin-vite?style=flat)](https://github.com/un-pany/v3-admin-vite/releases)
[![github stars](https://img.shields.io/github/stars/un-pany/v3-admin-vite?style=flat)](https://github.com/un-pany/v3-admin-vite/stargazers)
[![gitee stars](https://gitee.com/un-pany/v3-admin-vite/badge/star.svg)](https://gitee.com/un-pany/v3-admin-vite/stargazers)
## ⚡ Introduction
<b>English | <a href="./README.zh-CN.md">中文</a></b>
v3-admin-vite is a free and open source middle and background management system basic solution, based on mainstream framework such as Vue3, TypeScript, Element Plus, Pinia and Vite.
## Introduction
- Vue-Cli 5.x: [v3-admin](https://github.com/un-pany/v3-admin)
- Electron desktop: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
V3 Admin Vite is a well-crafted backend management system template, built with popular technologies such as Vue3, Vite, TypeScript, and Element Plus
## Feature
## Notifications
- **Vue3**The latest Vue3 composition API using Vue3 + script setup
- **Element Plus**Vue3 version of Element UI
- **Pinia**: An alternative to Vuex in Vue3
- **Vite**Really fast
- **Vue Router**router
- **TypeScript**JavaScript With Syntax For Types
- **PNPM**Faster, disk space saving package management tool
- **Scss**Consistent with Element Plus
- **CSS variable**Mainly controls the layout and color of the item
- **ESlint**Code verification
- **Prettier** Code formatting
- **Axios**: Promise based HTTP client (encapsulated)
- **UnoCSS**: Real-time atomized CSS engine with high performance and flexibility
- **Annotation**Each configuration item is written with as detailed comments as possible
- **Mobile Compatible**: The layout is compatible with mobile page resolution
> [!NOTE]
> Powered by love! All source code is free and open-source. If you find it helpful, feel free to give a star to support!
## Functions
> [!IMPORTANT]
> Welcome to experience the brand-new version 5.0, currently in the beta stage. It will be a masterpiece!
- **User management**: log in, log out of the demo
- **Authority management**: Built-in page permissions (dynamic routing), instruction permissions, permission functions
- **Multiple Environments**: Development, Staging, Production
- **Multiple themes**: Normal, Dark, Dark Blue, theme modes
- **Error page**: 403, 404
- **Dashboard**: Display different Dashboard pages according to different users
- **Other functions**SVG, Dynamic Sidebar, Dynamic Breadcrumb Navigation, Tabbed Navigation, Screenfull, Adaptive Shrink Sidebar
> [!WARNING]
> Version 4.x will no longer be maintained unless there are critical bugs! [Click to switch to the 4.x branch](https://github.com/un-pany/v3-admin-vite/tree/4.x)
## 📚 Document
> [!TIP]
> Paid services are officially launched! If you dont want to do it yourself but want to remove TS or other modules, try the lazy package! [Click to check it out](https://github.com/un-pany/v3-admin-vite/issues/225)
[Chinese documentation](https://juejin.cn/post/7089377403717287972)
> [!TIP]
> If you have mobile web app needs, try the new open-source template. [MobVue](https://github.com/un-pany/mobvue)
## Gitee repository
## Usage
[Gitee](https://gitee.com/un-pany/v3-admin-vite)
<details>
<summary>Recommended Environment</summary>
## Online preview
<br>
| Location | account | Link |
| ------------ | ------------------- | ----------------------------------------------- |
| github-pages | `admin` or `editor` | [Link](https://un-pany.github.io/v3-admin-vite) |
- Latest version of `Visual Studio Code`
- Install the recommended plugins in the `.vscode/extensions.json` file
- `node` 20.x or 22+
- `pnpm` 9.x or 10+
</details>
<details>
<summary>Local Development</summary>
<br>
## 🚀 Development
```bash
# Clone the project
# configure
1. installation of the recommended plugins in the .vscode directory
3. node version 16+
4. pnpm version 7.x
# clone
git clone https://github.com/un-pany/v3-admin-vite.git
# Enter the project directory
# enter the project directory
cd v3-admin-vite
# Install dependencies
# install dependencies
pnpm i
# Start the development server
# start the service
pnpm dev
```
</details>
<details>
<summary>Build</summary>
<br>
## ✔️ Preview
```bash
# Build for the staging environment
pnpm build:staging
# stage environment
pnpm preview:stage
# Build for the production environment
pnpm build
# prod environment
pnpm preview:prod
```
</details>
<details>
<summary>Local Preview</summary>
<br>
## 📦️ Multi-environment packaging
```bash
# Execute the build command first to generate the dist directory, then run the preview command
pnpm preview
# build the stage environment
pnpm build:stage
# build the prod environment
pnpm build:prod
```
</details>
<details>
<summary>Code Check</summary>
<br>
## 🔧 Code formatting check
```bash
# Code linting and formatting
pnpm lint
# Unit tests
pnpm test
```
</details>
## Git commit specification reference
<details>
<summary>Commit Guidelines</summary>
- `feat` add new functions
- `fix` Fix issues/bugs
- `perf` Optimize performance
- `style` Change the code style without affecting the running result
- `refactor` Re-factor code
- `revert` Undo changes
- `test` Test related, does not involve changes to business code
- `docs` Documentation and Annotation
- `chore` Updating dependencies/modifying scaffolding configuration, etc.
- `workflow` Work flow Improvements
- `ci` CICD
- `types` Type definition
- `wip` In development
<br>
## 💕 Contributors
`feat` New feature
`fix` Bug fix
`perf` Performance improvement
`refactor` Code refactoring
`docs` Documentation and comments
`types` Type-related changes
`test` Unit tests related
`ci` Continuous integration, workflows
`revert` Revert changes
`chore` Chores (update dependencies, modify configurations, etc)
</details>
## Links
**Online Preview**: [github-pages](https://un-pany.github.io/v3-admin-vite)
**Chinese Documentation**: [link](https://juejin.cn/post/7089377403717287972)
**Zero to Hero Tutorial**: [link](https://juejin.cn/column/7207659644487139387)
**Mobile Web App**: [mobvue](https://github.com/un-pany/mobvue)
**Electron Desktop Version**: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
**Chinese Repository**: [gitee](https://gitee.com/un-pany/v3-admin-vite)
**Optional Group**: [check how to join](https://github.com/un-pany/v3-admin-vite/issues/191)
**Donations**: [buy a coffee for the author](https://github.com/un-pany/v3-admin-vite/issues/69)
**Releases & Changelog**: [releases](https://github.com/un-pany/v3-admin-vite/releases)
## Features
**Simplified structure**: No complex encapsulation, no complicated type gymnastics, just enough to meet the needs
**Detailed comments**: Every configuration item comes with as detailed comments as possible
**Latest dependencies**: Keeps all third-party dependencies up to date
**Consistency**: Unified code style, naming conventions, and comment style
## Built-in Features
**User Management**: Login, logout demonstration
**Permission Management**: Page-level permissions (dynamic routing), button-level permissions (permission directives, permission functions), route guards
**Multiple Environments**: Development, staging, and production environments
**Multiple Themes**: Normal, dark, and deep blue themes
**Multiple Layouts**: Left-side, top, and hybrid layouts
**Homepage**: Different dashboard pages for different users
**Error Pages**: 403, 404
**Mobile Compatibility**: Layouts compatible with mobile screen resolutions
**Others**: SVG sprite sheet, dynamic sidebar, dynamic breadcrumbs, tab navigation, content zoom and fullscreen, composable functions
## Tech Stack
**Vue3**: Vue3 + script setup with the latest Vue3 Composition API
**Element Plus**: The Vue3 version of Element UI
**Pinia**: The legendary Vuex5
**Vite**: Really fast
**Vue Router**: The routing system
**TypeScript**: A superset of JavaScript
**pnpm**: A faster, disk-space-saving package manager
**Scss**: Consistent with Element Plus
**CSS Variables**: Primarily controls layout and color in the project
**ESLint**: Code linting and formatting
**Axios**: Sends network requests
**UnoCSS**: A high-performance, flexible atomic CSS engine
## Project Preview Image
![preview](./src/common/assets/images/docs/preview.png)
## Contributors
A big thank you to all the contributors!
Thanks you to all the contributors!
<a href="https://github.com/un-pany/v3-admin-vite/graphs/contributors">
<img src="https://contrib.rocks/image?repo=un-pany/v3-admin-vite">
<img src="https://contrib.rocks/image?repo=un-pany/v3-admin-vite" />
</a>
## License
## Group
[MIT](./LICENSE) License © 2022-PRESENT [pany](https://github.com/pany-ang)
QQ group1014374415 (left) && add me on WeChatInvite you to join WeChat group (right)
![qq.png](./src/assets/docs/qq.png)
![wechat.png](./src/assets/docs/wechat.png)
## 📄 License
[MIT](./LICENSE)
Copyright (c) 2022 [pany](https://github.com/pany-ang)

View File

@ -1,55 +1,66 @@
<div align="center">
<img alt="logo" width="120" height="120" src="./src/common/assets/images/layouts/logo.png">
<img alt="V3-Admin-Vite-Logo" width="120" height="120" src="./src/assets/layout/logo.png">
<h1>V3 Admin Vite</h1>
<span><a href="./README.md">English</a> | 中文</span>
</div>
[![github release](https://img.shields.io/github/v/release/un-pany/v3-admin-vite?style=flat)](https://github.com/un-pany/v3-admin-vite/releases)
[![github stars](https://img.shields.io/github/stars/un-pany/v3-admin-vite?style=flat)](https://github.com/un-pany/v3-admin-vite/stargazers)
[![gitee stars](https://gitee.com/un-pany/v3-admin-vite/badge/star.svg)](https://gitee.com/un-pany/v3-admin-vite/stargazers)
## ⚡ 简介
<b><a href="./README.md">English</a> | 中文</b>
一个免费开源的中后台管理系统基础解决方案,基于 Vue3、TypeScript、Element Plus、Pinia 和 Vite 等主流技术.
## 简介
- Vue-Cli 5.x 版: [v3-admin](https://github.com/un-pany/v3-admin)
- Electron 桌面版: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
V3 Admin Vite 是一个精心制作的后台管理系统模板,基于 Vue3、Vite、TypeScript、Element Plus 等主流技术
## 特性
## 通知
- **Vue3**:采用 Vue3 + script setup 最新的 Vue3 组合式 API
- **Element Plus**Element UI 的 Vue3 版本
- **Pinia**: 传说中的 Vuex5
- **Vite**:真的很快
- **Vue Router**:路由路由
- **TypeScript**JavaScript 语言的超集
- **PNPM**:更快速的,节省磁盘空间的包管理工具
- **Scss**:和 Element Plus 保持一致
- **CSS 变量**:主要控制项目的布局和颜色
- **ESlint**:代码校验
- **Prettier**:代码格式化
- **Axios**:发送网络请求(已封装好)
- **UnoCSS**:具有高性能且极具灵活性的即时原子化 CSS 引擎
- **注释**:各个配置项都写有尽可能详细的注释
- **兼容移动端**: 布局兼容移动端页面分辨率
> [!NOTE]
> 为爱发电!所有源码均免费开源,如果对你有帮助,欢迎点个 Star 支持一下!
## 功能
> [!IMPORTANT]
> 欢迎体验全新的 5.0 版本,目前正在 beta 阶段,它将是一次匠心之作!
- **用户管理**:登录、登出演示
- **权限管理**:内置页面权限(动态路由)、指令权限、权限函数、路由守卫
- **多环境**开发环境development、预发布环境staging、正式环境production
- **多主题**:内置普通、黑暗、深蓝三种主题模式
- **错误页面**: 403、404
- **Dashboard**:根据不同用户显示不同的 Dashboard 页面
- **其他内置功能**SVG、动态侧边栏、动态面包屑、标签页快捷导航、Screenfull 全屏、自适应收缩侧边栏
> [!WARNING]
> 4.x 版本如果没有严重的 BUG 将不再维护![点击切换到 4.x 分支](https://github.com/un-pany/v3-admin-vite/tree/4.x)
## 📚 文档
> [!TIP]
> 正式推出付费服务,如果不想自己动手,但想移除 TS 或其他模块?试试懒人套餐![点击看看](https://github.com/un-pany/v3-admin-vite/issues/225)
[中文文档](https://juejin.cn/post/7089377403717287972)
> [!TIP]
> 如果你有移动端 H5 需求,试试新的开源模板。[MobVue](https://github.com/un-pany/mobvue)
## 国内仓库
## 使用
[Gitee](https://gitee.com/un-pany/v3-admin-vite)
<details>
<summary>推荐环境</summary>
## 在线预览
<br>
| 位置 | 账号 | 链接 |
| ------------ | --------------- | ----------------------------------------------- |
| github-pages | admin 或 editor | [链接](https://un-pany.github.io/v3-admin-vite) |
- 新版 `Visual Studio Code`
- 安装 `.vscode/extensions.json` 文件中推荐的插件
- `node` 20.x 或 22+
- `pnpm` 9.x 或 10+
</details>
<details>
<summary>本地开发</summary>
<br>
## 🚀 开发
```bash
# 配置
1. 一键安装 .vscode 目录中推荐的插件
3. node 版本 16+
4. pnpm 版本 7.x
# 克隆项目
git clone https://github.com/un-pany/v3-admin-vite.git
@ -63,165 +74,65 @@ pnpm i
pnpm dev
```
</details>
<details>
<summary>打包构建</summary>
<br>
## ✔️ 预览
```bash
# 打包构建预发布环境
pnpm build:staging
# 预览预发布环境
pnpm preview:stage
# 打包构建生产环境
pnpm build
# 预览正式环境
pnpm preview:prod
```
</details>
<details>
<summary>本地预览</summary>
<br>
## 📦️ 多环境打包
```bash
# 先执行打包构建命令生成 dist 目录后再执行以下预览命令
pnpm preview
# 构建预发布环境
pnpm build:stage
# 构建正式环境
pnpm build:prod
```
</details>
<details>
<summary>代码检查</summary>
<br>
## 🔧 代码格式检查
```bash
# 代码校验与格式化
pnpm lint
# 单元测试
pnpm test
```
</details>
## Git 提交规范参考
<details>
<summary>代码提交规范</summary>
- `feat` 增加新的业务功能
- `fix` 修复业务问题/BUG
- `perf` 优化性能
- `style` 更改代码风格, 不影响运行结果
- `refactor` 重构代码
- `revert` 撤销更改
- `test` 测试相关, 不涉及业务代码的更改
- `docs` 文档和注释相关
- `chore` 更新依赖/修改脚手架配置等琐事
- `workflow` 工作流改进
- `ci` 持续集成相关
- `types` 类型定义文件更改
- `wip` 开发中
<br>
## 💕 贡献者
`feat` 新功能
`fix` 修复错误
`perf` 性能优化
`refactor` 重构代码
`docs` 文档和注释
`types` 类型相关
`test` 单测相关
`ci` 持续集成、工作流
`revert` 撤销更改
`chore` 琐事(更新依赖、修改配置等)
</details>
## 链接
**在线预览**[github-pages](https://un-pany.github.io/v3-admin-vite)
**中文文档**[链接](https://juejin.cn/post/7445151895121543209)
**零基础教程**[链接](https://juejin.cn/column/7207659644487139387)
**移动端 H5**[mobvue](https://github.com/un-pany/mobvue)
**Electron 桌面版**[v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
**国内仓库**[gitee](https://gitee.com/un-pany/v3-admin-vite)
**可有可无的群**[查看进群方式](https://github.com/un-pany/v3-admin-vite/issues/191)
**捐赠**[请作者喝咖啡](https://github.com/un-pany/v3-admin-vite/issues/69)
**发行版 & 更新日志**[releases](https://github.com/un-pany/v3-admin-vite/releases)
## 特性
**结构精简**:没有复杂的封装,没有复杂的类型体操,刚好够用
**详细的注释**:各个配置项都写有尽可能详细的注释
**最新的依赖**:及时更新所有三方依赖至最新版
**有一点规范**:代码风格统一、命名风格统一、注释风格统一
## 内置功能
**用户管理**:登录、登出演示
**权限管理**:页面级权限(动态路由)、按钮级权限(权限指令、权限函数)、路由守卫
**多环境**开发环境development、预发布环境staging、生产环境production
**多主题**:普通、黑暗、深蓝, 三种主题模式
**多布局**:左侧、顶部、混合, 三种布局模式
**首页**:根据不同用户显示不同的 Dashboard 页面
**错误页**403、404
**兼容移动端**:布局兼容移动端页面分辨率
**其他**SVG 雪碧图、动态侧边栏、动态面包屑、标签页快捷导航、内容区放大与全屏、组合式函数
## 技术栈
**Vue3**:采用 Vue3 + script setup 最新的 Vue3 组合式 API
**Element Plus**Element UI 的 Vue3 版本
**Pinia**:传说中的 Vuex5
**Vite**:真的很快
**Vue Router**:路由路由
**TypeScript**JavaScript 语言的超集
**pnpm**:更快速的,节省磁盘空间的包管理工具
**Scss**:和 Element Plus 保持一致
**CSS 变量**:主要控制项目的布局和颜色
**ESLint**:代码校验与格式化
**Axios**:发送网络请求(已封装好)
**UnoCSS**:具有高性能且极具灵活性的即时原子化 CSS 引擎
## 项目预览图
![preview](./src/common/assets/images/docs/preview.png)
## 贡献者
在此感谢所有的贡献者!
感谢所有的贡献者!
<a href="https://github.com/un-pany/v3-admin-vite/graphs/contributors">
<img src="https://contrib.rocks/image?repo=un-pany/v3-admin-vite">
<img src="https://contrib.rocks/image?repo=un-pany/v3-admin-vite" />
</a>
## License
## 可有可无的群
[MIT](./LICENSE) License © 2022-PRESENT [pany](https://github.com/pany-ang)
QQ 群1014374415&& 加我微信,拉你进微信群(右)
![qq.png](./src/assets/docs/qq.png)
![wechat.png](./src/assets/docs/wechat.png)
## 📄 License
[MIT](./LICENSE)
Copyright (c) 2022 [pany](https://github.com/pany-ang)

View File

@ -1,43 +0,0 @@
import antfu from "@antfu/eslint-config"
// 更多自定义配置可查阅仓库https://github.com/antfu/eslint-config
export default antfu(
{
// 使用外部格式化程序格式化 css、html、markdown 等文件
formatters: true,
// 启用样式规则
stylistic: {
// 缩进级别
indent: 2,
// 引号风格 'single' | 'double'
quotes: "double",
// 是否启用分号
semi: false
},
// 忽略文件
ignores: []
},
{
// 对所有文件都生效的规则
rules: {
// vue
"vue/block-order": ["error", { order: ["script", "template", "style"] }],
"vue/attributes-order": "off",
// ts
"ts/no-use-before-define": "off",
// node
"node/prefer-global/process": "off",
// style
"style/comma-dangle": ["error", "never"],
"style/brace-style": ["error", "1tbs"],
// regexp
"regexp/no-unused-capturing-group": "off",
// other
"no-console": "off",
"no-debugger": "off",
"symbol-description": "off",
"antfu/if-newline": "off",
"unicorn/no-instanceof-builtins": "off"
}
}
)

View File

@ -1,12 +1,11 @@
<!doctype html>
<html lang="zh-CN">
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="icon" href="/favicon.ico" />
<link rel="stylesheet" href="/app-loading.css" />
<title>%VITE_APP_TITLE%</title>
<script src="/detect-ie.js" defer></script>
<title>V3 Admin Vite</title>
</head>
<body>
<div id="app">

View File

@ -1,64 +1,101 @@
{
"name": "v3-admin-vite",
"type": "module",
"version": "5.0.0-beta.6",
"description": "A crafted admin template, built with Vue3, Vite, TypeScript, Element Plus, and more",
"author": "pany <939630029@qq.com> (https://github.com/pany-ang)",
"repository": "https://github.com/un-pany/v3-admin-vite",
"version": "3.3.0",
"description": "一个免费开源的中后台管理系统基础解决方案,基于 Vue3、TypeScript、Element Plus、Pinia 和 Vite 等主流技术.",
"author": {
"name": "pany",
"email": "939630029@qq.com",
"url": "https://github.com/pany-ang"
},
"repository": {
"type": "git",
"url": "https://github.com/un-pany/v3-admin-vite.git"
},
"scripts": {
"dev": "vite",
"build:staging": "vue-tsc && vite build --mode staging",
"build": "vue-tsc && vite build",
"preview": "vite preview",
"lint": "eslint . --fix",
"prepare": "husky",
"test": "vitest"
"build:stage": "vue-tsc --noEmit && vite build --mode staging",
"build:prod": "vue-tsc --noEmit && vite build",
"preview:stage": "pnpm build:stage && vite preview",
"preview:prod": "pnpm build:prod && vite preview",
"lint:eslint": "eslint --cache --max-warnings 0 \"src/**/*.{vue,js,ts,tsx}\" --fix",
"lint:prettier": "prettier --write \"src/**/*.{js,ts,json,tsx,css,less,scss,vue,html,md}\"",
"lint": "pnpm lint:eslint && pnpm lint:prettier",
"prepare": "husky install"
},
"dependencies": {
"@element-plus/icons-vue": "2.3.1",
"axios": "1.8.4",
"dayjs": "1.11.13",
"element-plus": "2.9.7",
"js-cookie": "3.0.5",
"lodash-es": "4.17.21",
"mitt": "3.0.1",
"normalize.css": "8.0.1",
"nprogress": "0.2.0",
"path-browserify": "1.0.1",
"path-to-regexp": "8.2.0",
"pinia": "3.0.2",
"screenfull": "6.0.2",
"vue": "3.5.13",
"vue-router": "4.5.0",
"vxe-table": "4.6.25"
"@element-plus/icons-vue": "^2.0.10",
"axios": "^1.1.3",
"dayjs": "^1.11.6",
"element-plus": "^2.2.19",
"js-cookie": "^3.0.1",
"lodash-es": "^4.17.21",
"normalize.css": "^8.0.1",
"nprogress": "^0.2.0",
"path-browserify": "^1.0.1",
"path-to-regexp": "^6.2.1",
"pinia": "^2.0.23",
"screenfull": "^6.0.2",
"vue": "^3.2.41",
"vue-router": "^4.1.6",
"vxe-table": "^4.3.5",
"vxe-table-plugin-element": "^3.0.6",
"xe-utils": "^3.5.7"
},
"devDependencies": {
"@antfu/eslint-config": "4.12.0",
"@types/js-cookie": "3.0.6",
"@types/lodash-es": "4.17.12",
"@types/node": "22.14.1",
"@types/nprogress": "0.2.3",
"@types/path-browserify": "1.0.3",
"@vitejs/plugin-vue": "5.2.3",
"@vitejs/plugin-vue-jsx": "4.1.2",
"@vue/test-utils": "2.4.6",
"eslint": "9.24.0",
"eslint-plugin-format": "1.0.1",
"happy-dom": "17.4.4",
"husky": "9.1.7",
"lint-staged": "15.5.1",
"sass": "1.78.0",
"typescript": "5.8.3",
"unocss": "66.1.0-beta.12",
"unplugin-auto-import": "19.1.2",
"unplugin-svg-component": "0.12.1",
"unplugin-vue-components": "28.5.0",
"vite": "6.3.2",
"vite-svg-loader": "5.1.0",
"vitest": "3.1.1",
"vue-tsc": "2.2.8"
"@types/js-cookie": "^3.0.2",
"@types/lodash-es": "^4.17.6",
"@types/node": "^18.11.5",
"@types/nprogress": "^0.2.0",
"@types/path-browserify": "^1.0.0",
"@typescript-eslint/eslint-plugin": "^5.41.0",
"@typescript-eslint/parser": "^5.41.0",
"@vitejs/plugin-vue": "^3.1.2",
"@vitejs/plugin-vue-jsx": "^2.0.1",
"@vue/eslint-config-prettier": "^7.0.0",
"@vue/eslint-config-typescript": "^11.0.2",
"eslint": "^8.26.0",
"eslint-plugin-prettier": "^4.2.1",
"eslint-plugin-vue": "^9.6.0",
"husky": "^8.0.1",
"lint-staged": "^13.0.3",
"prettier": "^2.7.1",
"sass": "^1.55.0",
"terser": "^5.15.1",
"typescript": "^4.8.4",
"unocss": "^0.46.0",
"vite": "^3.1.8",
"vite-plugin-svg-icons": "^2.0.1",
"vite-svg-loader": "^3.6.0",
"vue-eslint-parser": "^9.1.0",
"vue-tsc": "^1.0.9"
},
"lint-staged": {
"*": "eslint --fix"
}
"*.{js,jsx,vue,ts,tsx}": [
"eslint --fix",
"prettier --write"
],
"*.{scss,less,css,html,md}": [
"prettier --write"
],
"package.json": [
"prettier --write"
],
"{!(package)*.json,.!(browserslist)*rc}": [
"prettier --write--parser json"
]
},
"keywords": [
"vue",
"vue3",
"admin",
"vue-admin",
"vue3-admin",
"vite",
"vite-admin",
"element-plus",
"element-plus-admin",
"ts",
"typescript"
],
"license": "MIT"
}

10253
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

21
prettier.config.js Normal file
View File

@ -0,0 +1,21 @@
/** 配置项文档https://prettier.io/docs/en/configuration.html */
module.exports = {
/** 每一行的宽度 */
printWidth: 120,
/** Tab 键的空格数 */
tabWidth: 2,
/** 在对象中的括号之间是否用空格来间隔 */
bracketSpacing: true,
/** 箭头函数的参数无论有几个,都要括号包裹 */
arrowParens: "always",
/** 换行符的使用 */
endOfLine: "auto",
/** 是否采用单引号 */
singleQuote: false,
/** 对象或者数组的最后一个元素后面不要加逗号 */
trailingComma: "none",
/** 是否加分号 */
semi: false,
/** 是否使用 Tab 格式化 */
useTabs: false
}

View File

@ -1,45 +1,65 @@
/* 白屏阶段会执行的 CSS 加载动画 */
#app-loading,
#app-loading:before,
#app-loading:after {
border-radius: 50%;
width: 2.5em;
height: 2.5em;
-webkit-animation-fill-mode: both;
animation-fill-mode: both;
-webkit-animation: loadingAnimation 1.8s infinite ease-in-out;
animation: loadingAnimation 1.8s infinite ease-in-out;
}
#app-loading {
position: relative;
top: 45vh;
margin: 0 auto;
color: #409eff;
font-size: 12px;
font-size: 10px;
margin: 80px auto;
position: relative;
text-indent: -9999em;
-webkit-transform: translateZ(0);
-ms-transform: translateZ(0);
transform: translateZ(0);
-webkit-animation-delay: -0.16s;
animation-delay: -0.16s;
top: 0;
transform: translate(-50%, 0);
}
#app-loading,
#app-loading::before,
#app-loading::after {
width: 2em;
height: 2em;
border-radius: 50%;
animation: 2s ease-in-out infinite app-loading-animation;
}
#app-loading::before,
#app-loading::after {
#app-loading:before,
#app-loading:after {
content: "";
position: absolute;
top: 0;
}
#app-loading::before {
left: -4em;
animation-delay: -0.2s;
#app-loading:before {
left: -3.5em;
-webkit-animation-delay: -0.32s;
animation-delay: -0.32s;
}
#app-loading::after {
left: 4em;
animation-delay: 0.2s;
#app-loading:after {
left: 3.5em;
}
@keyframes app-loading-animation {
@-webkit-keyframes loadingAnimation {
0%,
80%,
100% {
box-shadow: 0 2em 0 -2em;
box-shadow: 0 2.5em 0 -1.3em;
}
40% {
box-shadow: 0 2em 0 0;
box-shadow: 0 2.5em 0 0;
}
}
@keyframes loadingAnimation {
0%,
80%,
100% {
box-shadow: 0 2.5em 0 -1.3em;
}
40% {
box-shadow: 0 2.5em 0 0;
}
}

View File

@ -1,4 +0,0 @@
// Tip: Simple judgments may not fully cover
if (/MSIE\s|Trident\//.test(navigator.userAgent)) {
document.body.innerHTML = "<strong>Sorry, this browser is currently not supported. We recommend using the latest version of a modern browser. For example, Chrome/Firefox/Edge.</strong>"
}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.4 KiB

After

Width:  |  Height:  |  Size: 66 KiB

View File

@ -1,24 +1,17 @@
<script lang="ts" setup>
import { useGreyAndColorWeakness } from "@@/composables/useGreyAndColorWeakness"
import { usePany } from "@@/composables/usePany"
import { useTheme } from "@@/composables/useTheme"
import zhCn from "element-plus/es/locale/lang/zh-cn" // Element Plus
import { useTheme } from "@/hooks/useTheme"
import zhCn from "element-plus/lib/locale/lang/zh-cn"
const { initTheme } = useTheme()
const { initGreyAndColorWeakness } = useGreyAndColorWeakness()
const { initStarNotification, initStoreNotification } = usePany()
//
/** 初始化主题 */
initTheme()
//
initGreyAndColorWeakness()
//
initStarNotification()
initStoreNotification()
/** 将 Element Plus 的语言设置为中文 */
const locale = zhCn
</script>
<template>
<el-config-provider :locale="zhCn">
<ElConfigProvider :locale="locale">
<router-view />
</el-config-provider>
</ElConfigProvider>
</template>

33
src/api/login.ts Normal file
View File

@ -0,0 +1,33 @@
import { request } from "@/utils/service"
export interface ILoginData {
/** admin 或 editor */
username: "admin" | "editor"
/** 密码 */
password: string
/** 验证码 */
code: string
}
/** 获取登录验证码 */
export function getLoginCodeApi() {
return request({
url: "login/code",
method: "get"
})
}
/** 登录并返回 Token */
export function loginApi(data: ILoginData) {
return request({
url: "users/login",
method: "post",
data
})
}
/** 获取用户详情 */
export function getUserInfoApi() {
return request({
url: "users/info",
method: "get"
})
}

57
src/api/table.ts Normal file
View File

@ -0,0 +1,57 @@
import { request } from "@/utils/service"
interface ICreateTableDataApi {
username: string
password: string
}
interface IUpdateTableDataApi {
id: string
username: string
password?: string
}
interface IGetTableDataApi {
/** 当前页码 */
currentPage: number
/** 查询条数 */
size: number
/** 查询参数 */
username?: string
phone?: string
}
/** 增 */
export function createTableDataApi(data: ICreateTableDataApi) {
return request({
url: "table",
method: "post",
data
})
}
/** 删 */
export function deleteTableDataApi(id: string) {
return request({
url: `table/${id}`,
method: "delete"
})
}
/** 改 */
export function updateTableDataApi(data: IUpdateTableDataApi) {
return request({
url: "table",
method: "put",
data
})
}
/** 查 */
export function getTableDataApi(params: IGetTableDataApi) {
return request({
url: "table",
method: "get",
params
})
}

BIN
src/assets/docs/qq.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

BIN
src/assets/docs/wechat.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

View File

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View File

Before

Width:  |  Height:  |  Size: 60 KiB

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 373 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 407 KiB

BIN
src/assets/layout/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

View File

@ -1,37 +0,0 @@
import type * as Tables from "./type"
import { request } from "@/http/axios"
/** 增 */
export function createTableDataApi(data: Tables.CreateOrUpdateTableRequestData) {
return request({
url: "tables",
method: "post",
data
})
}
/** 删 */
export function deleteTableDataApi(id: number) {
return request({
url: `tables/${id}`,
method: "delete"
})
}
/** 改 */
export function updateTableDataApi(data: Tables.CreateOrUpdateTableRequestData) {
return request({
url: "tables",
method: "put",
data
})
}
/** 查 */
export function getTableDataApi(params: Tables.TableRequestData) {
return request<Tables.TableResponseData>({
url: "tables",
method: "get",
params
})
}

View File

@ -1,31 +0,0 @@
export interface CreateOrUpdateTableRequestData {
id?: number
username: string
password?: string
}
export interface TableRequestData {
/** 当前页码 */
currentPage: number
/** 查询条数 */
size: number
/** 查询参数:用户名 */
username?: string
/** 查询参数:手机号 */
phone?: string
}
export interface TableData {
createTime: string
email: string
id: number
phone: string
roles: string
status: boolean
username: string
}
export type TableResponseData = ApiResponseData<{
list: TableData[]
total: number
}>

View File

@ -1,10 +0,0 @@
import type * as Users from "./type"
import { request } from "@/http/axios"
/** 获取当前登录用户详情 */
export function getCurrentUserApi() {
return request<Users.CurrentUserResponseData>({
url: "users/me",
method: "get"
})
}

View File

@ -1 +0,0 @@
export type CurrentUserResponseData = ApiResponseData<{ username: string, roles: string[] }>

View File

@ -1 +0,0 @@
<svg width="15" height="15" aria-label="Arrow down" role="img"><g fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="1.2"><path d="M7.5 3.5v8M10.5 8.5l-3 3-3-3"></path></g></svg>

Before

Width:  |  Height:  |  Size: 223 B

View File

@ -1 +0,0 @@
<svg width="15" height="15" aria-label="Enter key" role="img"><g fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="1.2"><path d="M12 3.53088v3c0 1-1 2-2 2H4M7 11.53088l-3-3 3-3"></path></g></svg>

Before

Width:  |  Height:  |  Size: 241 B

View File

@ -1 +0,0 @@
<svg width="15" height="15" aria-label="Escape key" role="img"><g fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="1.2"><path d="M13.6167 8.936c-.1065.3583-.6883.962-1.4875.962-.7993 0-1.653-.9165-1.653-2.1258v-.5678c0-1.2548.7896-2.1016 1.653-2.1016.8634 0 1.3601.4778 1.4875 1.0724M9 6c-.1352-.4735-.7506-.9219-1.46-.8972-.7092.0246-1.344.57-1.344 1.2166s.4198.8812 1.3445.9805C8.465 7.3992 8.968 7.9337 9 8.5c.032.5663-.454 1.398-1.4595 1.398C6.6593 9.898 6 9 5.963 8.4851m-1.4748.5368c-.2635.5941-.8099.876-1.5443.876s-1.7073-.6248-1.7073-2.204v-.4603c0-1.0416.721-2.131 1.7073-2.131.9864 0 1.6425 1.031 1.5443 2.2492h-2.956"></path></g></svg>

Before

Width:  |  Height:  |  Size: 694 B

View File

@ -1 +0,0 @@
<svg width="15" height="15" aria-label="Arrow up" role="img"><g fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="1.2"><path d="M7.5 11.5v-8M10.5 6.5l-3-3-3 3"></path></g></svg>

Before

Width:  |  Height:  |  Size: 223 B

View File

@ -1,11 +0,0 @@
## 目录说明
- `common/assets/icons/preserve-color` 目录下存放带颜色的 svg icon
- `common/assets/icons` 目录存放的 svg icon 会被插件重写 `fill``stroke` 属性,使得图片自带的颜色丢失,从而继承父元素的颜色
## 使用说明
`common/assets/icons/preserve-color` 目录下需要添加 `preserve-color/` 前缀,像这样: `<SvgIcon name="preserve-color/name" />`
`common/assets/icons` 目录下则不需要,像这样: `<SvgIcon name="name" />`

View File

@ -1 +0,0 @@
<svg t="1691398959507" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="2431" width="200" height="200"><path d="M862.609 816.955L726.44 680.785l-0.059-0.056a358.907 358.907 0 0 0 56.43-91.927c18.824-44.507 28.369-91.767 28.369-140.467 0-48.701-9.545-95.96-28.369-140.467-18.176-42.973-44.19-81.56-77.319-114.689-33.13-33.129-71.717-59.144-114.69-77.32-44.507-18.825-91.767-28.37-140.467-28.37-48.701 0-95.96 9.545-140.467 28.37-42.973 18.176-81.56 44.19-114.689 77.32-33.13 33.129-59.144 71.717-77.32 114.689-18.825 44.507-28.37 91.767-28.37 140.467 0 48.7 9.545 95.96 28.37 140.467 18.176 42.974 44.19 81.561 77.32 114.69 33.129 33.129 71.717 59.144 114.689 77.319 44.507 18.824 91.767 28.369 140.467 28.369 48.7 0 95.96-9.545 140.467-28.369 32.78-13.864 62.997-32.303 90.197-54.968 0.063 0.064 0.122 0.132 0.186 0.195l136.169 136.17c6.25 6.25 14.438 9.373 22.628 9.373 8.188 0 16.38-3.125 22.627-9.372 12.496-12.496 12.496-32.758 0-45.254z m-412.274-69.466c-79.907 0-155.031-31.118-211.534-87.62-56.503-56.503-87.62-131.627-87.62-211.534s31.117-155.031 87.62-211.534c56.502-56.503 131.626-87.62 211.534-87.62s155.031 31.117 211.534 87.62c56.502 56.502 87.62 131.626 87.62 211.534s-31.118 155.031-87.62 211.534c-56.503 56.502-131.627 87.62-211.534 87.62z" p-id="2432"></path></svg>

Before

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 492 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.4 KiB

View File

@ -1,90 +0,0 @@
/**
* @description dark-blue 主题模式下的 Element Plus CSS 变量
* @description 在此查阅所有可自定义的变量https://github.com/element-plus/element-plus/blob/dev/packages/theme-chalk/src/common/var.scss
* @description 也可以打开浏览器控制台选择元素查看要覆盖的变量名
*/
/* 基础颜色 */
html.dark-blue {
/* color-primary */
--el-color-primary: #00bb99;
--el-color-primary-light-3: #00bb99b3;
--el-color-primary-light-5: #00bb9980;
--el-color-primary-light-7: #00bb994d;
--el-color-primary-light-8: #00bb9933;
--el-color-primary-light-9: #00bb991a;
--el-color-primary-dark-2: #00bb99;
/* color-success */
--el-color-success: #67c23a;
--el-color-success-light-3: #67c23ab3;
--el-color-success-light-5: #67c23a80;
--el-color-success-light-7: #67c23a4d;
--el-color-success-light-8: #67c23a33;
--el-color-success-light-9: #67c23a1a;
--el-color-success-dark-2: #67c23a;
/* color-warning */
--el-color-warning: #e6a23c;
--el-color-warning-light-3: #e6a23cb3;
--el-color-warning-light-5: #e6a23c80;
--el-color-warning-light-7: #e6a23c4d;
--el-color-warning-light-8: #e6a23c33;
--el-color-warning-light-9: #e6a23c1a;
--el-color-warning-dark-2: #e6a23c;
/* color-danger */
--el-color-danger: #f56c6c;
--el-color-danger-light-3: #f56c6cb3;
--el-color-danger-light-5: #f56c6c80;
--el-color-danger-light-7: #f56c6c4d;
--el-color-danger-light-8: #f56c6c33;
--el-color-danger-light-9: #f56c6c1a;
--el-color-danger-dark-2: #f56c6c;
/* color-error */
--el-color-error: #f56c6c;
--el-color-error-light-3: #f56c6cb3;
--el-color-error-light-5: #f56c6c80;
--el-color-error-light-7: #f56c6c4d;
--el-color-error-light-8: #f56c6c33;
--el-color-error-light-9: #f56c6c1a;
--el-color-error-dark-2: #f56c6c;
/* color-info */
--el-color-info: #909399;
--el-color-info-light-3: #909399b3;
--el-color-info-light-5: #90939980;
--el-color-info-light-7: #9093994d;
--el-color-info-light-8: #90939933;
--el-color-info-light-9: #9093991a;
--el-color-info-dark-2: #909399;
/* text-color */
--el-text-color-primary: #e5eaf3;
--el-text-color-regular: #cfd3dc;
--el-text-color-secondary: #a3a6ad;
--el-text-color-placeholder: #8d9095;
--el-text-color-disabled: #6c6e72;
/* border-color */
--el-border-color-darker: #003380;
--el-border-color-dark: #003380;
--el-border-color: #003380;
--el-border-color-light: #003380;
--el-border-color-lighter: #003380;
--el-border-color-extra-light: #003380;
/* fill-color */
--el-fill-color-darker: #002b6b;
--el-fill-color-dark: #002b6b;
--el-fill-color: #002b6b;
--el-fill-color-light: #002359;
--el-fill-color-lighter: #002359;
--el-fill-color-blank: #001b44;
--el-fill-color-extra-light: #001b44;
/* bg-color */
--el-bg-color-page: #001535;
--el-bg-color: #001b44;
--el-bg-color-overlay: #002359;
/* mask-color */
--el-mask-color: rgba(0, 0, 0, 0.5);
--el-mask-color-extra-light: rgba(0, 0, 0, 0.3);
}
/* button */
html.dark-blue .el-button {
--el-button-disabled-text-color: rgba(255, 255, 255, 0.5);
}

View File

@ -1,20 +0,0 @@
// 自定义 Element Plus 样式
// 卡片
.el-card {
background-color: var(--el-bg-color) !important;
}
// 分页
.el-pagination {
// 参考 Bootstrap 的响应式设计 WIDTH = 768
@media screen and (max-width: 768px) {
.el-pagination__total,
.el-pagination__sizes,
.el-pagination__jump,
.btn-prev,
.btn-next {
display: none;
}
}
}

View File

@ -1,42 +0,0 @@
// 清除浮动
%clearfix {
&::after {
content: "";
display: table;
clear: both;
}
}
// 美化原生滚动条
%scrollbar {
// 整个滚动条
&::-webkit-scrollbar {
width: 8px;
height: 8px;
}
// 滚动条上的滚动滑块
&::-webkit-scrollbar-thumb {
border-radius: 4px;
background-color: #90939955;
}
&::-webkit-scrollbar-thumb:hover {
background-color: #90939977;
}
&::-webkit-scrollbar-thumb:active {
background-color: #90939999;
}
// 当同时有垂直滚动条和水平滚动条时交汇的部分
&::-webkit-scrollbar-corner {
background-color: transparent;
}
}
// 文本溢出时显示省略号
%ellipsis {
// 隐藏溢出的文本
overflow: hidden;
// 防止文本换行
white-space: nowrap;
// 文本内容溢出容器时文本末尾显示省略号
text-overflow: ellipsis;
}

View File

@ -1,29 +0,0 @@
// Element Plus 相关
// 侧边栏的 item popper
.el-popper {
.el-menu {
background-color: var(--el-bg-color);
.el-menu-item {
background-color: var(--el-bg-color);
&.is-active,
&:hover {
background-color: var(--el-bg-color-overlay);
color: #ffffff;
}
}
.el-sub-menu__title {
background-color: var(--el-bg-color);
}
.el-sub-menu {
&.is-active {
> .el-sub-menu__title {
color: #ffffff;
}
}
}
}
.el-menu--horizontal {
border: none;
}
}

View File

@ -1,4 +0,0 @@
.#{$theme-name} {
@import "./layouts.scss";
@import "./element-plus.scss";
}

View File

@ -1,34 +0,0 @@
// Layout 相关
.app-wrapper {
// 侧边栏
.sidebar-container {
background-color: var(--el-bg-color);
.el-menu {
background-color: var(--el-bg-color);
.el-menu-item {
background-color: var(--el-bg-color);
&.is-active,
&:hover {
background-color: var(--el-bg-color-overlay);
color: #ffffff;
}
}
}
.el-sub-menu__title {
background-color: var(--el-bg-color);
}
.el-sub-menu {
&.is-active {
> .el-sub-menu__title {
color: #ffffff;
}
}
}
}
}
// 右侧设置面板
.handle-button {
background-color: lighten($theme-bg-color, 20%) !important;
}

View File

@ -1,6 +0,0 @@
// dark-blue 主题下的变量
// 主题名称
$theme-name: "dark-blue";
// 主题背景颜色
$theme-bg-color: #001b44;

View File

@ -1,6 +0,0 @@
// dark 主题下的变量
// 主题名称
$theme-name: "dark";
// 主题背景颜色
$theme-bg-color: #141414;

View File

@ -1,72 +0,0 @@
/* 全局 CSS 变量,这种变量不仅可以在 CSS 和 SCSS 中使用,还可以导入到 JS 中使用 */
:root {
/* Body */
--v3-body-text-color: var(--el-text-color-primary);
--v3-body-bg-color: var(--el-bg-color-page);
/* Header 区域 = NavigationBar 组件 + TagsView 组件 */
--v3-header-height: calc(
var(--v3-navigationbar-height) + var(--v3-tagsview-height) + var(--v3-header-border-bottom-width)
);
--v3-header-bg-color: var(--el-bg-color);
--v3-header-box-shadow: var(--el-box-shadow-lighter);
--v3-header-border-bottom-width: 1px;
--v3-header-border-bottom: var(--v3-header-border-bottom-width) solid var(--el-fill-color);
/* NavigationBar 组件 */
--v3-navigationbar-height: 50px;
--v3-navigationbar-text-color: var(--el-text-color-regular);
/* Sidebar 组件(左侧模式全部生效、顶部模式全部不生效、混合模式非颜色部分生效) */
--v3-sidebar-width: 220px;
--v3-sidebar-hide-width: 58px;
--v3-sidebar-border-right: 1px solid var(--el-fill-color);
--v3-sidebar-menu-item-height: 60px;
--v3-sidebar-menu-tip-line-bg-color: var(--el-color-primary);
--v3-sidebar-menu-bg-color: #001428;
--v3-sidebar-menu-hover-bg-color: #409eff10;
--v3-sidebar-menu-text-color: #cfd3dc;
--v3-sidebar-menu-active-text-color: #ffffff;
/* TagsView 组件 */
--v3-tagsview-height: 34px;
--v3-tagsview-text-color: var(--el-text-color-regular);
--v3-tagsview-tag-active-text-color: #ffffff;
--v3-tagsview-tag-bg-color: var(--el-bg-color);
--v3-tagsview-tag-active-bg-color: var(--el-color-primary);
--v3-tagsview-tag-border-radius: 2px;
--v3-tagsview-tag-border-color: var(--el-border-color-lighter);
--v3-tagsview-tag-active-border-color: var(--el-color-primary);
--v3-tagsview-tag-icon-hover-bg-color: #00000030;
--v3-tagsview-tag-icon-hover-color: #ffffff;
--v3-tagsview-contextmenu-text-color: var(--el-text-color-regular);
--v3-tagsview-contextmenu-hover-text-color: var(--el-text-color-primary);
--v3-tagsview-contextmenu-bg-color: var(--el-bg-color-overlay);
--v3-tagsview-contextmenu-hover-bg-color: var(--el-fill-color);
--v3-tagsview-contextmenu-box-shadow: var(--el-box-shadow);
/* Hamburger 组件 */
--v3-hamburger-text-color: var(--el-text-color-primary);
/* RightPanel 组件 */
--v3-rightpanel-button-bg-color: #001428;
}
/* 内容区放大时,将不需要的组件隐藏 */
body.content-large {
/* Header 区域 = TagsView 组件 */
--v3-header-height: var(--v3-tagsview-height);
/* NavigationBar 组件 */
--v3-navigationbar-height: 0px;
/* Sidebar 组件 */
--v3-sidebar-width: 0px;
--v3-sidebar-hide-width: 0px;
}
/* 内容区全屏时,将不需要的组件隐藏 */
body.content-full {
/* Header 区域 */
--v3-header-height: 0px;
/* NavigationBar 组件 */
--v3-navigationbar-height: 0px;
/* Sidebar 组件 */
--v3-sidebar-width: 0px;
--v3-sidebar-hide-width: 0px;
/* TagsView 组件 */
--v3-tagsview-height: 0px;
}

View File

@ -1,20 +0,0 @@
// 控制切换主题时的动画效果只在较新的浏览器上生效例如 Chrome 111+
::view-transition-old(root) {
animation: none;
mix-blend-mode: normal;
}
::view-transition-new(root) {
animation: 0.5s ease-in clip-animation;
mix-blend-mode: normal;
}
@keyframes clip-animation {
from {
clip-path: circle(0px at var(--v3-theme-x) var(--v3-theme-y));
}
to {
clip-path: circle(var(--v3-theme-r) at var(--v3-theme-x) var(--v3-theme-y));
}
}

View File

@ -1,97 +0,0 @@
/**
* @description 所有主题模式下的 Vxe Table CSS 变量
* @description Element Plus CSS 变量来覆写 Vxe Table CSS 变量目的是使 Vxe Table 支持多主题模式且样式统一
* @description 在此查阅所有可自定义的变量https://github.com/x-extends/vxe-table/blob/master/styles/css-variable.scss
*/
:root {
/* color */
--vxe-font-color: var(--el-text-color-regular);
--vxe-primary-color: var(--el-color-primary);
--vxe-success-color: var(--el-color-success);
--vxe-info-color: var(--el-color-info);
--vxe-warning-color: var(--el-color-warning);
--vxe-danger-color: var(--el-color-danger);
--vxe-font-lighten-color: var(--el-text-color-primary);
--vxe-primary-lighten-color: var(--el-color-primary-light-3);
--vxe-success-lighten-color: var(--el-color-success-light-3);
--vxe-info-lighten-color: var(--el-color-info-light-3);
--vxe-warning-lighten-color: var(--el-color-warning-light-3);
--vxe-danger-lighten-color: var(--el-color-danger-light-3);
--vxe-font-darken-color: var(--el-text-color-secondary);
--vxe-primary-darken-color: var(--el-color-primary-dark-2);
--vxe-success-darken-color: var(--el-color-success-dark-2);
--vxe-info-darken-color: var(--el-color-info-dark-2);
--vxe-warning-darken-color: var(--el-color-warning-dark-2);
--vxe-danger-darken-color: var(--el-color-danger-dark-2);
--vxe-font-disabled-color: var(--el-text-color-disabled);
--vxe-primary-disabled-color: var(--el-color-primary-light-5);
--vxe-success-disabled-color: var(--el-color-success-light-5);
--vxe-info-disabled-color: var(--el-color-info-light-5);
--vxe-warning-disabled-color: var(--el-color-warning-light-5);
--vxe-danger-disabled-color: var(--el-color-danger-light-5);
/* input/radio/checkbox */
--vxe-input-border-color: var(--el-border-color);
--vxe-input-disabled-color: var(--el-text-color-disabled);
--vxe-input-disabled-background-color: var(--el-fill-color-light);
--vxe-input-placeholder-color: var(--el-text-color-placeholder);
/* popup */
--vxe-table-popup-border-color: var(--el-border-color);
/* table */
--vxe-table-header-font-color: var(--el-text-color-regular);
--vxe-table-footer-font-color: var(--el-text-color-regular);
--vxe-table-border-color: var(--el-border-color-lighter);
--vxe-table-header-background-color: var(--el-bg-color);
--vxe-table-body-background-color: var(--el-bg-color);
--vxe-table-footer-background-color: var(--el-bg-color);
--vxe-table-row-hover-background-color: var(--el-fill-color-light);
--vxe-table-row-current-background-color: var(--el-fill-color-light);
--vxe-table-row-hover-current-background-color: var(--el-fill-color-light);
--vxe-table-checkbox-range-background-color: var(--el-fill-color-light);
/* menu */
--vxe-table-menu-background-color: var(--el-bg-color-overlay);
/* loading */
--vxe-loading-color: var(--el-color-primary);
--vxe-loading-background-color: var(--el-mask-color);
/* validate */
--vxe-table-validate-error-color: var(--el-color-danger);
/* toolbar */
--vxe-toolbar-background-color: var(--el-bg-color);
--vxe-toolbar-custom-active-background-color: var(--el-bg-color-overlay);
--vxe-toolbar-panel-background-color: var(--el-bg-color-overlay);
/* pager */
--vxe-pager-background-color: var(--el-bg-color);
/* modal */
--vxe-modal-header-background-color: var(--el-bg-color);
--vxe-modal-body-background-color: var(--el-bg-color);
--vxe-modal-border-color: var(--el-border-color);
/* button */
--vxe-button-default-background-color: var(--el-bg-color-overlay);
/* input */
--vxe-input-background-color: var(--el-fill-color-blank);
--vxe-input-panel-background-color: var(--el-fill-color-blank);
/* form */
--vxe-form-background-color: var(--el-bg-color);
--vxe-form-validate-error-color: var(--el-color-danger);
/* select */
--vxe-select-option-hover-background-color: var(--el-bg-color-overlay);
--vxe-select-panel-background-color: var(--el-bg-color);
}

View File

@ -1,38 +0,0 @@
// 自定义 Vxe Table 样式
.vxe-grid {
// 表单
&--form-wrapper {
.vxe-form {
padding: 10px 20px;
margin-bottom: 20px;
}
}
// 工具栏
&--toolbar-wrapper {
.vxe-toolbar {
padding: 20px;
}
}
// 分页
&--pager-wrapper {
.vxe-pager {
height: 70px;
padding: 0 20px;
&--wrapper {
// 参考 Bootstrap 的响应式设计 WIDTH = 768
@media screen and (max-width: 768px) {
.vxe-pager--total,
.vxe-pager--sizes,
.vxe-pager--jump,
.vxe-pager--jump-prev,
.vxe-pager--jump-next {
display: none;
}
}
}
}
}
}

View File

@ -1,60 +0,0 @@
<script lang="ts" setup>
import type { NotifyItem } from "./type"
interface Props {
data: NotifyItem[]
}
const props = defineProps<Props>()
</script>
<template>
<el-empty v-if="props.data.length === 0" />
<el-card v-else v-for="(item, index) in props.data" :key="index" shadow="never" class="card-container">
<template #header>
<div class="card-header">
<div>
<span>
<span class="card-title">{{ item.title }}</span>
<el-tag v-if="item.extra" :type="item.status" effect="plain" size="small">{{ item.extra }}</el-tag>
</span>
<div class="card-time">
{{ item.datetime }}
</div>
</div>
<div v-if="item.avatar" class="card-avatar">
<img :src="item.avatar" width="34">
</div>
</div>
</template>
<div class="card-body">
{{ item.description ?? "No Data" }}
</div>
</el-card>
</template>
<style lang="scss" scoped>
.card-container {
margin-bottom: 10px;
.card-header {
display: flex;
justify-content: space-between;
align-items: center;
.card-title {
font-weight: bold;
margin-right: 10px;
}
.card-time {
font-size: 12px;
color: var(--el-text-color-secondary);
}
.card-avatar {
display: flex;
align-items: center;
}
}
.card-body {
font-size: 12px;
}
}
</style>

View File

@ -1,58 +0,0 @@
import type { NotifyItem } from "./type"
export const notifyData: NotifyItem[] = [
{
avatar: "https://gw.alipayobjects.com/zos/rmsportal/OKJXDXrmkNshAMvwtvhu.png",
title: "V3 Admin Vite 上线啦",
datetime: "两年前",
description: "一个免费开源的中后台管理系统基础解决方案,基于 Vue3、TypeScript、Element Plus、Pinia 和 Vite 等主流技术"
},
{
avatar: "https://gw.alipayobjects.com/zos/rmsportal/OKJXDXrmkNshAMvwtvhu.png",
title: "V3 Admin 上线啦",
datetime: "三年前",
description: "一个中后台管理系统基础解决方案,基于 Vue3、TypeScript、Element Plus 和 Pinia"
}
]
export const messageData: NotifyItem[] = [
{
avatar: "https://gw.alipayobjects.com/zos/rmsportal/ThXAXghbEsBCCSDihZxY.png",
title: "来自楚门的世界",
description: "如果再也不能见到你,祝你早安、午安和晚安",
datetime: "1998-06-05"
},
{
avatar: "https://gw.alipayobjects.com/zos/rmsportal/ThXAXghbEsBCCSDihZxY.png",
title: "来自大话西游",
description: "如果非要在这份爱上加上一个期限,我希望是一万年",
datetime: "1995-02-04"
},
{
avatar: "https://gw.alipayobjects.com/zos/rmsportal/ThXAXghbEsBCCSDihZxY.png",
title: "来自龙猫",
description: "心存善意,定能途遇天使",
datetime: "1988-04-16"
}
]
export const todoData: NotifyItem[] = [
{
title: "任务名称",
description: "这家伙很懒,什么都没留下",
extra: "未开始",
status: "info"
},
{
title: "任务名称",
description: "这家伙很懒,什么都没留下",
extra: "进行中",
status: "primary"
},
{
title: "任务名称",
description: "这家伙很懒,什么都没留下",
extra: "已超时",
status: "danger"
}
]

View File

@ -1,94 +0,0 @@
<script lang="ts" setup>
import type { NotifyItem } from "./type"
import { Bell } from "@element-plus/icons-vue"
import { messageData, notifyData, todoData } from "./data"
import List from "./List.vue"
type TabName = "通知" | "消息" | "待办"
interface DataItem {
name: TabName
type: "primary" | "success" | "warning" | "danger" | "info"
list: NotifyItem[]
}
/** 角标当前值 */
const badgeValue = computed(() => data.value.reduce((sum, item) => sum + item.list.length, 0))
/** 角标最大值 */
const badgeMax = 99
/** 面板宽度 */
const popoverWidth = 350
/** 当前 Tab */
const activeName = ref<TabName>("通知")
/** 所有数据 */
const data = ref<DataItem[]>([
//
{
name: "通知",
type: "primary",
list: notifyData
},
//
{
name: "消息",
type: "danger",
list: messageData
},
//
{
name: "待办",
type: "warning",
list: todoData
}
])
function handleHistory() {
ElMessage.success(`跳转到${activeName.value}历史页面`)
}
</script>
<template>
<div class="notify">
<el-popover placement="bottom" :width="popoverWidth" trigger="click">
<template #reference>
<el-badge :value="badgeValue" :max="badgeMax" :hidden="badgeValue === 0">
<el-tooltip effect="dark" content="消息通知" placement="bottom">
<el-icon :size="20">
<Bell />
</el-icon>
</el-tooltip>
</el-badge>
</template>
<template #default>
<el-tabs v-model="activeName" class="demo-tabs" stretch>
<el-tab-pane v-for="(item, index) in data" :key="index" :name="item.name">
<template #label>
{{ item.name }}
<el-badge :value="item.list.length" :max="badgeMax" :type="item.type" />
</template>
<el-scrollbar height="400px">
<List :data="item.list" />
</el-scrollbar>
</el-tab-pane>
</el-tabs>
<div class="notify-history">
<el-button link @click="handleHistory">
查看{{ activeName }}历史
</el-button>
</div>
</template>
</el-popover>
</div>
</template>
<style lang="scss" scoped>
.notify-history {
text-align: center;
padding-top: 12px;
border-top: 1px solid var(--el-border-color);
}
</style>

View File

@ -1,8 +0,0 @@
export interface NotifyItem {
avatar?: string
title: string
datetime?: string
description?: string
status?: "primary" | "success" | "info" | "warning" | "danger"
extra?: string
}

View File

@ -1,111 +0,0 @@
<script lang="ts" setup>
import screenfull from "screenfull"
interface Props {
/** 全屏的元素,默认是 html */
element?: string
/** 打开全屏提示语 */
openTips?: string
/** 关闭全屏提示语 */
exitTips?: string
/** 是否只针对内容区 */
content?: boolean
}
const props = withDefaults(defineProps<Props>(), {
element: "html",
openTips: "全屏",
exitTips: "退出全屏",
content: false
})
const CONTENT_LARGE = "content-large"
const CONTENT_FULL = "content-full"
const classList = document.body.classList
// #region
const isEnabled = screenfull.isEnabled
const isFullscreen = ref<boolean>(false)
const fullscreenTips = computed(() => (isFullscreen.value ? props.exitTips : props.openTips))
const fullscreenSvgName = computed(() => (isFullscreen.value ? "fullscreen-exit" : "fullscreen"))
function handleFullscreenClick() {
const dom = document.querySelector(props.element) || undefined
isEnabled ? screenfull.toggle(dom) : ElMessage.warning("您的浏览器无法工作")
}
function handleFullscreenChange() {
isFullscreen.value = screenfull.isFullscreen
// 退 class
isFullscreen.value || classList.remove(CONTENT_LARGE, CONTENT_FULL)
}
watchEffect((onCleanup) => {
if (isEnabled) {
//
screenfull.on("change", handleFullscreenChange)
//
onCleanup(() => {
screenfull.off("change", handleFullscreenChange)
})
}
})
// #endregion
// #region
const isContentLarge = ref<boolean>(false)
const contentLargeTips = computed(() => (isContentLarge.value ? "内容区复原" : "内容区放大"))
const contentLargeSvgName = computed(() => (isContentLarge.value ? "fullscreen-exit" : "fullscreen"))
function handleContentLargeClick() {
isContentLarge.value = !isContentLarge.value
//
classList.toggle(CONTENT_LARGE, isContentLarge.value)
}
function handleContentFullClick() {
//
isContentLarge.value && handleContentLargeClick()
//
classList.add(CONTENT_FULL)
//
handleFullscreenClick()
}
// #endregion
</script>
<template>
<div>
<!-- 全屏 -->
<el-tooltip v-if="!props.content" effect="dark" :content="fullscreenTips" placement="bottom">
<SvgIcon :name="fullscreenSvgName" @click="handleFullscreenClick" class="svg-icon" />
</el-tooltip>
<!-- 内容区 -->
<el-dropdown v-else :disabled="isFullscreen">
<SvgIcon :name="contentLargeSvgName" class="svg-icon" />
<template #dropdown>
<el-dropdown-menu>
<!-- 内容区放大 -->
<el-dropdown-item @click="handleContentLargeClick">
{{ contentLargeTips }}
</el-dropdown-item>
<!-- 内容区全屏 -->
<el-dropdown-item @click="handleContentFullClick">
内容区全屏
</el-dropdown-item>
</el-dropdown-menu>
</template>
</el-dropdown>
</div>
</template>
<style lang="scss" scoped>
.svg-icon {
font-size: 20px;
&:focus {
outline: none;
}
}
</style>

View File

@ -1,54 +0,0 @@
<script lang="ts" setup>
import { useDevice } from "@@/composables/useDevice"
interface Props {
total: number
}
const props = defineProps<Props>()
const { isMobile } = useDevice()
</script>
<template>
<div class="search-footer">
<template v-if="!isMobile">
<span class="search-footer-item">
<SvgIcon name="keyboard-enter" class="svg-icon" />
<span>确认</span>
</span>
<span class="search-footer-item">
<SvgIcon name="keyboard-up" class="svg-icon" />
<SvgIcon name="keyboard-down" class="svg-icon" />
<span>切换</span>
</span>
<span class="search-footer-item">
<SvgIcon name="keyboard-esc" class="svg-icon" />
<span>关闭</span>
</span>
</template>
<span class="search-footer-total"> {{ props.total }} </span>
</div>
</template>
<style lang="scss" scoped>
.search-footer {
display: flex;
color: var(--el-text-color-secondary);
font-size: 14px;
&-item {
display: flex;
align-items: center;
margin-right: 12px;
.svg-icon {
margin-right: 5px;
padding: 2px;
font-size: 20px;
background-color: var(--el-fill-color);
}
}
&-total {
margin: 0 0 0 auto;
}
}
</style>

View File

@ -1,193 +0,0 @@
<script lang="ts" setup>
import type { ElScrollbar } from "element-plus"
import type { RouteRecordNameGeneric, RouteRecordRaw } from "vue-router"
import { usePermissionStore } from "@/pinia/stores/permission"
import { useDevice } from "@@/composables/useDevice"
import { isExternal } from "@@/utils/validate"
import { cloneDeep, debounce } from "lodash-es"
import Footer from "./Footer.vue"
import Result from "./Result.vue"
/** 控制 modal 显隐 */
const modelValue = defineModel<boolean>({ required: true })
const router = useRouter()
const { isMobile } = useDevice()
const inputRef = ref<HTMLInputElement | null>(null)
const scrollbarRef = ref<InstanceType<typeof ElScrollbar> | null>(null)
const resultRef = ref<InstanceType<typeof Result> | null>(null)
const keyword = ref<string>("")
const result = shallowRef<RouteRecordRaw[]>([])
const activeRouteName = ref<RouteRecordNameGeneric | undefined>(undefined)
/** 是否按下了上键或下键(用于解决和 mouseenter 事件的冲突) */
const isPressUpOrDown = ref<boolean>(false)
/** 控制搜索对话框宽度 */
const modalWidth = computed(() => (isMobile.value ? "80vw" : "40vw"))
/** 树形菜单 */
const menus = computed(() => cloneDeep(usePermissionStore().routes))
/** 搜索(防抖) */
const handleSearch = debounce(() => {
const flatMenus = flatTree(menus.value)
const _keywords = keyword.value.toLocaleLowerCase().trim()
result.value = flatMenus.filter(menu => keyword.value ? menu.meta?.title?.toLocaleLowerCase().includes(_keywords) : false)
//
const length = result.value?.length
activeRouteName.value = length > 0 ? result.value[0].name : undefined
}, 500)
/** 将树形菜单扁平化为一维数组,用于菜单搜索 */
function flatTree(arr: RouteRecordRaw[], result: RouteRecordRaw[] = []) {
arr.forEach((item) => {
result.push(item)
item.children && flatTree(item.children, result)
})
return result
}
/** 关闭搜索对话框 */
function handleClose() {
modelValue.value = false
//
setTimeout(() => {
keyword.value = ""
result.value = []
}, 200)
}
/** 根据下标位置进行滚动 */
function scrollTo(index: number) {
if (!resultRef.value) return
const scrollTop = resultRef.value.getScrollTop(index)
// el-scrollbar
scrollbarRef.value?.setScrollTop(scrollTop)
}
/** 键盘上键 */
function handleUp() {
isPressUpOrDown.value = true
const { length } = result.value
if (length === 0) return
// name
const index = result.value.findIndex(item => item.name === activeRouteName.value)
//
if (index === 0) {
const bottomName = result.value[length - 1].name
// bottomName 1 name
if (activeRouteName.value === bottomName && length > 1) {
activeRouteName.value = result.value[length - 2].name
scrollTo(length - 2)
} else {
//
activeRouteName.value = bottomName
scrollTo(length - 1)
}
} else {
activeRouteName.value = result.value[index - 1].name
scrollTo(index - 1)
}
}
/** 键盘下键 */
function handleDown() {
isPressUpOrDown.value = true
const { length } = result.value
if (length === 0) return
// name name
const index = result.value.map(item => item.name).lastIndexOf(activeRouteName.value)
//
if (index === length - 1) {
const topName = result.value[0].name
// topName 1 name
if (activeRouteName.value === topName && length > 1) {
activeRouteName.value = result.value[1].name
scrollTo(1)
} else {
//
activeRouteName.value = topName
scrollTo(0)
}
} else {
activeRouteName.value = result.value[index + 1].name
scrollTo(index + 1)
}
}
/** 键盘回车键 */
function handleEnter() {
const { length } = result.value
if (length === 0) return
const name = activeRouteName.value
const path = result.value.find(item => item.name === name)?.path
if (path && isExternal(path)) return window.open(path, "_blank", "noopener, noreferrer")
if (!name) return ElMessage.warning("无法通过搜索进入该菜单,请为对应的路由设置唯一的 Name")
try {
router.push({ name })
} catch {
return ElMessage.warning("该菜单有必填的动态参数,无法通过搜索进入")
}
handleClose()
}
/** 释放上键或下键 */
function handleReleaseUpOrDown() {
isPressUpOrDown.value = false
}
</script>
<template>
<el-dialog
v-model="modelValue"
:before-close="handleClose"
:width="modalWidth"
top="5vh"
class="search-modal__private"
append-to-body
@opened="inputRef?.focus()"
@closed="inputRef?.blur()"
@keydown.up="handleUp"
@keydown.down="handleDown"
@keydown.enter="handleEnter"
@keyup.up.down="handleReleaseUpOrDown"
>
<el-input ref="inputRef" v-model="keyword" placeholder="搜索菜单" size="large" clearable @input="handleSearch">
<template #prefix>
<SvgIcon name="search" class="svg-icon" />
</template>
</el-input>
<el-empty v-if="result.length === 0" description="暂无搜索结果" :image-size="100" />
<template v-else>
<p>搜索结果</p>
<el-scrollbar ref="scrollbarRef" max-height="40vh" always>
<Result
ref="resultRef"
v-model="activeRouteName"
:data="result"
:is-press-up-or-down="isPressUpOrDown"
@click="handleEnter"
/>
</el-scrollbar>
</template>
<template #footer>
<Footer :total="result.length" />
</template>
</el-dialog>
</template>
<style lang="scss">
.search-modal__private {
.svg-icon {
font-size: 18px;
}
.el-dialog__header {
display: none;
}
.el-dialog__footer {
border-top: 1px solid var(--el-border-color);
padding-top: var(--el-dialog-padding-primary);
}
}
</style>

View File

@ -1,115 +0,0 @@
<script lang="ts" setup>
import type { RouteRecordNameGeneric, RouteRecordRaw } from "vue-router"
interface Props {
data: RouteRecordRaw[]
isPressUpOrDown: boolean
}
const props = defineProps<Props>()
/** 选中的菜单 */
const modelValue = defineModel<RouteRecordNameGeneric | undefined>({ required: true })
const instance = getCurrentInstance()
const scrollbarHeight = ref<number>(0)
/** 菜单的样式 */
function itemStyle(item: RouteRecordRaw) {
const flag = item.name === modelValue.value
return {
background: flag ? "var(--el-color-primary)" : "",
color: flag ? "#ffffff" : ""
}
}
/** 鼠标移入 */
function handleMouseenter(item: RouteRecordRaw) {
// mouseenter
if (props.isPressUpOrDown) return
modelValue.value = item.name
}
/** 计算滚动可视区高度 */
function getScrollbarHeight() {
// el-scrollbar max-height="40vh"
scrollbarHeight.value = Number((window.innerHeight * 0.4).toFixed(1))
}
/** 根据下标计算到顶部的距离 */
function getScrollTop(index: number) {
const currentInstance = instance?.proxy?.$refs[`resultItemRef${index}`] as HTMLDivElement[]
if (!currentInstance) return 0
const currentRef = currentInstance[0]
// 128 = result-item 56 + 56 = 112 margin8 + 8 = 16
const scrollTop = currentRef.offsetTop + 128
return scrollTop > scrollbarHeight.value ? scrollTop - scrollbarHeight.value : 0
}
//
onBeforeMount(() => {
window.addEventListener("resize", getScrollbarHeight)
})
//
onMounted(() => {
getScrollbarHeight()
})
//
onBeforeUnmount(() => {
window.removeEventListener("resize", getScrollbarHeight)
})
defineExpose({ getScrollTop })
</script>
<template>
<!-- 外层 div 不能删除是用来接收父组件 click 事件的 -->
<div>
<div
v-for="(item, index) in props.data"
:key="index"
:ref="`resultItemRef${index}`"
class="result-item"
:style="itemStyle(item)"
@mouseenter="handleMouseenter(item)"
>
<SvgIcon v-if="item.meta?.svgIcon" :name="item.meta.svgIcon" class="svg-icon" />
<component v-else-if="item.meta?.elIcon" :is="item.meta.elIcon" class="el-icon" />
<span class="result-item-title">
{{ item.meta?.title }}
</span>
<SvgIcon v-if="modelValue && modelValue === item.name" name="keyboard-enter" class="svg-icon" />
</div>
</div>
</template>
<style lang="scss" scoped>
@import "@@/assets/styles/mixins.scss";
.result-item {
display: flex;
align-items: center;
height: 56px;
padding: 0 15px;
margin-bottom: 8px;
border: 1px solid var(--el-border-color);
border-radius: 4px;
cursor: pointer;
.svg-icon {
min-width: 1em;
font-size: 18px;
}
.el-icon {
width: 1em;
font-size: 18px;
}
&-title {
flex: 1;
margin-left: 12px;
@extend %ellipsis;
}
}
</style>

View File

@ -1,29 +0,0 @@
<script lang="ts" setup>
import Modal from "./Modal.vue"
/** 控制 modal 显隐 */
const visible = ref<boolean>(false)
/** 打开 modal */
function handleOpen() {
visible.value = true
}
</script>
<template>
<div>
<el-tooltip effect="dark" content="搜索菜单" placement="bottom">
<SvgIcon name="search" @click="handleOpen" class="svg-icon" />
</el-tooltip>
<Modal v-model="visible" />
</div>
</template>
<style lang="scss" scoped>
.svg-icon {
font-size: 20px;
&:focus {
outline: none;
}
}
</style>

View File

@ -1,12 +0,0 @@
import { useAppStore } from "@/pinia/stores/app"
import { DeviceEnum } from "@@/constants/app-key"
const appStore = useAppStore()
const isMobile = computed(() => appStore.device === DeviceEnum.Mobile)
const isDesktop = computed(() => appStore.device === DeviceEnum.Desktop)
/** 设备类型 Composable */
export function useDevice() {
return { isMobile, isDesktop }
}

View File

@ -1,42 +0,0 @@
type OptionValue = string | number
/** Select 需要的数据格式 */
interface SelectOption {
value: OptionValue
label: string
disabled?: boolean
}
/** 接口响应格式 */
type ApiData = ApiResponseData<SelectOption[]>
/** 入参格式,暂时只需要传递 api 函数即可 */
interface FetchSelectProps {
api: () => Promise<ApiData>
}
/** 下拉选择器 Composable */
export function useFetchSelect(props: FetchSelectProps) {
const { api } = props
const loading = ref<boolean>(false)
const options = ref<SelectOption[]>([])
const value = ref<OptionValue>("")
// 调用接口获取数据
const loadData = () => {
loading.value = true
options.value = []
api().then((res) => {
options.value = res.data
}).finally(() => {
loading.value = false
})
}
onMounted(() => {
loadData()
})
return { loading, options, value }
}

View File

@ -1,36 +0,0 @@
import type { LoadingOptions } from "element-plus"
interface UseFullscreenLoading {
<T extends (...args: Parameters<T>) => ReturnType<T>>(
fn: T,
options?: LoadingOptions
): (...args: Parameters<T>) => Promise<ReturnType<T>>
}
interface LoadingInstance {
close: () => void
}
const DEFAULT_OPTIONS = {
lock: true,
text: "加载中..."
}
/**
* @name Composable
* @description fnLoading
* @param fn
* @param options LoadingOptions
* @returns Promise
*/
export const useFullscreenLoading: UseFullscreenLoading = (fn, options = {}) => {
let loadingInstance: LoadingInstance
return async (...args) => {
try {
loadingInstance = ElLoading.service({ ...DEFAULT_OPTIONS, ...options })
return await fn(...args)
} finally {
loadingInstance.close()
}
}
}

View File

@ -1,20 +0,0 @@
import { useSettingsStore } from "@/pinia/stores/settings"
const GREY_MODE = "grey-mode"
const COLOR_WEAKNESS = "color-weakness"
const classList = document.documentElement.classList
/** 初始化 */
function initGreyAndColorWeakness() {
const settingsStore = useSettingsStore()
watchEffect(() => {
classList.toggle(GREY_MODE, settingsStore.showGreyMode)
classList.toggle(COLOR_WEAKNESS, settingsStore.showColorWeakness)
})
}
/** 灰色模式和色弱模式 Composable */
export function useGreyAndColorWeakness() {
return { initGreyAndColorWeakness }
}

View File

@ -1,17 +0,0 @@
import { useSettingsStore } from "@/pinia/stores/settings"
import { LayoutModeEnum } from "@@/constants/app-key"
const settingsStore = useSettingsStore()
const isLeft = computed(() => settingsStore.layoutMode === LayoutModeEnum.Left)
const isTop = computed(() => settingsStore.layoutMode === LayoutModeEnum.Top)
const isLeftTop = computed(() => settingsStore.layoutMode === LayoutModeEnum.LeftTop)
function setLayoutMode(mode: LayoutModeEnum) {
settingsStore.layoutMode = mode
}
/** 布局模式 Composable */
export function useLayoutMode() {
return { isLeft, isTop, isLeftTop, setLayoutMode }
}

View File

@ -1,42 +0,0 @@
function initStarNotification() {
setTimeout(() => {
ElNotification({
title: "为爱发电!",
type: "success",
message: h(
"div",
null,
[
h("div", null, "所有源码均免费开源,如果对你有帮助,欢迎点个 Star 支持一下!"),
h("a", { style: "color: teal", target: "_blank", href: "https://github.com/un-pany/v3-admin-vite" }, "点击传送")
]
),
duration: 0,
position: "bottom-right"
})
}, 0)
}
function initStoreNotification() {
setTimeout(() => {
ElNotification({
title: "懒人服务?",
type: "warning",
message: h(
"div",
null,
[
h("div", null, "不想自己动手,但想移除 TS 或其他模块?也有懒人套餐!"),
h("a", { style: "color: teal", target: "_blank", href: "https://github.com/un-pany/v3-admin-vite/issues/225" }, "点击查看")
]
),
duration: 0,
position: "bottom-right"
})
}, 500)
}
/** 作者的小心思 */
export function usePany() {
return { initStarNotification, initStoreNotification }
}

View File

@ -1,52 +0,0 @@
import type { Handler } from "mitt"
import type { RouteLocationNormalizedGeneric } from "vue-router"
import mitt from "mitt"
/** 回调函数的类型 */
type Callback = (route: RouteLocationNormalizedGeneric) => void
const emitter = mitt()
const key = Symbol("ROUTE_CHANGE")
let latestRoute: RouteLocationNormalizedGeneric
/** 设置最新的路由信息,触发路由变化事件 */
export function setRouteChange(to: RouteLocationNormalizedGeneric) {
// 触发事件
emitter.emit(key, to)
// 缓存最新的路由信息
latestRoute = to
}
/**
* @name Composable
* @description 1. watch
* @description 2. 使
*/
export function useRouteListener() {
// 回调函数集合
const callbackList: Callback[] = []
// 监听路由变化(可以选择立即执行)
const listenerRouteChange = (callback: Callback, immediate = false) => {
// 缓存回调函数
callbackList.push(callback)
// 监听事件
emitter.on(key, callback as Handler)
// 可以选择立即执行一次回调函数
immediate && latestRoute && callback(latestRoute)
}
// 移除路由变化事件监听器
const removeRouteListener = (callback: Callback) => {
emitter.off(key, callback as Handler)
}
// 组件销毁前移除监听器
onBeforeUnmount(() => {
callbackList.forEach(removeRouteListener)
})
return { listenerRouteChange, removeRouteListener }
}

View File

@ -1,75 +0,0 @@
import { getActiveThemeName, setActiveThemeName } from "@@/utils/cache/local-storage"
import { setCssVar } from "@@/utils/css"
const DEFAULT_THEME_NAME = "normal"
type DefaultThemeName = typeof DEFAULT_THEME_NAME
/** 注册的主题名称, 其中 DefaultThemeName 是必填的 */
export type ThemeName = DefaultThemeName | "dark" | "dark-blue"
interface ThemeList {
title: string
name: ThemeName
}
/** 主题列表 */
const themeList: ThemeList[] = [
{
title: "默认",
name: DEFAULT_THEME_NAME
},
{
title: "黑暗",
name: "dark"
},
{
title: "深蓝",
name: "dark-blue"
}
]
/** 正在应用的主题名称 */
const activeThemeName = ref<ThemeName>(getActiveThemeName() || DEFAULT_THEME_NAME)
/** 设置主题 */
function setTheme({ clientX, clientY }: MouseEvent, value: ThemeName) {
const maxRadius = Math.hypot(
Math.max(clientX, window.innerWidth - clientX),
Math.max(clientY, window.innerHeight - clientY)
)
setCssVar("--v3-theme-x", `${clientX}px`)
setCssVar("--v3-theme-y", `${clientY}px`)
setCssVar("--v3-theme-r", `${maxRadius}px`)
const handler = () => {
activeThemeName.value = value
}
document.startViewTransition ? document.startViewTransition(handler) : handler()
}
/** 在 html 根元素上挂载 class */
function addHtmlClass(value: ThemeName) {
document.documentElement.classList.add(value)
}
/** 在 html 根元素上移除其他主题 class */
function removeHtmlClass(value: ThemeName) {
const otherThemeNameList = themeList.map(item => item.name).filter(name => name !== value)
document.documentElement.classList.remove(...otherThemeNameList)
}
/** 初始化 */
function initTheme() {
// watchEffect 来收集副作用
watchEffect(() => {
const value = activeThemeName.value
removeHtmlClass(value)
addHtmlClass(value)
setActiveThemeName(value)
})
}
/** 主题 Composable */
export function useTheme() {
return { themeList, activeThemeName, initTheme, setTheme }
}

View File

@ -1,22 +0,0 @@
/** 项目标题 */
const VITE_APP_TITLE = import.meta.env.VITE_APP_TITLE ?? "V3 Admin Vite"
/** 动态标题 */
const dynamicTitle = ref<string>("")
/** 设置标题 */
function setTitle(title?: string) {
dynamicTitle.value = title ? `${VITE_APP_TITLE} | ${title}` : VITE_APP_TITLE
}
// 监听标题变化
watch(dynamicTitle, (value, oldValue) => {
if (document && value !== oldValue) {
document.title = value
}
})
/** 标题 Composable */
export function useTitle() {
return { setTitle }
}

View File

@ -1,233 +0,0 @@
import type { Ref } from "vue"
import { debounce } from "lodash-es"
/** 默认配置 */
const DEFAULT_CONFIG = {
/** 防御(默认开启,能防御水印被删除或隐藏,但可能会有性能损耗) */
defense: true,
/** 文本颜色 */
color: "#c0c4cc",
/** 文本透明度 */
opacity: 0.5,
/** 文本字体大小 */
size: 16,
/** 文本字体 */
family: "serif",
/** 文本倾斜角度 */
angle: -20,
/** 一处水印所占宽度(数值越大水印密度越低) */
width: 300,
/** 一处水印所占高度(数值越大水印密度越低) */
height: 200
}
type DefaultConfig = typeof DEFAULT_CONFIG
interface Observer {
watermarkElMutationObserver?: MutationObserver
parentElMutationObserver?: MutationObserver
parentElResizeObserver?: ResizeObserver
}
/** body 元素 */
const bodyEl = ref<HTMLElement>(document.body)
/**
* @name Composable
* @description 1. body
* @description 2.
*/
export function useWatermark(parentEl: Ref<HTMLElement | null> = bodyEl) {
// 备份文本
let backupText: string
// 最终配置
let mergeConfig: DefaultConfig
// 水印元素
let watermarkEl: HTMLElement | null = null
// 观察器
const observer: Observer = {
watermarkElMutationObserver: undefined,
parentElMutationObserver: undefined,
parentElResizeObserver: undefined
}
// 设置水印
const setWatermark = (text: string, config: Partial<DefaultConfig> = {}) => {
if (!parentEl.value) return console.warn("请在 DOM 挂载完成后再调用 setWatermark 方法设置水印")
// 备份文本
backupText = text
// 合并配置
mergeConfig = { ...DEFAULT_CONFIG, ...config }
// 创建或更新水印元素
watermarkEl ? updateWatermarkEl() : createWatermarkEl()
// 监听水印元素和容器元素的变化
addElListener(parentEl.value)
}
// 创建水印元素
const createWatermarkEl = () => {
const isBody = parentEl.value!.tagName.toLowerCase() === bodyEl.value.tagName.toLowerCase()
const watermarkElPosition = isBody ? "fixed" : "absolute"
const parentElPosition = isBody ? "" : "relative"
watermarkEl = document.createElement("div")
watermarkEl.style.pointerEvents = "none"
watermarkEl.style.top = "0"
watermarkEl.style.left = "0"
watermarkEl.style.position = watermarkElPosition
watermarkEl.style.zIndex = "99999"
const { clientWidth, clientHeight } = parentEl.value!
updateWatermarkEl({ width: clientWidth, height: clientHeight })
// 设置水印容器为相对定位
parentEl.value!.style.position = parentElPosition
// 将水印元素添加到水印容器中
parentEl.value!.appendChild(watermarkEl)
}
// 更新水印元素
const updateWatermarkEl = (
options: Partial<{
width: number
height: number
}> = {}
) => {
if (!watermarkEl) return
backupText && (watermarkEl.style.background = `url(${createBase64()}) left top repeat`)
options.width && (watermarkEl.style.width = `${options.width}px`)
options.height && (watermarkEl.style.height = `${options.height}px`)
}
// 创建 base64 图片
const createBase64 = () => {
const { color, opacity, size, family, angle, width, height } = mergeConfig
const canvasEl = document.createElement("canvas")
canvasEl.width = width
canvasEl.height = height
const ctx = canvasEl.getContext("2d")
if (ctx) {
ctx.fillStyle = color
ctx.globalAlpha = opacity
ctx.font = `${size}px ${family}`
ctx.rotate((Math.PI / 180) * angle)
ctx.fillText(backupText, 0, height / 2)
}
return canvasEl.toDataURL()
}
// 清除水印
const clearWatermark = () => {
if (!parentEl.value || !watermarkEl) return
// 移除对水印元素和容器元素的监听
removeListener()
// 移除水印元素
try {
parentEl.value.removeChild(watermarkEl)
} catch {
// 比如在无防御情况下,用户打开控制台删除了这个元素
console.warn("水印元素已不存在,请重新创建")
} finally {
watermarkEl = null
}
}
// 刷新水印(防御时调用)
const updateWatermark = debounce(() => {
clearWatermark()
createWatermarkEl()
addElListener(parentEl.value!)
}, 100)
// 监听水印元素和容器元素的变化DOM 变化 & DOM 大小变化)
const addElListener = (targetNode: HTMLElement) => {
// 判断是否开启防御
if (mergeConfig.defense) {
// 防止重复添加监听
if (!observer.watermarkElMutationObserver && !observer.parentElMutationObserver) {
// 监听 DOM 变化
addMutationListener(targetNode)
}
} else {
// 无防御时不需要 mutation 监听
removeListener("mutation")
}
// 防止重复添加监听
if (!observer.parentElResizeObserver) {
// 监听 DOM 大小变化
addResizeListener(targetNode)
}
}
// 移除对水印元素和容器元素的监听,传参可指定要移除哪个监听,不传默认移除全部监听
const removeListener = (kind: "mutation" | "resize" | "all" = "all") => {
// 移除 mutation 监听
if (kind === "mutation" || kind === "all") {
observer.watermarkElMutationObserver?.disconnect()
observer.watermarkElMutationObserver = undefined
observer.parentElMutationObserver?.disconnect()
observer.parentElMutationObserver = undefined
}
// 移除 resize 监听
if (kind === "resize" || kind === "all") {
observer.parentElResizeObserver?.disconnect()
observer.parentElResizeObserver = undefined
}
}
// 监听 DOM 变化
const addMutationListener = (targetNode: HTMLElement) => {
// 当观察到变动时执行的回调
const mutationCallback = debounce((mutationList: MutationRecord[]) => {
// 水印的防御(防止用户手动删除水印元素或通过 CSS 隐藏水印)
mutationList.forEach(
debounce((mutation: MutationRecord) => {
switch (mutation.type) {
case "attributes":
mutation.target === watermarkEl && updateWatermark()
break
case "childList":
mutation.removedNodes.forEach((item) => {
item === watermarkEl && targetNode.appendChild(watermarkEl)
})
break
}
}, 100)
)
}, 100)
// 创建观察器实例并传入回调
observer.watermarkElMutationObserver = new MutationObserver(mutationCallback)
observer.parentElMutationObserver = new MutationObserver(mutationCallback)
// 以上述配置开始观察目标节点
observer.watermarkElMutationObserver.observe(watermarkEl!, {
// 观察目标节点属性是否变动,默认为 true
attributes: true,
// 观察目标子节点是否有添加或者删除,默认为 false
childList: false,
// 是否拓展到观察所有后代节点,默认为 false
subtree: false
})
observer.parentElMutationObserver.observe(targetNode, {
attributes: false,
childList: true,
subtree: false
})
}
// 监听 DOM 大小变化
const addResizeListener = (targetNode: HTMLElement) => {
// 当 targetNode 元素大小变化时去更新整个水印的大小
const resizeCallback = debounce(() => {
const { clientWidth, clientHeight } = targetNode
updateWatermarkEl({ width: clientWidth, height: clientHeight })
}, 500)
// 创建一个观察器实例并传入回调
observer.parentElResizeObserver = new ResizeObserver(resizeCallback)
// 开始观察目标节点
observer.parentElResizeObserver.observe(targetNode)
}
// 在组件卸载前移除水印以及各种监听
onBeforeUnmount(() => {
clearWatermark()
})
return { setWatermark, clearWatermark }
}

View File

@ -1,22 +0,0 @@
/** 设备类型 */
export enum DeviceEnum {
Mobile,
Desktop
}
/** 布局模式 */
export enum LayoutModeEnum {
Left = "left",
Top = "top",
LeftTop = "left-top"
}
/** 侧边栏打开状态常量 */
export const SIDEBAR_OPENED = "opened"
/** 侧边栏关闭状态常量 */
export const SIDEBAR_CLOSED = "closed"
export type SidebarOpened = typeof SIDEBAR_OPENED
export type SidebarClosed = typeof SIDEBAR_CLOSED

View File

@ -1,11 +0,0 @@
const SYSTEM_NAME = "v3-admin-vite"
/** 缓存数据时用到的 Key */
export class CacheKey {
static readonly TOKEN = `${SYSTEM_NAME}-token-key`
static readonly CONFIG_LAYOUT = `${SYSTEM_NAME}-config-layout-key`
static readonly SIDEBAR_STATUS = `${SYSTEM_NAME}-sidebar-status-key`
static readonly ACTIVE_THEME_NAME = `${SYSTEM_NAME}-active-theme-name-key`
static readonly VISITED_VIEWS = `${SYSTEM_NAME}-visited-views-key`
static readonly CACHED_VIEWS = `${SYSTEM_NAME}-cached-views-key`
}

View File

@ -1,16 +0,0 @@
// 统一处理 Cookie
import { CacheKey } from "@@/constants/cache-key"
import Cookies from "js-cookie"
export function getToken() {
return Cookies.get(CacheKey.TOKEN)
}
export function setToken(token: string) {
Cookies.set(CacheKey.TOKEN, token)
}
export function removeToken() {
Cookies.remove(CacheKey.TOKEN)
}

View File

@ -1,60 +0,0 @@
// 统一处理 localStorage
import type { LayoutsConfig } from "@/layouts/config"
import type { TagView } from "@/pinia/stores/tags-view"
import type { ThemeName } from "@@/composables/useTheme"
import type { SidebarClosed, SidebarOpened } from "@@/constants/app-key"
import { CacheKey } from "@@/constants/cache-key"
// #region 系统布局配置
export function getLayoutsConfig() {
const json = localStorage.getItem(CacheKey.CONFIG_LAYOUT)
return json ? (JSON.parse(json) as LayoutsConfig) : null
}
export function setLayoutsConfig(settings: LayoutsConfig) {
localStorage.setItem(CacheKey.CONFIG_LAYOUT, JSON.stringify(settings))
}
export function removeLayoutsConfig() {
localStorage.removeItem(CacheKey.CONFIG_LAYOUT)
}
// #endregion
// #region 侧边栏状态
export function getSidebarStatus() {
return localStorage.getItem(CacheKey.SIDEBAR_STATUS)
}
export function setSidebarStatus(sidebarStatus: SidebarOpened | SidebarClosed) {
localStorage.setItem(CacheKey.SIDEBAR_STATUS, sidebarStatus)
}
// #endregion
// #region 正在应用的主题名称
export function getActiveThemeName() {
return localStorage.getItem(CacheKey.ACTIVE_THEME_NAME) as ThemeName | null
}
export function setActiveThemeName(themeName: ThemeName) {
localStorage.setItem(CacheKey.ACTIVE_THEME_NAME, themeName)
}
// #endregion
// #region 标签栏
export function getVisitedViews() {
const json = localStorage.getItem(CacheKey.VISITED_VIEWS)
return JSON.parse(json ?? "[]") as TagView[]
}
export function setVisitedViews(views: TagView[]) {
views.forEach((view) => {
// 删除不必要的属性,防止 JSON.stringify 处理到循环引用
delete view.matched
delete view.redirectedFrom
})
localStorage.setItem(CacheKey.VISITED_VIEWS, JSON.stringify(views))
}
export function getCachedViews() {
const json = localStorage.getItem(CacheKey.CACHED_VIEWS)
return JSON.parse(json ?? "[]") as string[]
}
export function setCachedViews(views: string[]) {
localStorage.setItem(CacheKey.CACHED_VIEWS, JSON.stringify(views))
}
// #endregion

View File

@ -1,18 +0,0 @@
/** 获取指定元素(默认全局)上的 CSS 变量的值 */
export function getCssVar(varName: string, element: HTMLElement = document.documentElement) {
if (!varName?.startsWith("--")) {
console.error("CSS 变量名应以 '--' 开头")
return ""
}
// 没有拿到值时,会返回空串
return getComputedStyle(element).getPropertyValue(varName)
}
/** 设置指定元素(默认全局)上的 CSS 变量的值 */
export function setCssVar(varName: string, value: string, element: HTMLElement = document.documentElement) {
if (!varName?.startsWith("--")) {
console.error("CSS 变量名应以 '--' 开头")
return
}
element.style.setProperty(varName, value)
}

View File

@ -1,9 +0,0 @@
import dayjs from "dayjs"
const INVALID_DATE = "N/A"
/** 格式化日期时间 */
export function formatDateTime(datetime: string | number | Date = "", template: string = "YYYY-MM-DD HH:mm:ss") {
const day = dayjs(datetime)
return day.isValid() ? day.format(template) : INVALID_DATE
}

View File

@ -1,13 +0,0 @@
import { useUserStore } from "@/pinia/stores/user"
import { isArray } from "@@/utils/validate"
/** 全局权限判断函数,和权限指令 v-permission 功能类似 */
export function checkPermission(permissionRoles: string[]): boolean {
if (isArray(permissionRoles) && permissionRoles.length > 0) {
const { roles } = useUserStore()
return roles.some(role => permissionRoles.includes(role))
} else {
console.error("参数必须是一个数组且长度大于 0参考checkPermission(['admin', 'editor'])")
return false
}
}

View File

@ -1,15 +0,0 @@
/** 判断是否为数组 */
export function isArray<T>(arg: T) {
return Array.isArray ? Array.isArray(arg) : Object.prototype.toString.call(arg) === "[object Array]"
}
/** 判断是否为字符串 */
export function isString(str: unknown) {
return typeof str === "string" || str instanceof String
}
/** 判断是否为外链 */
export function isExternal(path: string) {
const reg = /^(https?:|mailto:|tel:)/
return reg.test(path)
}

View File

@ -0,0 +1,48 @@
<script lang="ts" setup>
import { ref, onUnmounted } from "vue"
import { ElMessage } from "element-plus"
import screenfull from "screenfull"
type contentType = "全屏" | "退出全屏"
const content = ref<contentType>("全屏")
const isFullscreen = ref(false)
const click = () => {
if (!screenfull.isEnabled) {
ElMessage.warning("您的浏览器无法工作")
return
}
screenfull.toggle()
}
const change = () => {
isFullscreen.value = screenfull.isFullscreen
content.value = screenfull.isFullscreen ? "退出全屏" : "全屏"
}
screenfull.on("change", change)
onUnmounted(() => {
if (screenfull.isEnabled) {
screenfull.off("change", change)
}
})
</script>
<template>
<div @click="click">
<el-tooltip effect="dark" :content="content" placement="bottom">
<svg-icon :name="isFullscreen ? 'fullscreen-exit' : 'fullscreen'" />
</el-tooltip>
</div>
</template>
<style lang="scss" scoped>
.svg-icon {
font-size: 20px;
&:focus {
outline: none;
}
}
</style>

View File

@ -0,0 +1,31 @@
<script lang="ts" setup>
import { computed } from "vue"
const props = defineProps({
prefix: {
type: String,
default: "icon"
},
name: {
type: String,
required: true
}
})
const symbolId = computed(() => `#${props.prefix}-${props.name}`)
</script>
<template>
<svg class="svg-icon" aria-hidden="true">
<use :href="symbolId" />
</svg>
</template>
<style lang="scss" scoped>
.svg-icon {
width: 1em;
height: 1em;
fill: currentColor;
overflow: hidden;
}
</style>

View File

@ -1,12 +1,16 @@
<script lang="ts" setup>
import { useTheme } from "@@/composables/useTheme"
import { type ThemeName, useTheme } from "@/hooks/useTheme"
import { MagicStick } from "@element-plus/icons-vue"
const { themeList, activeThemeName, setTheme } = useTheme()
const handleSetTheme = (name: ThemeName) => {
setTheme(name)
}
</script>
<template>
<el-dropdown trigger="click">
<el-dropdown trigger="click" @command="handleSetTheme">
<div>
<el-tooltip effect="dark" content="主题模式" placement="bottom">
<el-icon :size="20">
@ -20,7 +24,7 @@ const { themeList, activeThemeName, setTheme } = useTheme()
v-for="(theme, index) in themeList"
:key="index"
:disabled="activeThemeName === theme.name"
@click="(e: MouseEvent) => setTheme(e, theme.name)"
:command="theme.name"
>
<span>{{ theme.title }}</span>
</el-dropdown-item>

21
src/config/async-route.ts Normal file
View File

@ -0,0 +1,21 @@
/** 动态路由配置 */
interface IAsyncRouteSettings {
/**
*
* 1. roles
* 2. open: false
*/
open: boolean
/**
* 1. 访
* 2. admin
*/
defaultRoles: Array<string>
}
const asyncRouteSettings: IAsyncRouteSettings = {
open: true,
defaultRoles: ["admin"]
}
export default asyncRouteSettings

26
src/config/layout.ts Normal file
View File

@ -0,0 +1,26 @@
/** 布局配置 */
interface ILayoutSettings {
/** 是否显示 Settings Panel */
showSettings: boolean
/** 是否显示标签栏 */
showTagsView: boolean
/** 是否显示侧边栏 Logo */
showSidebarLogo: boolean
/** 是否固定 Header */
fixedHeader: boolean
/** 是否显示切换主题按钮 */
showThemeSwitch: boolean
/** 是否显示全屏按钮 */
showScreenfull: boolean
}
const layoutSettings: ILayoutSettings = {
showSettings: true,
showTagsView: true,
fixedHeader: true,
showSidebarLogo: true,
showThemeSwitch: true,
showScreenfull: true
}
export default layoutSettings

4
src/config/white-list.ts Normal file
View File

@ -0,0 +1,4 @@
/** 免登录白名单 */
const whiteList = ["/login"]
export { whiteList }

10
src/constants/cacheKey.ts Normal file
View File

@ -0,0 +1,10 @@
const SYSTEM_NAME = "v3-admin-vite"
/** 缓存数据时用到的 Key */
class CacheKey {
static TOKEN = `${SYSTEM_NAME}-token-key`
static SIDEBAR_STATUS = `${SYSTEM_NAME}-sidebar-status-key`
static ACTIVE_THEME_NAME = `${SYSTEM_NAME}-active-theme-name-key`
}
export default CacheKey

7
src/directives/index.ts Normal file
View File

@ -0,0 +1,7 @@
import { type App } from "vue"
import { permission } from "./permission"
/** 挂载自定义指令 */
export function loadDirectives(app: App) {
app.directive("permission", permission)
}

Some files were not shown because too many files have changed in this diff Show More