├── .eslintignore ├── tests └── unit │ ├── .eslintrc.js │ ├── utils │ ├── param2Obj.spec.js │ ├── validate.spec.js │ ├── formatTime.spec.js │ └── parseTime.spec.js │ └── components │ ├── Hamburger.spec.js │ ├── SvgIcon.spec.js │ └── Breadcrumb.spec.js ├── public ├── favicon.ico └── index.html ├── .env.development ├── .travis.yml ├── .env.production ├── src ├── assets │ └── 404_images │ │ ├── 404.png │ │ └── 404_cloud.png ├── views │ ├── nested │ │ ├── menu2 │ │ │ └── index.vue │ │ └── menu1 │ │ │ ├── menu1-3 │ │ │ └── index.vue │ │ │ ├── menu1-2 │ │ │ ├── menu1-2-1 │ │ │ │ └── index.vue │ │ │ ├── menu1-2-2 │ │ │ │ └── index.vue │ │ │ └── index.vue │ │ │ ├── index.vue │ │ │ └── menu1-1 │ │ │ └── index.vue │ ├── dashboard │ │ └── index.vue │ ├── tree │ │ └── index.vue │ ├── table │ │ └── index.vue │ ├── form │ │ └── index.vue │ ├── 404.vue │ └── login │ │ └── index.vue ├── layout │ ├── components │ │ ├── index.js │ │ ├── Sidebar │ │ │ ├── FixiOSBug.js │ │ │ ├── Link.vue │ │ │ ├── Item.vue │ │ │ ├── index.vue │ │ │ ├── Logo.vue │ │ │ └── SidebarItem.vue │ │ ├── AppMain.vue │ │ └── Navbar.vue │ ├── mixin │ │ └── ResizeHandler.js │ └── index.vue ├── App.vue ├── api │ ├── table.js │ └── user.js ├── store │ ├── getters.js │ ├── index.js │ └── modules │ │ ├── settings.js │ │ ├── app.js │ │ └── user.js ├── icons │ ├── svg │ │ ├── link.svg │ │ ├── user.svg │ │ ├── example.svg │ │ ├── table.svg │ │ ├── password.svg │ │ ├── nested.svg │ │ ├── eye.svg │ │ ├── eye-open.svg │ │ ├── tree.svg │ │ ├── dashboard.svg │ │ └── form.svg │ ├── svgo.yml │ └── index.js ├── utils │ ├── get-page-title.js │ ├── auth.js │ ├── validate.js │ ├── request.js │ └── index.js ├── settings.js ├── styles │ ├── mixin.scss │ ├── variables.scss │ ├── element-ui.scss │ ├── transition.scss │ ├── index.scss │ └── sidebar.scss ├── components │ ├── NavLink │ │ └── index.vue │ ├── Hamburger │ │ └── index.vue │ ├── SvgIcon │ │ └── index.vue │ └── Breadcrumb │ │ └── index.vue ├── main.js ├── permission.js └── router │ └── index.js ├── .env.staging ├── jsconfig.json ├── postcss.config.js ├── .gitignore ├── .editorconfig ├── prettier.config.js ├── babel.config.js ├── mock ├── utils.js ├── table.js ├── index.js ├── user.js └── mock-server.js ├── jest.config.js ├── LICENSE ├── README-zh.md ├── package.json ├── README.md ├── vue.config.js └── .eslintrc.js /.eslintignore: -------------------------------------------------------------------------------- 1 | build/*.js 2 | src/assets 3 | public 4 | dist 5 | -------------------------------------------------------------------------------- /tests/unit/.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | env: { 3 | jest: true 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hug-sun/element3-admin-template/master/public/favicon.ico -------------------------------------------------------------------------------- /.env.development: -------------------------------------------------------------------------------- 1 | # just a flag 2 | ENV = 'development' 3 | 4 | # base api 5 | VUE_APP_BASE_API = '/dev-api' 6 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | node_js: 10 3 | script: npm run test 4 | notifications: 5 | email: false 6 | -------------------------------------------------------------------------------- /.env.production: -------------------------------------------------------------------------------- 1 | # just a flag 2 | ENV = 'production' 3 | 4 | # base api 5 | VUE_APP_BASE_API = '/prod-api' 6 | 7 | -------------------------------------------------------------------------------- /src/assets/404_images/404.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hug-sun/element3-admin-template/master/src/assets/404_images/404.png -------------------------------------------------------------------------------- /.env.staging: -------------------------------------------------------------------------------- 1 | NODE_ENV = production 2 | 3 | # just a flag 4 | ENV = 'staging' 5 | 6 | # base api 7 | VUE_APP_BASE_API = '/stage-api' 8 | 9 | -------------------------------------------------------------------------------- /src/assets/404_images/404_cloud.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hug-sun/element3-admin-template/master/src/assets/404_images/404_cloud.png -------------------------------------------------------------------------------- /src/views/nested/menu2/index.vue: -------------------------------------------------------------------------------- 1 | 6 | -------------------------------------------------------------------------------- /src/layout/components/index.js: -------------------------------------------------------------------------------- 1 | export { default as Navbar } from './Navbar' 2 | export { default as Sidebar } from './Sidebar' 3 | export { default as AppMain } from './AppMain' 4 | -------------------------------------------------------------------------------- /src/App.vue: -------------------------------------------------------------------------------- 1 | 6 | 7 | 12 | -------------------------------------------------------------------------------- /jsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "baseUrl": "./", 4 | "paths": { 5 | "@/*": ["src/*"] 6 | } 7 | }, 8 | "exclude": ["node_modules", "dist"] 9 | } 10 | -------------------------------------------------------------------------------- /src/views/nested/menu1/menu1-3/index.vue: -------------------------------------------------------------------------------- 1 | 6 | -------------------------------------------------------------------------------- /src/views/nested/menu1/menu1-2/menu1-2-1/index.vue: -------------------------------------------------------------------------------- 1 | 6 | -------------------------------------------------------------------------------- /src/views/nested/menu1/menu1-2/menu1-2-2/index.vue: -------------------------------------------------------------------------------- 1 | 6 | -------------------------------------------------------------------------------- /src/api/table.js: -------------------------------------------------------------------------------- 1 | import request from '@/utils/request' 2 | 3 | export function getList(params) { 4 | return request({ 5 | url: '/vue-admin-template/table/list', 6 | method: 'get', 7 | params 8 | }) 9 | } 10 | -------------------------------------------------------------------------------- /postcss.config.js: -------------------------------------------------------------------------------- 1 | // https://github.com/michael-ciniawsky/postcss-load-config 2 | 3 | module.exports = { 4 | 'plugins': { 5 | // to edit target browsers: use "browserslist" field in package.json 6 | 'autoprefixer': {} 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /src/store/getters.js: -------------------------------------------------------------------------------- 1 | const getters = { 2 | sidebar: state => state.app.sidebar, 3 | device: state => state.app.device, 4 | token: state => state.user.token, 5 | avatar: state => state.user.avatar, 6 | name: state => state.user.name 7 | } 8 | export default getters 9 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | node_modules/ 3 | dist/ 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | package-lock.json 8 | tests/**/coverage/ 9 | 10 | # Editor directories and files 11 | .idea 12 | .vscode 13 | *.suo 14 | *.ntvs* 15 | *.njsproj 16 | *.sln 17 | -------------------------------------------------------------------------------- /src/icons/svg/link.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/views/nested/menu1/index.vue: -------------------------------------------------------------------------------- 1 | 10 | -------------------------------------------------------------------------------- /src/utils/get-page-title.js: -------------------------------------------------------------------------------- 1 | import defaultSettings from '@/settings' 2 | 3 | const title = defaultSettings.title || 'Vue Admin Template' 4 | 5 | export default function getPageTitle(pageTitle) { 6 | if (pageTitle) { 7 | return `${pageTitle} - ${title}` 8 | } 9 | return `${title}` 10 | } 11 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # http://editorconfig.org 2 | root = true 3 | 4 | [*] 5 | charset = utf-8 6 | indent_style = space 7 | indent_size = 2 8 | end_of_line = lf 9 | insert_final_newline = true 10 | trim_trailing_whitespace = true 11 | 12 | [*.md] 13 | insert_final_newline = false 14 | trim_trailing_whitespace = false 15 | -------------------------------------------------------------------------------- /src/views/nested/menu1/menu1-1/index.vue: -------------------------------------------------------------------------------- 1 | 10 | -------------------------------------------------------------------------------- /src/views/nested/menu1/menu1-2/index.vue: -------------------------------------------------------------------------------- 1 | 10 | -------------------------------------------------------------------------------- /src/icons/svgo.yml: -------------------------------------------------------------------------------- 1 | # replace default config 2 | 3 | # multipass: true 4 | # full: true 5 | 6 | plugins: 7 | 8 | # - name 9 | # 10 | # or: 11 | # - name: false 12 | # - name: true 13 | # 14 | # or: 15 | # - name: 16 | # param1: 1 17 | # param2: 2 18 | 19 | - removeAttrs: 20 | attrs: 21 | - 'fill' 22 | - 'fill-rule' 23 | -------------------------------------------------------------------------------- /src/settings.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | 3 | title: 'Vue Admin Template', 4 | 5 | /** 6 | * @type {boolean} true | false 7 | * @description Whether fix the header 8 | */ 9 | fixedHeader: false, 10 | 11 | /** 12 | * @type {boolean} true | false 13 | * @description Whether show the logo in sidebar 14 | */ 15 | sidebarLogo: false 16 | } 17 | -------------------------------------------------------------------------------- /src/utils/auth.js: -------------------------------------------------------------------------------- 1 | import Cookies from 'js-cookie' 2 | 3 | const TokenKey = 'vue_admin_template_token' 4 | 5 | export function getToken() { 6 | return Cookies.get(TokenKey) 7 | } 8 | 9 | export function setToken(token) { 10 | return Cookies.set(TokenKey, token) 11 | } 12 | 13 | export function removeToken() { 14 | return Cookies.remove(TokenKey) 15 | } 16 | -------------------------------------------------------------------------------- /src/store/index.js: -------------------------------------------------------------------------------- 1 | import Vuex from 'vuex' 2 | import getters from './getters' 3 | import app from './modules/app' 4 | import settings from './modules/settings' 5 | import user from './modules/user' 6 | 7 | const store = new Vuex.Store({ 8 | modules: { 9 | app, 10 | settings, 11 | user 12 | }, 13 | getters 14 | }) 15 | 16 | export default store 17 | -------------------------------------------------------------------------------- /src/icons/index.js: -------------------------------------------------------------------------------- 1 | import SvgIcon from '@/components/SvgIcon' // svg component 2 | 3 | export function useIcons(app) { 4 | // register globally 5 | app.component('SvgIcon', SvgIcon) 6 | 7 | const req = require.context('./svg', false, /\.svg$/) 8 | const requireAll = requireContext => 9 | requireContext.keys().map(requireContext) 10 | requireAll(req) 11 | } 12 | -------------------------------------------------------------------------------- /src/icons/svg/user.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/utils/validate.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Created by PanJiaChen on 16/11/18. 3 | */ 4 | 5 | /** 6 | * @param {string} path 7 | * @returns {Boolean} 8 | */ 9 | export function isExternal(path) { 10 | return /^(https?:|mailto:|tel:)/.test(path) 11 | } 12 | 13 | /** 14 | * @param {string} str 15 | * @returns {Boolean} 16 | */ 17 | export function validUsername(str) { 18 | const valid_map = ['admin', 'editor'] 19 | return valid_map.indexOf(str.trim()) >= 0 20 | } 21 | -------------------------------------------------------------------------------- /tests/unit/utils/param2Obj.spec.js: -------------------------------------------------------------------------------- 1 | import { param2Obj } from '@/utils/index.js' 2 | describe('Utils:param2Obj', () => { 3 | const url = 'https://github.com/PanJiaChen/vue-element-admin?name=bill&age=29&sex=1&field=dGVzdA==&key=%E6%B5%8B%E8%AF%95' 4 | 5 | it('param2Obj test', () => { 6 | expect(param2Obj(url)).toEqual({ 7 | name: 'bill', 8 | age: '29', 9 | sex: '1', 10 | field: window.btoa('test'), 11 | key: '测试' 12 | }) 13 | }) 14 | }) 15 | -------------------------------------------------------------------------------- /prettier.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | printWidth: 80, // 每行代码长度（默认80） 3 | tabWidth: 2, // 每个tab相当于多少个空格（默认2） 4 | useTabs: false, // 是否使用tab进行缩进（默认false） 5 | singleQuote: true, // 使用单引号（默认false） 6 | semi: false, // 声明结尾使用分号(默认true) 7 | trailingComma: true, // 多行使用拖尾逗号（默认none） 8 | bracketSpacing: true, // 对象字面量的大括号间使用空格（默认true） 9 | jsxBracketSameLine: false, // 多行JSX中的>放置在最后一行的结尾，而不是另起一行（默认false） 10 | arrowParens: "avoid", // 只有一个参数的箭头函数的参数是否带圆括号（默认avoid） 11 | }; 12 | -------------------------------------------------------------------------------- /src/icons/svg/example.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/styles/mixin.scss: -------------------------------------------------------------------------------- 1 | @mixin clearfix { 2 | &:after { 3 | content: ""; 4 | display: table; 5 | clear: both; 6 | } 7 | } 8 | 9 | @mixin scrollBar { 10 | &::-webkit-scrollbar-track-piece { 11 | background: #d3dce6; 12 | } 13 | 14 | &::-webkit-scrollbar { 15 | width: 6px; 16 | } 17 | 18 | &::-webkit-scrollbar-thumb { 19 | background: #99a9bf; 20 | border-radius: 20px; 21 | } 22 | } 23 | 24 | @mixin relative { 25 | position: relative; 26 | width: 100%; 27 | height: 100%; 28 | } 29 | -------------------------------------------------------------------------------- /src/api/user.js: -------------------------------------------------------------------------------- 1 | import request from '@/utils/request' 2 | 3 | export function login(data) { 4 | return request({ 5 | url: '/vue-admin-template/user/login', 6 | method: 'post', 7 | data 8 | }) 9 | } 10 | 11 | export function getInfo(token) { 12 | return request({ 13 | url: '/vue-admin-template/user/info', 14 | method: 'get', 15 | params: { token } 16 | }) 17 | } 18 | 19 | export function logout() { 20 | return request({ 21 | url: '/vue-admin-template/user/logout', 22 | method: 'post' 23 | }) 24 | } 25 | -------------------------------------------------------------------------------- /src/views/dashboard/index.vue: -------------------------------------------------------------------------------- 1 | 6 | 7 | 19 | 20 | 31 | -------------------------------------------------------------------------------- /src/icons/svg/table.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /babel.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | presets: [ 3 | // https://github.com/vuejs/vue-cli/tree/master/packages/@vue/babel-preset-app 4 | '@vue/cli-plugin-babel/preset' 5 | ], 6 | 'env': { 7 | 'development': { 8 | // babel-plugin-dynamic-import-node plugin only does one thing by converting all import() to require(). 9 | // This plugin can significantly increase the speed of hot updates, when you have a large number of pages. 10 | // https://panjiachen.github.io/vue-element-admin-site/guide/advanced/lazy-loading.html 11 | 'plugins': ['dynamic-import-node'] 12 | } 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /mock/utils.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @param {string} url 3 | * @returns {Object} 4 | */ 5 | function param2Obj(url) { 6 | const search = decodeURIComponent(url.split('?')[1]).replace(/\+/g, ' ') 7 | if (!search) { 8 | return {} 9 | } 10 | const obj = {} 11 | const searchArr = search.split('&') 12 | searchArr.forEach(v => { 13 | const index = v.indexOf('=') 14 | if (index !== -1) { 15 | const name = v.substring(0, index) 16 | const val = v.substring(index + 1, v.length) 17 | obj[name] = val 18 | } 19 | }) 20 | return obj 21 | } 22 | 23 | module.exports = { 24 | param2Obj 25 | } 26 | -------------------------------------------------------------------------------- /src/icons/svg/password.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /mock/table.js: -------------------------------------------------------------------------------- 1 | const Mock = require('mockjs') 2 | 3 | const data = Mock.mock({ 4 | 'items|30': [{ 5 | id: '@id', 6 | title: '@sentence(10, 20)', 7 | 'status|1': ['published', 'draft', 'deleted'], 8 | author: 'name', 9 | display_time: '@datetime', 10 | pageviews: '@integer(300, 5000)' 11 | }] 12 | }) 13 | 14 | module.exports = [ 15 | { 16 | url: '/vue-admin-template/table/list', 17 | type: 'get', 18 | response: config => { 19 | const items = data.items 20 | return { 21 | code: 20000, 22 | data: { 23 | total: items.length, 24 | items: items 25 | } 26 | } 27 | } 28 | } 29 | ] 30 | -------------------------------------------------------------------------------- /public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | <%= htmlWebpackPlugin.options.title %> 9 | 10 | 11 | 14 |
15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /src/store/modules/settings.js: -------------------------------------------------------------------------------- 1 | import defaultSettings from '@/settings' 2 | 3 | const { showSettings, fixedHeader, sidebarLogo } = defaultSettings 4 | 5 | const state = { 6 | showSettings: showSettings, 7 | fixedHeader: fixedHeader, 8 | sidebarLogo: sidebarLogo 9 | } 10 | 11 | const mutations = { 12 | CHANGE_SETTING: (state, { key, value }) => { 13 | // eslint-disable-next-line no-prototype-builtins 14 | if (state.hasOwnProperty(key)) { 15 | state[key] = value 16 | } 17 | } 18 | } 19 | 20 | const actions = { 21 | changeSetting({ commit }, data) { 22 | commit('CHANGE_SETTING', data) 23 | } 24 | } 25 | 26 | export default { 27 | namespaced: true, 28 | state, 29 | mutations, 30 | actions 31 | } 32 | 33 | -------------------------------------------------------------------------------- /src/styles/variables.scss: -------------------------------------------------------------------------------- 1 | // sidebar 2 | $menuText:#bfcbd9; 3 | $menuActiveText:#409EFF; 4 | $subMenuActiveText:#f4f4f5; //https://github.com/ElemeFE/element/issues/12951 5 | 6 | $menuBg:#304156; 7 | $menuHover:#263445; 8 | 9 | $subMenuBg:#1f2d3d; 10 | $subMenuHover:#001528; 11 | 12 | $sideBarWidth: 210px; 13 | 14 | // the :export directive is the magic sauce for webpack 15 | // https://www.bluematador.com/blog/how-to-share-variables-between-js-and-sass 16 | :export { 17 | menuText: $menuText; 18 | menuActiveText: $menuActiveText; 19 | subMenuActiveText: $subMenuActiveText; 20 | menuBg: $menuBg; 21 | menuHover: $menuHover; 22 | subMenuBg: $subMenuBg; 23 | subMenuHover: $subMenuHover; 24 | sideBarWidth: $sideBarWidth; 25 | } 26 | -------------------------------------------------------------------------------- /tests/unit/components/Hamburger.spec.js: -------------------------------------------------------------------------------- 1 | import { shallowMount } from '@vue/test-utils' 2 | import Hamburger from '@/components/Hamburger/index.vue' 3 | describe('Hamburger.vue', () => { 4 | it('toggle click', () => { 5 | const wrapper = shallowMount(Hamburger) 6 | const mockFn = jest.fn() 7 | wrapper.vm.$on('toggleClick', mockFn) 8 | wrapper.find('.hamburger').trigger('click') 9 | expect(mockFn).toBeCalled() 10 | }) 11 | it('prop isActive', () => { 12 | const wrapper = shallowMount(Hamburger) 13 | wrapper.setProps({ isActive: true }) 14 | expect(wrapper.contains('.is-active')).toBe(true) 15 | wrapper.setProps({ isActive: false }) 16 | expect(wrapper.contains('.is-active')).toBe(false) 17 | }) 18 | }) 19 | -------------------------------------------------------------------------------- /tests/unit/components/SvgIcon.spec.js: -------------------------------------------------------------------------------- 1 | import { shallowMount } from '@vue/test-utils' 2 | import SvgIcon from '@/components/SvgIcon/index.vue' 3 | describe('SvgIcon.vue', () => { 4 | it('iconClass', () => { 5 | const wrapper = shallowMount(SvgIcon, { 6 | propsData: { 7 | iconClass: 'test' 8 | } 9 | }) 10 | expect(wrapper.find('use').attributes().href).toBe('#icon-test') 11 | }) 12 | it('className', () => { 13 | const wrapper = shallowMount(SvgIcon, { 14 | propsData: { 15 | iconClass: 'test' 16 | } 17 | }) 18 | expect(wrapper.classes().length).toBe(1) 19 | wrapper.setProps({ className: 'test' }) 20 | expect(wrapper.classes().includes('test')).toBe(true) 21 | }) 22 | }) 23 | -------------------------------------------------------------------------------- /src/layout/components/Sidebar/FixiOSBug.js: -------------------------------------------------------------------------------- 1 | export default { 2 | computed: { 3 | device() { 4 | return this.$store.state.app.device 5 | } 6 | }, 7 | mounted() { 8 | // In order to fix the click on menu on the ios device will trigger the mouseleave bug 9 | // https://github.com/PanJiaChen/vue-element-admin/issues/1135 10 | this.fixBugIniOS() 11 | }, 12 | methods: { 13 | fixBugIniOS() { 14 | const $subMenu = this.$refs.subMenu 15 | if ($subMenu) { 16 | const handleMouseleave = $subMenu.handleMouseleave 17 | $subMenu.handleMouseleave = (e) => { 18 | if (this.device === 'mobile') { 19 | return 20 | } 21 | handleMouseleave(e) 22 | } 23 | } 24 | } 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /tests/unit/utils/validate.spec.js: -------------------------------------------------------------------------------- 1 | import { validUsername, isExternal } from '@/utils/validate.js' 2 | 3 | describe('Utils:validate', () => { 4 | it('validUsername', () => { 5 | expect(validUsername('admin')).toBe(true) 6 | expect(validUsername('editor')).toBe(true) 7 | expect(validUsername('xxxx')).toBe(false) 8 | }) 9 | it('isExternal', () => { 10 | expect(isExternal('https://github.com/PanJiaChen/vue-element-admin')).toBe(true) 11 | expect(isExternal('http://github.com/PanJiaChen/vue-element-admin')).toBe(true) 12 | expect(isExternal('github.com/PanJiaChen/vue-element-admin')).toBe(false) 13 | expect(isExternal('/dashboard')).toBe(false) 14 | expect(isExternal('./dashboard')).toBe(false) 15 | expect(isExternal('dashboard')).toBe(false) 16 | }) 17 | }) 18 | -------------------------------------------------------------------------------- /src/icons/svg/nested.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | moduleFileExtensions: ['js', 'jsx', 'json', 'vue'], 3 | transform: { 4 | '^.+\\.vue$': 'vue-jest', 5 | '.+\\.(css|styl|less|sass|scss|svg|png|jpg|ttf|woff|woff2)$': 6 | 'jest-transform-stub', 7 | '^.+\\.jsx?$': 'babel-jest' 8 | }, 9 | moduleNameMapper: { 10 | '^@/(.*)$': '/src/$1' 11 | }, 12 | snapshotSerializers: ['jest-serializer-vue'], 13 | testMatch: [ 14 | '**/tests/unit/**/*.spec.(js|jsx|ts|tsx)|**/__tests__/*.(js|jsx|ts|tsx)' 15 | ], 16 | collectCoverageFrom: ['src/utils/**/*.{js,vue}', '!src/utils/auth.js', '!src/utils/request.js', 'src/components/**/*.{js,vue}'], 17 | coverageDirectory: '/tests/unit/coverage', 18 | // 'collectCoverage': true, 19 | 'coverageReporters': [ 20 | 'lcov', 21 | 'text-summary' 22 | ], 23 | testURL: 'http://localhost/' 24 | } 25 | -------------------------------------------------------------------------------- /src/components/NavLink/index.vue: -------------------------------------------------------------------------------- 1 | 16 | 17 | -------------------------------------------------------------------------------- /src/layout/components/Sidebar/Link.vue: -------------------------------------------------------------------------------- 1 | 6 | 7 | 44 | -------------------------------------------------------------------------------- /src/layout/components/AppMain.vue: -------------------------------------------------------------------------------- 1 | 10 | 11 | 21 | 22 | 34 | 35 | 43 | -------------------------------------------------------------------------------- /src/styles/element-ui.scss: -------------------------------------------------------------------------------- 1 | // cover some element-ui styles 2 | 3 | .el-breadcrumb__inner, 4 | .el-breadcrumb__inner a { 5 | font-weight: 400 !important; 6 | } 7 | 8 | .el-upload { 9 | input[type="file"] { 10 | display: none !important; 11 | } 12 | } 13 | 14 | .el-upload__input { 15 | display: none; 16 | } 17 | 18 | 19 | // to fixed https://github.com/ElemeFE/element/issues/2461 20 | .el-dialog { 21 | transform: none; 22 | left: 0; 23 | position: relative; 24 | margin: 0 auto; 25 | } 26 | 27 | // refine element ui upload 28 | .upload-container { 29 | .el-upload { 30 | width: 100%; 31 | 32 | .el-upload-dragger { 33 | width: 100%; 34 | height: 200px; 35 | } 36 | } 37 | } 38 | 39 | // dropdown 40 | .el-dropdown-menu { 41 | a { 42 | display: block 43 | } 44 | } 45 | 46 | // to fix el-date-picker css style 47 | .el-range-separator { 48 | box-sizing: content-box; 49 | } 50 | -------------------------------------------------------------------------------- /src/icons/svg/eye.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/styles/transition.scss: -------------------------------------------------------------------------------- 1 | // global transition css 2 | 3 | /* fade */ 4 | .fade-enter-active, 5 | .fade-leave-active { 6 | transition: opacity 0.28s; 7 | } 8 | 9 | .fade-enter, 10 | .fade-leave-active { 11 | opacity: 0; 12 | } 13 | 14 | /* fade-transform */ 15 | .fade-transform-leave-active, 16 | .fade-transform-enter-active { 17 | transition: all .5s; 18 | } 19 | 20 | .fade-transform-enter { 21 | opacity: 0; 22 | transform: translateX(-30px); 23 | } 24 | 25 | .fade-transform-leave-to { 26 | opacity: 0; 27 | transform: translateX(30px); 28 | } 29 | 30 | /* breadcrumb transition */ 31 | .breadcrumb-enter-active, 32 | .breadcrumb-leave-active { 33 | transition: all .5s; 34 | } 35 | 36 | .breadcrumb-enter, 37 | .breadcrumb-leave-active { 38 | opacity: 0; 39 | transform: translateX(20px); 40 | } 41 | 42 | .breadcrumb-move { 43 | transition: all .5s; 44 | } 45 | 46 | .breadcrumb-leave-active { 47 | position: absolute; 48 | } 49 | -------------------------------------------------------------------------------- /src/layout/components/Sidebar/Item.vue: -------------------------------------------------------------------------------- 1 | 37 | 38 | 45 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2017-present PanJiaChen 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /tests/unit/utils/formatTime.spec.js: -------------------------------------------------------------------------------- 1 | import { formatTime } from '@/utils/index.js' 2 | 3 | describe('Utils:formatTime', () => { 4 | const d = new Date('2018-07-13 17:54:01') // "2018-07-13 17:54:01" 5 | const retrofit = 5 * 1000 6 | 7 | it('ten digits timestamp', () => { 8 | expect(formatTime((d / 1000).toFixed(0))).toBe('7月13日17时54分') 9 | }) 10 | it('test now', () => { 11 | expect(formatTime(+new Date() - 1)).toBe('刚刚') 12 | }) 13 | it('less two minute', () => { 14 | expect(formatTime(+new Date() - 60 * 2 * 1000 + retrofit)).toBe('2分钟前') 15 | }) 16 | it('less two hour', () => { 17 | expect(formatTime(+new Date() - 60 * 60 * 2 * 1000 + retrofit)).toBe('2小时前') 18 | }) 19 | it('less one day', () => { 20 | expect(formatTime(+new Date() - 60 * 60 * 24 * 1 * 1000)).toBe('1天前') 21 | }) 22 | it('more than one day', () => { 23 | expect(formatTime(d)).toBe('7月13日17时54分') 24 | }) 25 | it('format', () => { 26 | expect(formatTime(d, '{y}-{m}-{d} {h}:{i}')).toBe('2018-07-13 17:54') 27 | expect(formatTime(d, '{y}-{m}-{d}')).toBe('2018-07-13') 28 | expect(formatTime(d, '{y}/{m}/{d} {h}-{i}')).toBe('2018/07/13 17-54') 29 | }) 30 | }) 31 | -------------------------------------------------------------------------------- /src/styles/index.scss: -------------------------------------------------------------------------------- 1 | @import './variables.scss'; 2 | @import './mixin.scss'; 3 | @import './transition.scss'; 4 | @import './element-ui.scss'; 5 | @import './sidebar.scss'; 6 | 7 | body { 8 | height: 100%; 9 | -moz-osx-font-smoothing: grayscale; 10 | -webkit-font-smoothing: antialiased; 11 | text-rendering: optimizeLegibility; 12 | font-family: Helvetica Neue, Helvetica, PingFang SC, Hiragino Sans GB, Microsoft YaHei, Arial, sans-serif; 13 | } 14 | 15 | label { 16 | font-weight: 700; 17 | } 18 | 19 | html { 20 | height: 100%; 21 | box-sizing: border-box; 22 | } 23 | 24 | #app { 25 | height: 100%; 26 | } 27 | 28 | *, 29 | *:before, 30 | *:after { 31 | box-sizing: inherit; 32 | } 33 | 34 | a:focus, 35 | a:active { 36 | outline: none; 37 | } 38 | 39 | a, 40 | a:focus, 41 | a:hover { 42 | cursor: pointer; 43 | color: inherit; 44 | text-decoration: none; 45 | } 46 | 47 | div:focus { 48 | outline: none; 49 | } 50 | 51 | .clearfix { 52 | &:after { 53 | visibility: hidden; 54 | display: block; 55 | font-size: 0; 56 | content: " "; 57 | clear: both; 58 | height: 0; 59 | } 60 | } 61 | 62 | // main-container global css 63 | .app-container { 64 | padding: 20px; 65 | } 66 | -------------------------------------------------------------------------------- /src/icons/svg/eye-open.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/store/modules/app.js: -------------------------------------------------------------------------------- 1 | import Cookies from 'js-cookie' 2 | 3 | const state = { 4 | sidebar: { 5 | opened: Cookies.get('sidebarStatus') ? !!+Cookies.get('sidebarStatus') : true, 6 | withoutAnimation: false 7 | }, 8 | device: 'desktop' 9 | } 10 | 11 | const mutations = { 12 | TOGGLE_SIDEBAR: state => { 13 | state.sidebar.opened = !state.sidebar.opened 14 | state.sidebar.withoutAnimation = false 15 | if (state.sidebar.opened) { 16 | Cookies.set('sidebarStatus', 1) 17 | } else { 18 | Cookies.set('sidebarStatus', 0) 19 | } 20 | }, 21 | CLOSE_SIDEBAR: (state, withoutAnimation) => { 22 | Cookies.set('sidebarStatus', 0) 23 | state.sidebar.opened = false 24 | state.sidebar.withoutAnimation = withoutAnimation 25 | }, 26 | TOGGLE_DEVICE: (state, device) => { 27 | state.device = device 28 | } 29 | } 30 | 31 | const actions = { 32 | toggleSideBar({ commit }) { 33 | commit('TOGGLE_SIDEBAR') 34 | }, 35 | closeSideBar({ commit }, { withoutAnimation }) { 36 | commit('CLOSE_SIDEBAR', withoutAnimation) 37 | }, 38 | toggleDevice({ commit }, device) { 39 | commit('TOGGLE_DEVICE', device) 40 | } 41 | } 42 | 43 | export default { 44 | namespaced: true, 45 | state, 46 | mutations, 47 | actions 48 | } 49 | -------------------------------------------------------------------------------- /tests/unit/utils/parseTime.spec.js: -------------------------------------------------------------------------------- 1 | import { parseTime } from '@/utils/index.js' 2 | 3 | describe('Utils:parseTime', () => { 4 | const d = new Date('2018-07-13 17:54:01') // "2018-07-13 17:54:01" 5 | it('timestamp', () => { 6 | expect(parseTime(d)).toBe('2018-07-13 17:54:01') 7 | }) 8 | it('timestamp string', () => { 9 | expect(parseTime((d + ''))).toBe('2018-07-13 17:54:01') 10 | }) 11 | it('ten digits timestamp', () => { 12 | expect(parseTime((d / 1000).toFixed(0))).toBe('2018-07-13 17:54:01') 13 | }) 14 | it('new Date', () => { 15 | expect(parseTime(new Date(d))).toBe('2018-07-13 17:54:01') 16 | }) 17 | it('format', () => { 18 | expect(parseTime(d, '{y}-{m}-{d} {h}:{i}')).toBe('2018-07-13 17:54') 19 | expect(parseTime(d, '{y}-{m}-{d}')).toBe('2018-07-13') 20 | expect(parseTime(d, '{y}/{m}/{d} {h}-{i}')).toBe('2018/07/13 17-54') 21 | }) 22 | it('get the day of the week', () => { 23 | expect(parseTime(d, '{a}')).toBe('五') // 星期五 24 | }) 25 | it('get the day of the week', () => { 26 | expect(parseTime(+d + 1000 * 60 * 60 * 24 * 2, '{a}')).toBe('日') // 星期日 27 | }) 28 | it('empty argument', () => { 29 | expect(parseTime()).toBeNull() 30 | }) 31 | 32 | it('null', () => { 33 | expect(parseTime(null)).toBeNull() 34 | }) 35 | }) 36 | -------------------------------------------------------------------------------- /src/main.js: -------------------------------------------------------------------------------- 1 | import { createApp } from 'vue' 2 | 3 | import 'normalize.css/normalize.css' // A modern alternative to CSS resets 4 | 5 | import "element3/lib/theme-chalk/index.css" 6 | import Element3 from 'element3' 7 | 8 | // import ElementUI from 'element-ui' 9 | // import 'element-ui/lib/theme-chalk/index.css' 10 | // import locale from 'element-ui/lib/locale/lang/en' // lang i18n 11 | 12 | import '@/styles/index.scss' // global css 13 | 14 | import App from './App' 15 | import store from './store' 16 | import router from './router' 17 | 18 | import { useIcons } from '@/icons' // icon 19 | import '@/permission' // permission control 20 | 21 | /** 22 | * If you don't want to use mock-server 23 | * you want to use MockJs for mock api 24 | * you can execute: mockXHR() 25 | * 26 | * Currently MockJs will be used in the production environment, 27 | * please remove it before going online ! ! ! 28 | */ 29 | // if (process.env.NODE_ENV === "production") { 30 | // const { mockXHR } = require("../mock"); 31 | // mockXHR(); 32 | // } 33 | 34 | // set ElementUI lang to EN 35 | // Vue.use(ElementUI, { locale }) 36 | // 如果想要中文版 element-ui，按如下方式声明 37 | // Vue.use(ElementUI) 38 | 39 | const app = createApp(App) 40 | .use(router) 41 | .use(store) 42 | .use(Element3) 43 | useIcons(app) 44 | app.mount('#app') 45 | -------------------------------------------------------------------------------- /src/components/Hamburger/index.vue: -------------------------------------------------------------------------------- 1 | 17 | 18 | 34 | 35 | 47 | -------------------------------------------------------------------------------- /src/layout/mixin/ResizeHandler.js: -------------------------------------------------------------------------------- 1 | import store from '@/store' 2 | 3 | const { body } = document 4 | const WIDTH = 992 // refer to Bootstrap's responsive design 5 | 6 | export default { 7 | watch: { 8 | $route(route) { 9 | if (this.device === 'mobile' && this.sidebar.opened) { 10 | store.dispatch('app/closeSideBar', { withoutAnimation: false }) 11 | } 12 | } 13 | }, 14 | beforeMount() { 15 | window.addEventListener('resize', this.$_resizeHandler) 16 | }, 17 | beforeUnmount() { 18 | window.removeEventListener('resize', this.$_resizeHandler) 19 | }, 20 | mounted() { 21 | const isMobile = this.$_isMobile() 22 | if (isMobile) { 23 | store.dispatch('app/toggleDevice', 'mobile') 24 | store.dispatch('app/closeSideBar', { withoutAnimation: true }) 25 | } 26 | }, 27 | methods: { 28 | // use $_ for mixins properties 29 | // https://vuejs.org/v2/style-guide/index.html#Private-property-names-essential 30 | $_isMobile() { 31 | const rect = body.getBoundingClientRect() 32 | return rect.width - 1 < WIDTH 33 | }, 34 | $_resizeHandler() { 35 | if (!document.hidden) { 36 | const isMobile = this.$_isMobile() 37 | store.dispatch('app/toggleDevice', isMobile ? 'mobile' : 'desktop') 38 | 39 | if (isMobile) { 40 | store.dispatch('app/closeSideBar', { withoutAnimation: true }) 41 | } 42 | } 43 | } 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /src/components/SvgIcon/index.vue: -------------------------------------------------------------------------------- 1 | 7 | 8 | 47 | 48 | 63 | -------------------------------------------------------------------------------- /mock/index.js: -------------------------------------------------------------------------------- 1 | const Mock = require('mockjs') 2 | const { param2Obj } = require('./utils') 3 | 4 | const user = require('./user') 5 | const table = require('./table') 6 | 7 | const mocks = [ 8 | ...user, 9 | ...table 10 | ] 11 | 12 | // for front mock 13 | // please use it cautiously, it will redefine XMLHttpRequest, 14 | // which will cause many of your third-party libraries to be invalidated(like progress event). 15 | function mockXHR() { 16 | // mock patch 17 | // https://github.com/nuysoft/Mock/issues/300 18 | Mock.XHR.prototype.proxy_send = Mock.XHR.prototype.send 19 | Mock.XHR.prototype.send = function() { 20 | if (this.custom.xhr) { 21 | this.custom.xhr.withCredentials = this.withCredentials || false 22 | 23 | if (this.responseType) { 24 | this.custom.xhr.responseType = this.responseType 25 | } 26 | } 27 | this.proxy_send(...arguments) 28 | } 29 | 30 | function XHR2ExpressReqWrap(respond) { 31 | return function(options) { 32 | let result = null 33 | if (respond instanceof Function) { 34 | const { body, type, url } = options 35 | // https://expressjs.com/en/4x/api.html#req 36 | result = respond({ 37 | method: type, 38 | body: JSON.parse(body), 39 | query: param2Obj(url) 40 | }) 41 | } else { 42 | result = respond 43 | } 44 | return Mock.mock(result) 45 | } 46 | } 47 | 48 | for (const i of mocks) { 49 | Mock.mock(new RegExp(i.url), i.type || 'get', XHR2ExpressReqWrap(i.response)) 50 | } 51 | } 52 | 53 | module.exports = { 54 | mocks, 55 | mockXHR 56 | } 57 | 58 | -------------------------------------------------------------------------------- /src/layout/components/Sidebar/index.vue: -------------------------------------------------------------------------------- 1 | 25 | 26 | 60 | -------------------------------------------------------------------------------- /src/icons/svg/tree.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /mock/user.js: -------------------------------------------------------------------------------- 1 | 2 | const tokens = { 3 | admin: { 4 | token: 'admin-token' 5 | }, 6 | editor: { 7 | token: 'editor-token' 8 | } 9 | } 10 | 11 | const users = { 12 | 'admin-token': { 13 | roles: ['admin'], 14 | introduction: 'I am a super administrator', 15 | avatar: 'https://wpimg.wallstcn.com/f778738c-e4f8-4870-b634-56703b4acafe.gif', 16 | name: 'Super Admin' 17 | }, 18 | 'editor-token': { 19 | roles: ['editor'], 20 | introduction: 'I am an editor', 21 | avatar: 'https://wpimg.wallstcn.com/f778738c-e4f8-4870-b634-56703b4acafe.gif', 22 | name: 'Normal Editor' 23 | } 24 | } 25 | 26 | module.exports = [ 27 | // user login 28 | { 29 | url: '/vue-admin-template/user/login', 30 | type: 'post', 31 | response: config => { 32 | const { username } = config.body 33 | const token = tokens[username] 34 | 35 | // mock error 36 | if (!token) { 37 | return { 38 | code: 60204, 39 | message: 'Account and password are incorrect.' 40 | } 41 | } 42 | 43 | return { 44 | code: 20000, 45 | data: token 46 | } 47 | } 48 | }, 49 | 50 | // get user info 51 | { 52 | url: '/vue-admin-template/user/info\.*', 53 | type: 'get', 54 | response: config => { 55 | const { token } = config.query 56 | const info = users[token] 57 | 58 | // mock error 59 | if (!info) { 60 | return { 61 | code: 50008, 62 | message: 'Login failed, unable to get user details.' 63 | } 64 | } 65 | 66 | return { 67 | code: 20000, 68 | data: info 69 | } 70 | } 71 | }, 72 | 73 | // user logout 74 | { 75 | url: '/vue-admin-template/user/logout', 76 | type: 'post', 77 | response: _ => { 78 | return { 79 | code: 20000, 80 | data: 'success' 81 | } 82 | } 83 | } 84 | ] 85 | -------------------------------------------------------------------------------- /src/permission.js: -------------------------------------------------------------------------------- 1 | import router from './router' 2 | import store from './store' 3 | import { useMessage } from 'element3' 4 | import NProgress from 'nprogress' // progress bar 5 | import 'nprogress/nprogress.css' // progress bar style 6 | import { getToken } from '@/utils/auth' // get token from cookie 7 | import getPageTitle from '@/utils/get-page-title' 8 | 9 | NProgress.configure({ showSpinner: false }) // NProgress Configuration 10 | 11 | const whiteList = ['/login'] // no redirect whitelist 12 | 13 | router.beforeEach(async(to, from, next) => { 14 | // start progress bar 15 | NProgress.start() 16 | 17 | // set page title 18 | document.title = getPageTitle(to.meta.title) 19 | 20 | // determine whether the user has logged in 21 | const hasToken = getToken() 22 | 23 | if (hasToken) { 24 | if (to.path === '/login') { 25 | // if is logged in, redirect to the home page 26 | next({ path: '/' }) 27 | NProgress.done() 28 | } else { 29 | const hasGetUserInfo = store.getters.name 30 | if (hasGetUserInfo) { 31 | next() 32 | } else { 33 | try { 34 | // get user info 35 | await store.dispatch('user/getInfo') 36 | 37 | next() 38 | } catch (error) { 39 | const Message = useMessage() 40 | // remove token and go to login page to re-login 41 | await store.dispatch('user/resetToken') 42 | Message.error(error || 'Has Error') 43 | next(`/login?redirect=${to.path}`) 44 | NProgress.done() 45 | } 46 | } 47 | } 48 | } else { 49 | /* has no token*/ 50 | 51 | if (whiteList.indexOf(to.path) !== -1) { 52 | // in the free login whitelist, go directly 53 | next() 54 | } else { 55 | // other pages that do not have permission to access are redirected to the login page. 56 | next(`/login?redirect=${to.path}`) 57 | NProgress.done() 58 | } 59 | } 60 | }) 61 | 62 | router.afterEach(() => { 63 | // finish progress bar 64 | NProgress.done() 65 | }) 66 | -------------------------------------------------------------------------------- /src/layout/components/Sidebar/Logo.vue: -------------------------------------------------------------------------------- 1 | 15 | 16 | 33 | 34 | 83 | -------------------------------------------------------------------------------- /README-zh.md: -------------------------------------------------------------------------------- 1 | # vue-admin-template 2 | 3 | > 这是一个极简的 element3 admin 管理后台模板。它只包含了 Element3 UI 4 | 5 | 目前版本为 `v4.0+` 基于 `vue-cli` 进行构建 6 | 7 | 8 | ## 相关项目 9 | 10 | - [element3-admin-template](https://github.com/hug-sun/element3-admin-template) 11 | 12 | - [element3-admin-ts-template](https://github.com/hug-sun/element3-admin-ts-template) 13 | 14 | - [element3-admin](https://github.com/hug-sun/element3-admin) 15 | 16 | ## Build Setup 17 | 18 | ```bash 19 | # 克隆项目 20 | git clone https://github.com/hug-sun/element3-admin-template.git 21 | 22 | # 进入项目目录 23 | cd element3-admin-template 24 | 25 | # 安装依赖 26 | npm install 27 | 28 | # 建议不要直接使用 cnpm 安装以来，会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题 29 | npm install --registry=https://registry.npm.taobao.org 30 | 31 | # 启动服务 32 | npm run dev 33 | ``` 34 | 35 | 浏览器访问 [http://localhost:9528](http://localhost:9528) 36 | 37 | ## 发布 38 | 39 | ```bash 40 | # 构建测试环境 41 | npm run build:stage 42 | 43 | # 构建生产环境 44 | npm run build:prod 45 | ``` 46 | 47 | ## 其它 48 | 49 | ```bash 50 | # 预览发布环境效果 51 | npm run preview 52 | 53 | # 预览发布环境效果 + 静态资源分析 54 | npm run preview -- --report 55 | 56 | # 代码格式检查 57 | npm run lint 58 | 59 | # 代码格式检查并自动修复 60 | npm run lint -- --fix 61 | ``` 62 | 63 | ## Browsers support 64 | 65 | Modern browsers and Internet Explorer 10+. 66 | 67 | | [IE / Edge](http://godban.github.io/browsers-support-badges/)
IE / Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | 68 | | --------- | --------- | --------- | --------- | 69 | | IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions 70 | 71 | 72 | -------------------------------------------------------------------------------- /src/icons/svg/dashboard.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/views/tree/index.vue: -------------------------------------------------------------------------------- 1 | 19 | 20 | 97 | -------------------------------------------------------------------------------- /src/layout/index.vue: -------------------------------------------------------------------------------- 1 | 13 | 14 | 52 | 53 | 94 | -------------------------------------------------------------------------------- /src/views/table/index.vue: -------------------------------------------------------------------------------- 1 | 44 | 45 | 77 | -------------------------------------------------------------------------------- /src/components/Breadcrumb/index.vue: -------------------------------------------------------------------------------- 1 | 11 | 12 | 65 | 66 | 79 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "element3-admin-template", 3 | "version": "0.1.0", 4 | "scripts": { 5 | "dev": "vue-cli-service serve", 6 | "build:prod": "vue-cli-service build", 7 | "build:stage": "vue-cli-service build --mode staging", 8 | "preview": "node build/index.js --preview", 9 | "svgo": "svgo -f src/icons/svg --config=src/icons/svgo.yml", 10 | "lint": "eslint --fix --ext .js,.vue src", 11 | "test:unit": "jest --clearCache && vue-cli-service test:unit", 12 | "test:ci": "npm run lint && npm run test:unit" 13 | }, 14 | "dependencies": { 15 | "axios": "0.18.1", 16 | "core-js": "3.6.5", 17 | "element3": "0.0.25", 18 | "js-cookie": "2.2.0", 19 | "normalize.css": "7.0.0", 20 | "nprogress": "0.2.0", 21 | "path-to-regexp": "2.4.0", 22 | "vue": "^3.0.2", 23 | "vue-router": "^4.0.0-rc.1", 24 | "vuex": "^4.0.0-rc.1" 25 | }, 26 | "devDependencies": { 27 | "@vue/cli-plugin-babel": "~4.5.0", 28 | "@vue/cli-plugin-eslint": "~4.5.0", 29 | "@vue/cli-plugin-router": "~4.5.0", 30 | "@vue/cli-plugin-unit-jest": "~4.5.0", 31 | "@vue/cli-plugin-vuex": "~4.5.0", 32 | "@vue/cli-service": "~4.5.0", 33 | "@vue/compiler-sfc": "^3.0.0", 34 | "@vue/test-utils": "^2.0.0-0", 35 | "autoprefixer": "9.5.1", 36 | "babel-eslint": "10.1.0", 37 | "babel-jest": "23.6.0", 38 | "babel-plugin-dynamic-import-node": "2.3.3", 39 | "chalk": "2.4.2", 40 | "connect": "3.6.6", 41 | "eslint": "6.7.2", 42 | "eslint-plugin-vue": "^7.0.0-0", 43 | "html-webpack-plugin": "3.2.0", 44 | "mockjs": "1.0.1-beta3", 45 | "runjs": "4.3.2", 46 | "sass": "1.26.8", 47 | "sass-loader": "8.0.2", 48 | "script-ext-html-webpack-plugin": "2.1.3", 49 | "serve-static": "1.13.2", 50 | "svg-sprite-loader": "4.1.3", 51 | "svgo": "1.2.2", 52 | "vue-jest": "^5.0.0-0" 53 | }, 54 | "eslintConfig": { 55 | "root": true, 56 | "env": { 57 | "node": true 58 | }, 59 | "extends": [ 60 | "plugin:vue/vue3-essential", 61 | "eslint:recommended" 62 | ], 63 | "parserOptions": { 64 | "parser": "babel-eslint" 65 | }, 66 | "rules": {} 67 | }, 68 | "browserslist": [ 69 | "> 1%", 70 | "last 2 versions" 71 | ], 72 | "engines": { 73 | "node": ">=8.9", 74 | "npm": ">= 3.0.0" 75 | }, 76 | "license": "MIT" 77 | } 78 | -------------------------------------------------------------------------------- /src/icons/svg/form.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # vue-admin-template 2 | 3 | English | [简体中文](./README-zh.md) 4 | 5 | > A minimal vue admin template with Element3 UI 6 | 7 | 8 | ## Build Setup 9 | 10 | ```bash 11 | # clone the project 12 | git clone https://github.com/hug-sun/element3-admin-template.git 13 | 14 | # enter the project directory 15 | cd element3-admin-template 16 | 17 | # install dependency 18 | npm install 19 | 20 | # develop 21 | npm run dev 22 | ``` 23 | 24 | This will automatically open http://localhost:9528 25 | 26 | ## Build 27 | 28 | ```bash 29 | # build for test environment 30 | npm run build:stage 31 | 32 | # build for production environment 33 | npm run build:prod 34 | ``` 35 | 36 | ## Advanced 37 | 38 | ```bash 39 | # preview the release environment effect 40 | npm run preview 41 | 42 | # preview the release environment effect + static resource analysis 43 | npm run preview -- --report 44 | 45 | # code format check 46 | npm run lint 47 | 48 | # code format check and auto fix 49 | npm run lint -- --fix 50 | ``` 51 | 52 | ## Extra 53 | 54 | For `typescript` version, you can use [element3-admin-ts-template](https://github.com/hug-sun/element3-admin-ts-template) 55 | 56 | ## Related Project 57 | 58 | - [element3-admin-template](https://github.com/hug-sun/element3-admin-template) 59 | 60 | - [element3-admin-ts-template](https://github.com/hug-sun/element3-admin-ts-template) 61 | 62 | - [element3-admin](https://github.com/hug-sun/element3-admin) 63 | 64 | ## Browsers support 65 | 66 | Modern browsers and Internet Explorer 10+. 67 | 68 | | [IE / Edge](http://godban.github.io/browsers-support-badges/)
IE / Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | 69 | | --------- | --------- | --------- | --------- | 70 | | IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions 71 | 72 | 73 | -------------------------------------------------------------------------------- /src/store/modules/user.js: -------------------------------------------------------------------------------- 1 | import { login, logout, getInfo } from '@/api/user' 2 | import { getToken, setToken, removeToken } from '@/utils/auth' 3 | import { resetRouter } from '@/router' 4 | 5 | const getDefaultState = () => { 6 | return { 7 | token: getToken(), 8 | name: '', 9 | avatar: '' 10 | } 11 | } 12 | 13 | const state = getDefaultState() 14 | 15 | const mutations = { 16 | RESET_STATE: (state) => { 17 | Object.assign(state, getDefaultState()) 18 | }, 19 | SET_TOKEN: (state, token) => { 20 | state.token = token 21 | }, 22 | SET_NAME: (state, name) => { 23 | state.name = name 24 | }, 25 | SET_AVATAR: (state, avatar) => { 26 | state.avatar = avatar 27 | } 28 | } 29 | 30 | const actions = { 31 | // user login 32 | login({ commit }, userInfo) { 33 | const { username, password } = userInfo 34 | return new Promise((resolve, reject) => { 35 | login({ username: username.trim(), password: password }).then(response => { 36 | const { data } = response 37 | commit('SET_TOKEN', data.token) 38 | setToken(data.token) 39 | resolve() 40 | }).catch(error => { 41 | reject(error) 42 | }) 43 | }) 44 | }, 45 | 46 | // get user info 47 | getInfo({ commit, state }) { 48 | return new Promise((resolve, reject) => { 49 | getInfo(state.token).then(response => { 50 | const { data } = response 51 | 52 | if (!data) { 53 | return reject('Verification failed, please Login again.') 54 | } 55 | 56 | const { name, avatar } = data 57 | 58 | commit('SET_NAME', name) 59 | commit('SET_AVATAR', avatar) 60 | resolve(data) 61 | }).catch(error => { 62 | reject(error) 63 | }) 64 | }) 65 | }, 66 | 67 | // user logout 68 | logout({ commit, state }) { 69 | return new Promise((resolve, reject) => { 70 | logout(state.token).then(() => { 71 | removeToken() // must remove token first 72 | resetRouter() 73 | commit('RESET_STATE') 74 | resolve() 75 | }).catch(error => { 76 | reject(error) 77 | }) 78 | }) 79 | }, 80 | 81 | // remove token 82 | resetToken({ commit }) { 83 | return new Promise(resolve => { 84 | removeToken() // must remove token first 85 | commit('RESET_STATE') 86 | resolve() 87 | }) 88 | } 89 | } 90 | 91 | export default { 92 | namespaced: true, 93 | state, 94 | mutations, 95 | actions 96 | } 97 | 98 | -------------------------------------------------------------------------------- /mock/mock-server.js: -------------------------------------------------------------------------------- 1 | const chokidar = require('chokidar') 2 | const bodyParser = require('body-parser') 3 | const chalk = require('chalk') 4 | const path = require('path') 5 | const Mock = require('mockjs') 6 | 7 | const mockDir = path.join(process.cwd(), 'mock') 8 | 9 | function registerRoutes(app) { 10 | let mockLastIndex 11 | const { mocks } = require('./index.js') 12 | const mocksForServer = mocks.map(route => { 13 | return responseFake(route.url, route.type, route.response) 14 | }) 15 | for (const mock of mocksForServer) { 16 | app[mock.type](mock.url, mock.response) 17 | mockLastIndex = app._router.stack.length 18 | } 19 | const mockRoutesLength = Object.keys(mocksForServer).length 20 | return { 21 | mockRoutesLength: mockRoutesLength, 22 | mockStartIndex: mockLastIndex - mockRoutesLength 23 | } 24 | } 25 | 26 | function unregisterRoutes() { 27 | Object.keys(require.cache).forEach(i => { 28 | if (i.includes(mockDir)) { 29 | delete require.cache[require.resolve(i)] 30 | } 31 | }) 32 | } 33 | 34 | // for mock server 35 | const responseFake = (url, type, respond) => { 36 | return { 37 | url: new RegExp(`${process.env.VUE_APP_BASE_API}${url}`), 38 | type: type || 'get', 39 | response(req, res) { 40 | console.log('request invoke:' + req.path) 41 | res.json(Mock.mock(respond instanceof Function ? respond(req, res) : respond)) 42 | } 43 | } 44 | } 45 | 46 | module.exports = app => { 47 | // parse app.body 48 | // https://expressjs.com/en/4x/api.html#req.body 49 | app.use(bodyParser.json()) 50 | app.use(bodyParser.urlencoded({ 51 | extended: true 52 | })) 53 | 54 | const mockRoutes = registerRoutes(app) 55 | var mockRoutesLength = mockRoutes.mockRoutesLength 56 | var mockStartIndex = mockRoutes.mockStartIndex 57 | 58 | // watch files, hot reload mock server 59 | chokidar.watch(mockDir, { 60 | ignored: /mock-server/, 61 | ignoreInitial: true 62 | }).on('all', (event, path) => { 63 | if (event === 'change' || event === 'add') { 64 | try { 65 | // remove mock routes stack 66 | app._router.stack.splice(mockStartIndex, mockRoutesLength) 67 | 68 | // clear routes cache 69 | unregisterRoutes() 70 | 71 | const mockRoutes = registerRoutes(app) 72 | mockRoutesLength = mockRoutes.mockRoutesLength 73 | mockStartIndex = mockRoutes.mockStartIndex 74 | 75 | console.log(chalk.magentaBright(`\n > Mock Server hot reload success! changed ${path}`)) 76 | } catch (error) { 77 | console.log(chalk.redBright(error)) 78 | } 79 | } 80 | }) 81 | } 82 | -------------------------------------------------------------------------------- /src/utils/request.js: -------------------------------------------------------------------------------- 1 | import axios from 'axios' 2 | import { useMsgbox, useMessage } from 'element3' 3 | import store from '@/store' 4 | import { getToken } from '@/utils/auth' 5 | 6 | const Message = useMessage() 7 | const Msgbox = useMsgbox() 8 | // create an axios instance 9 | const service = axios.create({ 10 | baseURL: process.env.VUE_APP_BASE_API, // url = base url + request url 11 | // withCredentials: true, // send cookies when cross-domain requests 12 | timeout: 5000 // request timeout 13 | }) 14 | 15 | // request interceptor 16 | service.interceptors.request.use( 17 | config => { 18 | // do something before request is sent 19 | 20 | if (store.getters.token) { 21 | // let each request carry token 22 | // ['X-Token'] is a custom headers key 23 | // please modify it according to the actual situation 24 | config.headers['X-Token'] = getToken() 25 | } 26 | return config 27 | }, 28 | error => { 29 | // do something with request error 30 | console.log(error) // for debug 31 | return Promise.reject(error) 32 | } 33 | ) 34 | 35 | // response interceptor 36 | service.interceptors.response.use( 37 | /** 38 | * If you want to get http information such as headers or status 39 | * Please return response => response 40 | */ 41 | 42 | /** 43 | * Determine the request status by custom code 44 | * Here is just an example 45 | * You can also judge the status by HTTP Status Code 46 | */ 47 | response => { 48 | const res = response.data 49 | 50 | // if the custom code is not 20000, it is judged as an error. 51 | if (res.code !== 20000) { 52 | Message({ 53 | message: res.message || 'Error', 54 | type: 'error', 55 | duration: 5 * 1000 56 | }) 57 | 58 | // 50008: Illegal token; 50012: Other clients logged in; 50014: Token expired; 59 | if (res.code === 50008 || res.code === 50012 || res.code === 50014) { 60 | // to re-login 61 | Msgbox.confirm('You have been logged out, you can cancel to stay on this page, or log in again', 'Confirm logout', { 62 | confirmButtonText: 'Re-Login', 63 | cancelButtonText: 'Cancel', 64 | type: 'warning' 65 | }).then(() => { 66 | store.dispatch('user/resetToken').then(() => { 67 | location.reload() 68 | }) 69 | }) 70 | } 71 | return Promise.reject(new Error(res.message || 'Error')) 72 | } else { 73 | return res 74 | } 75 | }, 76 | error => { 77 | console.log('err' + error) // for debug 78 | Message({ 79 | message: error.message, 80 | type: 'error', 81 | duration: 5 * 1000 82 | }) 83 | return Promise.reject(error) 84 | } 85 | ) 86 | 87 | export default service 88 | -------------------------------------------------------------------------------- /src/layout/components/Sidebar/SidebarItem.vue: -------------------------------------------------------------------------------- 1 | 26 | 27 | -------------------------------------------------------------------------------- /src/views/form/index.vue: -------------------------------------------------------------------------------- 1 | 59 | 60 | 91 | 92 | 97 | -------------------------------------------------------------------------------- /tests/unit/components/Breadcrumb.spec.js: -------------------------------------------------------------------------------- 1 | import { mount, createLocalVue } from '@vue/test-utils' 2 | import VueRouter from 'vue-router' 3 | import ElementUI from 'element-ui' 4 | import Breadcrumb from '@/components/Breadcrumb/index.vue' 5 | 6 | const localVue = createLocalVue() 7 | localVue.use(VueRouter) 8 | localVue.use(ElementUI) 9 | 10 | const routes = [ 11 | { 12 | path: '/', 13 | name: 'home', 14 | children: [{ 15 | path: 'dashboard', 16 | name: 'dashboard' 17 | }] 18 | }, 19 | { 20 | path: '/menu', 21 | name: 'menu', 22 | children: [{ 23 | path: 'menu1', 24 | name: 'menu1', 25 | meta: { title: 'menu1' }, 26 | children: [{ 27 | path: 'menu1-1', 28 | name: 'menu1-1', 29 | meta: { title: 'menu1-1' } 30 | }, 31 | { 32 | path: 'menu1-2', 33 | name: 'menu1-2', 34 | redirect: 'noredirect', 35 | meta: { title: 'menu1-2' }, 36 | children: [{ 37 | path: 'menu1-2-1', 38 | name: 'menu1-2-1', 39 | meta: { title: 'menu1-2-1' } 40 | }, 41 | { 42 | path: 'menu1-2-2', 43 | name: 'menu1-2-2' 44 | }] 45 | }] 46 | }] 47 | }] 48 | 49 | const router = new VueRouter({ 50 | routes 51 | }) 52 | 53 | describe('Breadcrumb.vue', () => { 54 | const wrapper = mount(Breadcrumb, { 55 | localVue, 56 | router 57 | }) 58 | it('dashboard', () => { 59 | router.push('/dashboard') 60 | const len = wrapper.findAll('.el-breadcrumb__inner').length 61 | expect(len).toBe(1) 62 | }) 63 | it('normal route', () => { 64 | router.push('/menu/menu1') 65 | const len = wrapper.findAll('.el-breadcrumb__inner').length 66 | expect(len).toBe(2) 67 | }) 68 | it('nested route', () => { 69 | router.push('/menu/menu1/menu1-2/menu1-2-1') 70 | const len = wrapper.findAll('.el-breadcrumb__inner').length 71 | expect(len).toBe(4) 72 | }) 73 | it('no meta.title', () => { 74 | router.push('/menu/menu1/menu1-2/menu1-2-2') 75 | const len = wrapper.findAll('.el-breadcrumb__inner').length 76 | expect(len).toBe(3) 77 | }) 78 | // it('click link', () => { 79 | // router.push('/menu/menu1/menu1-2/menu1-2-2') 80 | // const breadcrumbArray = wrapper.findAll('.el-breadcrumb__inner') 81 | // const second = breadcrumbArray.at(1) 82 | // console.log(breadcrumbArray) 83 | // const href = second.find('a').attributes().href 84 | // expect(href).toBe('#/menu/menu1') 85 | // }) 86 | // it('noRedirect', () => { 87 | // router.push('/menu/menu1/menu1-2/menu1-2-1') 88 | // const breadcrumbArray = wrapper.findAll('.el-breadcrumb__inner') 89 | // const redirectBreadcrumb = breadcrumbArray.at(2) 90 | // expect(redirectBreadcrumb.contains('a')).toBe(false) 91 | // }) 92 | it('last breadcrumb', () => { 93 | router.push('/menu/menu1/menu1-2/menu1-2-1') 94 | const breadcrumbArray = wrapper.findAll('.el-breadcrumb__inner') 95 | const redirectBreadcrumb = breadcrumbArray.at(3) 96 | expect(redirectBreadcrumb.contains('a')).toBe(false) 97 | }) 98 | }) 99 | -------------------------------------------------------------------------------- /src/utils/index.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Created by PanJiaChen on 16/11/18. 3 | */ 4 | 5 | /** 6 | * Parse the time to string 7 | * @param {(Object|string|number)} time 8 | * @param {string} cFormat 9 | * @returns {string | null} 10 | */ 11 | export function parseTime(time, cFormat) { 12 | if (arguments.length === 0 || !time) { 13 | return null 14 | } 15 | const format = cFormat || '{y}-{m}-{d} {h}:{i}:{s}' 16 | let date 17 | if (typeof time === 'object') { 18 | date = time 19 | } else { 20 | if ((typeof time === 'string')) { 21 | if ((/^[0-9]+$/.test(time))) { 22 | // support "1548221490638" 23 | time = parseInt(time) 24 | } else { 25 | // support safari 26 | // https://stackoverflow.com/questions/4310953/invalid-date-in-safari 27 | time = time.replace(new RegExp(/-/gm), '/') 28 | } 29 | } 30 | 31 | if ((typeof time === 'number') && (time.toString().length === 10)) { 32 | time = time * 1000 33 | } 34 | date = new Date(time) 35 | } 36 | const formatObj = { 37 | y: date.getFullYear(), 38 | m: date.getMonth() + 1, 39 | d: date.getDate(), 40 | h: date.getHours(), 41 | i: date.getMinutes(), 42 | s: date.getSeconds(), 43 | a: date.getDay() 44 | } 45 | const time_str = format.replace(/{([ymdhisa])+}/g, (result, key) => { 46 | const value = formatObj[key] 47 | // Note: getDay() returns 0 on Sunday 48 | if (key === 'a') { return ['日', '一', '二', '三', '四', '五', '六'][value ] } 49 | return value.toString().padStart(2, '0') 50 | }) 51 | return time_str 52 | } 53 | 54 | /** 55 | * @param {number} time 56 | * @param {string} option 57 | * @returns {string} 58 | */ 59 | export function formatTime(time, option) { 60 | if (('' + time).length === 10) { 61 | time = parseInt(time) * 1000 62 | } else { 63 | time = +time 64 | } 65 | const d = new Date(time) 66 | const now = Date.now() 67 | 68 | const diff = (now - d) / 1000 69 | 70 | if (diff < 30) { 71 | return '刚刚' 72 | } else if (diff < 3600) { 73 | // less 1 hour 74 | return Math.ceil(diff / 60) + '分钟前' 75 | } else if (diff < 3600 * 24) { 76 | return Math.ceil(diff / 3600) + '小时前' 77 | } else if (diff < 3600 * 24 * 2) { 78 | return '1天前' 79 | } 80 | if (option) { 81 | return parseTime(time, option) 82 | } else { 83 | return ( 84 | d.getMonth() + 85 | 1 + 86 | '月' + 87 | d.getDate() + 88 | '日' + 89 | d.getHours() + 90 | '时' + 91 | d.getMinutes() + 92 | '分' 93 | ) 94 | } 95 | } 96 | 97 | /** 98 | * @param {string} url 99 | * @returns {Object} 100 | */ 101 | export function param2Obj(url) { 102 | const search = decodeURIComponent(url.split('?')[1]).replace(/\+/g, ' ') 103 | if (!search) { 104 | return {} 105 | } 106 | const obj = {} 107 | const searchArr = search.split('&') 108 | searchArr.forEach(v => { 109 | const index = v.indexOf('=') 110 | if (index !== -1) { 111 | const name = v.substring(0, index) 112 | const val = v.substring(index + 1, v.length) 113 | obj[name] = val 114 | } 115 | }) 116 | return obj 117 | } 118 | -------------------------------------------------------------------------------- /src/layout/components/Navbar.vue: -------------------------------------------------------------------------------- 1 | 33 | 34 | 61 | 62 | 140 | -------------------------------------------------------------------------------- /vue.config.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const path = require('path') 3 | const defaultSettings = require('./src/settings.js') 4 | 5 | function resolve(dir) { 6 | return path.join(__dirname, dir) 7 | } 8 | 9 | const name = defaultSettings.title || 'vue Admin Template' // page title 10 | 11 | // If your port is set to 80, 12 | // use administrator privileges to execute the command line. 13 | // For example, Mac: sudo npm run 14 | // You can change the port by the following methods: 15 | // port = 9528 npm run dev OR npm run dev --port = 9528 16 | const port = process.env.port || process.env.npm_config_port || 9528 // dev port 17 | 18 | // All configuration item explanations can be find in https://cli.vuejs.org/config/ 19 | module.exports = { 20 | /** 21 | * You will need to set publicPath if you plan to deploy your site under a sub path, 22 | * for example GitHub Pages. If you plan to deploy your site to https://foo.github.io/bar/, 23 | * then publicPath should be set to "/bar/". 24 | * In most cases please use '/' !!! 25 | * Detail: https://cli.vuejs.org/config/#publicpath 26 | */ 27 | publicPath: '/', 28 | outputDir: 'dist', 29 | assetsDir: 'static', 30 | lintOnSave: process.env.NODE_ENV === 'development', 31 | productionSourceMap: false, 32 | devServer: { 33 | port: port, 34 | open: true, 35 | overlay: { 36 | warnings: false, 37 | errors: true, 38 | }, 39 | before: require('./mock/mock-server.js'), 40 | }, 41 | configureWebpack: { 42 | // provide the app's title in webpack's name field, so that 43 | // it can be accessed in index.html to inject the correct title. 44 | name: name, 45 | resolve: { 46 | alias: { 47 | '@': resolve('src'), 48 | }, 49 | }, 50 | }, 51 | chainWebpack(config) { 52 | // it can improve the speed of the first screen, it is recommended to turn on preload 53 | config.plugin('preload').tap(() => [ 54 | { 55 | rel: 'preload', 56 | // to ignore runtime.js 57 | // https://github.com/vuejs/vue-cli/blob/dev/packages/@vue/cli-service/lib/config/app.js#L171 58 | fileBlacklist: [/\.map$/, /hot-update\.js$/, /runtime\..*\.js$/], 59 | include: 'initial', 60 | }, 61 | ]) 62 | 63 | // when there are many pages, it will cause too many meaningless requests 64 | // config.plugins.delete('prefetch') 65 | 66 | // set svg-sprite-loader 67 | config.module 68 | .rule('svg') 69 | .exclude.add(resolve('src/icons')) 70 | .end() 71 | config.module 72 | .rule('icons') 73 | .test(/\.svg$/) 74 | .include.add(resolve('src/icons')) 75 | .end() 76 | .use('svg-sprite-loader') 77 | .loader('svg-sprite-loader') 78 | .options({ 79 | symbolId: 'icon-[name]', 80 | }) 81 | .end() 82 | 83 | config.when(process.env.NODE_ENV !== 'development', config => { 84 | config 85 | .plugin('ScriptExtHtmlWebpackPlugin') 86 | .after('html') 87 | .use('script-ext-html-webpack-plugin', [ 88 | { 89 | // `runtime` must same as runtimeChunk name. default is `runtime` 90 | inline: /runtime\..*\.js$/, 91 | }, 92 | ]) 93 | .end() 94 | config.optimization.splitChunks({ 95 | chunks: 'all', 96 | cacheGroups: { 97 | libs: { 98 | name: 'chunk-libs', 99 | test: /[\\/]node_modules[\\/]/, 100 | priority: 10, 101 | chunks: 'initial', // only package third parties that are initially dependent 102 | }, 103 | // elementUI: { 104 | // name: 'chunk-elementUI', // split elementUI into a single package 105 | // priority: 20, // the weight needs to be larger than libs and app or it will be packaged into libs or app 106 | // test: /[\\/]node_modules[\\/]_?element-ui(.*)/ // in order to adapt to cnpm 107 | // }, 108 | commons: { 109 | name: 'chunk-commons', 110 | test: resolve('src/components'), // can customize your rules 111 | minChunks: 3, // minimum common number 112 | priority: 5, 113 | reuseExistingChunk: true, 114 | }, 115 | }, 116 | }) 117 | // https:// webpack.js.org/configuration/optimization/#optimizationruntimechunk 118 | config.optimization.runtimeChunk('single') 119 | }) 120 | }, 121 | } 122 | -------------------------------------------------------------------------------- /src/styles/sidebar.scss: -------------------------------------------------------------------------------- 1 | #app { 2 | 3 | .main-container { 4 | min-height: 100%; 5 | transition: margin-left .28s; 6 | margin-left: $sideBarWidth; 7 | position: relative; 8 | } 9 | 10 | .sidebar-container { 11 | transition: width 0.28s; 12 | width: $sideBarWidth !important; 13 | background-color: $menuBg; 14 | height: 100%; 15 | position: fixed; 16 | font-size: 0px; 17 | top: 0; 18 | bottom: 0; 19 | left: 0; 20 | z-index: 1001; 21 | overflow: hidden; 22 | 23 | // reset element-ui css 24 | .horizontal-collapse-transition { 25 | transition: 0s width ease-in-out, 0s padding-left ease-in-out, 0s padding-right ease-in-out; 26 | } 27 | 28 | .scrollbar-wrapper { 29 | overflow-x: hidden !important; 30 | } 31 | 32 | .el-scrollbar__bar.is-vertical { 33 | right: 0px; 34 | } 35 | 36 | .el-scrollbar { 37 | height: 100%; 38 | } 39 | 40 | &.has-logo { 41 | .el-scrollbar { 42 | height: calc(100% - 50px); 43 | } 44 | } 45 | 46 | .is-horizontal { 47 | display: none; 48 | } 49 | 50 | a { 51 | display: inline-block; 52 | width: 100%; 53 | overflow: hidden; 54 | } 55 | 56 | .svg-icon { 57 | margin-right: 16px; 58 | } 59 | 60 | .sub-el-icon { 61 | margin-right: 12px; 62 | margin-left: -2px; 63 | } 64 | 65 | .el-menu { 66 | border: none; 67 | height: 100%; 68 | width: 100% !important; 69 | } 70 | 71 | // menu hover 72 | .submenu-title-noDropdown, 73 | .el-submenu__title { 74 | &:hover { 75 | background-color: $menuHover !important; 76 | } 77 | } 78 | 79 | .is-active>.el-submenu__title { 80 | color: $subMenuActiveText !important; 81 | } 82 | 83 | & .nest-menu .el-submenu>.el-submenu__title, 84 | & .el-submenu .el-menu-item { 85 | min-width: $sideBarWidth !important; 86 | background-color: $subMenuBg !important; 87 | 88 | &:hover { 89 | background-color: $subMenuHover !important; 90 | } 91 | } 92 | } 93 | 94 | .hideSidebar { 95 | .sidebar-container { 96 | width: 50px !important; 97 | } 98 | 99 | .main-container { 100 | margin-left: 54px; 101 | } 102 | 103 | .submenu-title-noDropdown { 104 | padding: 0 !important; 105 | position: relative; 106 | 107 | .el-tooltip { 108 | padding: 0 !important; 109 | 110 | .svg-icon { 111 | margin-left: 20px; 112 | } 113 | 114 | .sub-el-icon { 115 | margin-left: 19px; 116 | } 117 | } 118 | } 119 | 120 | .el-submenu { 121 | overflow: hidden; 122 | 123 | &>.el-submenu__title { 124 | padding: 0 !important; 125 | 126 | .svg-icon { 127 | margin-left: 20px; 128 | } 129 | 130 | .sub-el-icon { 131 | margin-left: 19px; 132 | } 133 | 134 | .el-submenu__icon-arrow { 135 | display: none; 136 | } 137 | } 138 | } 139 | 140 | .el-menu--collapse { 141 | .el-submenu { 142 | &>.el-submenu__title { 143 | &>span { 144 | height: 0; 145 | width: 0; 146 | overflow: hidden; 147 | visibility: hidden; 148 | display: inline-block; 149 | } 150 | } 151 | } 152 | } 153 | } 154 | 155 | .el-menu--collapse .el-menu .el-submenu { 156 | min-width: $sideBarWidth !important; 157 | } 158 | 159 | // mobile responsive 160 | .mobile { 161 | .main-container { 162 | margin-left: 0px; 163 | } 164 | 165 | .sidebar-container { 166 | transition: transform .28s; 167 | width: $sideBarWidth !important; 168 | } 169 | 170 | &.hideSidebar { 171 | .sidebar-container { 172 | pointer-events: none; 173 | transition-duration: 0.3s; 174 | transform: translate3d(-$sideBarWidth, 0, 0); 175 | } 176 | } 177 | } 178 | 179 | .withoutAnimation { 180 | 181 | .main-container, 182 | .sidebar-container { 183 | transition: none; 184 | } 185 | } 186 | } 187 | 188 | // when menu collapsed 189 | .el-menu--vertical { 190 | &>.el-menu { 191 | .svg-icon { 192 | margin-right: 16px; 193 | } 194 | .sub-el-icon { 195 | margin-right: 12px; 196 | margin-left: -2px; 197 | } 198 | } 199 | 200 | .nest-menu .el-submenu>.el-submenu__title, 201 | .el-menu-item { 202 | &:hover { 203 | // you can use $subMenuHover 204 | background-color: $menuHover !important; 205 | } 206 | } 207 | 208 | // the scroll bar appears when the subMenu is too long 209 | >.el-menu--popup { 210 | max-height: 100vh; 211 | overflow-y: auto; 212 | 213 | &::-webkit-scrollbar-track-piece { 214 | background: #d3dce6; 215 | } 216 | 217 | &::-webkit-scrollbar { 218 | width: 6px; 219 | } 220 | 221 | &::-webkit-scrollbar-thumb { 222 | background: #99a9bf; 223 | border-radius: 20px; 224 | } 225 | } 226 | } 227 | -------------------------------------------------------------------------------- /src/router/index.js: -------------------------------------------------------------------------------- 1 | import { createRouter, createWebHashHistory } from 'vue-router' 2 | 3 | /* Layout */ 4 | import Layout from '@/layout' 5 | 6 | /** 7 | * Note: sub-menu only appear when route children.length >= 1 8 | * Detail see: https://panjiachen.github.io/vue-element-admin-site/guide/essentials/router-and-nav.html 9 | * 10 | * hidden: true if set true, item will not show in the sidebar(default is false) 11 | * alwaysShow: true if set true, will always show the root menu 12 | * if not set alwaysShow, when item has more than one children route, 13 | * it will becomes nested mode, otherwise not show the root menu 14 | * redirect: noRedirect if set noRedirect will no redirect in the breadcrumb 15 | * name:'router-name' the name is used by (must set!!!) 16 | * meta : { 17 | roles: ['admin','editor'] control the page roles (you can set multiple roles) 18 | title: 'title' the name show in sidebar and breadcrumb (recommend set) 19 | icon: 'svg-name'/'el-icon-x' the icon show in the sidebar 20 | breadcrumb: false if set false, the item will hidden in breadcrumb(default is true) 21 | activeMenu: '/example/list' if set path, the sidebar will highlight the path you set 22 | } 23 | */ 24 | 25 | /** 26 | * constantRoutes 27 | * a base page that does not have permission requirements 28 | * all roles can be accessed 29 | */ 30 | export const constantRoutes = [ 31 | { 32 | path: '/login', 33 | component: () => import('@/views/login/index'), 34 | hidden: true, 35 | }, 36 | 37 | { 38 | path: '/404', 39 | component: () => import('@/views/404'), 40 | hidden: true, 41 | }, 42 | 43 | { 44 | path: '/', 45 | component: Layout, 46 | redirect: '/dashboard', 47 | children: [ 48 | { 49 | path: 'dashboard', 50 | name: 'Dashboard', 51 | component: () => import('@/views/dashboard/index'), 52 | meta: { title: 'Dashboard', icon: 'dashboard' }, 53 | }, 54 | ], 55 | }, 56 | 57 | { 58 | path: '/example', 59 | component: Layout, 60 | redirect: '/example/table', 61 | name: 'Example', 62 | meta: { title: 'Example', icon: 'el-icon-s-help' }, 63 | children: [ 64 | { 65 | path: 'table', 66 | name: 'Table', 67 | component: () => import('@/views/table/index'), 68 | meta: { title: 'Table', icon: 'table' }, 69 | }, 70 | { 71 | path: 'tree', 72 | name: 'Tree', 73 | component: () => import('@/views/tree/index'), 74 | meta: { title: 'Tree', icon: 'tree' }, 75 | }, 76 | ], 77 | }, 78 | 79 | { 80 | path: '/form', 81 | component: Layout, 82 | children: [ 83 | { 84 | path: 'index', 85 | name: 'Form', 86 | component: () => import('@/views/form/index'), 87 | meta: { title: 'Form', icon: 'form' }, 88 | }, 89 | ], 90 | }, 91 | 92 | { 93 | path: '/nested', 94 | component: Layout, 95 | redirect: '/nested/menu1', 96 | name: 'Nested', 97 | meta: { 98 | title: 'Nested', 99 | icon: 'nested', 100 | }, 101 | children: [ 102 | { 103 | path: 'menu1', 104 | component: () => import('@/views/nested/menu1/index'), // Parent router-view 105 | name: 'Menu1', 106 | meta: { title: 'Menu1' }, 107 | children: [ 108 | { 109 | path: 'menu1-1', 110 | component: () => import('@/views/nested/menu1/menu1-1'), 111 | name: 'Menu1-1', 112 | meta: { title: 'Menu1-1' }, 113 | }, 114 | { 115 | path: 'menu1-2', 116 | component: () => import('@/views/nested/menu1/menu1-2'), 117 | name: 'Menu1-2', 118 | meta: { title: 'Menu1-2' }, 119 | children: [ 120 | { 121 | path: 'menu1-2-1', 122 | component: () => 123 | import('@/views/nested/menu1/menu1-2/menu1-2-1'), 124 | name: 'Menu1-2-1', 125 | meta: { title: 'Menu1-2-1' }, 126 | }, 127 | { 128 | path: 'menu1-2-2', 129 | component: () => 130 | import('@/views/nested/menu1/menu1-2/menu1-2-2'), 131 | name: 'Menu1-2-2', 132 | meta: { title: 'Menu1-2-2' }, 133 | }, 134 | ], 135 | }, 136 | { 137 | path: 'menu1-3', 138 | component: () => import('@/views/nested/menu1/menu1-3'), 139 | name: 'Menu1-3', 140 | meta: { title: 'Menu1-3' }, 141 | }, 142 | ], 143 | }, 144 | { 145 | path: 'menu2', 146 | component: () => import('@/views/nested/menu2/index'), 147 | name: 'Menu2', 148 | meta: { title: 'menu2' }, 149 | }, 150 | ], 151 | }, 152 | 153 | { 154 | path: '/external-link', 155 | component: Layout, 156 | children: [ 157 | { 158 | path: 'https://panjiachen.github.io/vue-element-admin-site/#/', 159 | meta: { title: 'External Link', icon: 'link' }, 160 | }, 161 | ], 162 | }, 163 | 164 | // 404 page must be placed at the end !!! 165 | { path: '/:pathMatch(.*)*', name: 'not-found', redirect: '/404', hidden: true }, 166 | ] 167 | 168 | const getRouter = () => 169 | createRouter({ 170 | // mode: 'history', // require service support 171 | history: createWebHashHistory(), 172 | scrollBehavior: () => ({ top: 0 }), 173 | routes: constantRoutes, 174 | }) 175 | 176 | const router = getRouter() 177 | 178 | // Detail see: https://github.com/vuejs/vue-router/issues/1234#issuecomment-357941465 179 | export function resetRouter() { 180 | const newRouter = getRouter() 181 | router.matcher = newRouter.matcher // reset router 182 | } 183 | 184 | export default router 185 | -------------------------------------------------------------------------------- /src/views/404.vue: -------------------------------------------------------------------------------- 1 | 22 | 23 | 34 | 35 | 229 | -------------------------------------------------------------------------------- /src/views/login/index.vue: -------------------------------------------------------------------------------- 1 | 54 | 55 | 127 | 128 | 174 | 175 | 238 | -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | root: true, 3 | parserOptions: { 4 | parser: 'babel-eslint', 5 | sourceType: 'module', 6 | }, 7 | env: { 8 | browser: true, 9 | node: true, 10 | es6: true, 11 | }, 12 | extends: ['plugin:vue/recommended', 'eslint:recommended'], 13 | 14 | // add your custom rules here 15 | //it is base on https://github.com/vuejs/eslint-config-vue 16 | rules: { 17 | 'vue/max-attributes-per-line': [ 18 | 2, 19 | { 20 | singleline: 10, 21 | multiline: { 22 | max: 1, 23 | allowFirstLine: false, 24 | }, 25 | }, 26 | ], 27 | 'vue/singleline-html-element-content-newline': 'off', 28 | 'vue/multiline-html-element-content-newline': 'off', 29 | 'vue/name-property-casing': ['error', 'PascalCase'], 30 | 'vue/no-v-html': 'off', 31 | 'accessor-pairs': 2, 32 | 'arrow-spacing': [ 33 | 2, 34 | { 35 | before: true, 36 | after: true, 37 | }, 38 | ], 39 | 'block-spacing': [2, 'always'], 40 | 'brace-style': [ 41 | 2, 42 | '1tbs', 43 | { 44 | allowSingleLine: true, 45 | }, 46 | ], 47 | camelcase: [ 48 | 0, 49 | { 50 | properties: 'always', 51 | }, 52 | ], 53 | 'comma-dangle': [2, 'always-multiline'], 54 | 'comma-spacing': [ 55 | 2, 56 | { 57 | before: false, 58 | after: true, 59 | }, 60 | ], 61 | 'comma-style': [2, 'last'], 62 | 'constructor-super': 2, 63 | curly: [2, 'multi-line'], 64 | 'dot-location': [2, 'property'], 65 | 'eol-last': 2, 66 | eqeqeq: ['error', 'always', { null: 'ignore' }], 67 | 'generator-star-spacing': [ 68 | 2, 69 | { 70 | before: true, 71 | after: true, 72 | }, 73 | ], 74 | 'handle-callback-err': [2, '^(err|error)$'], 75 | indent: [ 76 | 2, 77 | 2, 78 | { 79 | SwitchCase: 1, 80 | }, 81 | ], 82 | 'jsx-quotes': [2, 'prefer-single'], 83 | 'key-spacing': [ 84 | 2, 85 | { 86 | beforeColon: false, 87 | afterColon: true, 88 | }, 89 | ], 90 | 'keyword-spacing': [ 91 | 2, 92 | { 93 | before: true, 94 | after: true, 95 | }, 96 | ], 97 | 'new-cap': [ 98 | 2, 99 | { 100 | newIsCap: true, 101 | capIsNew: false, 102 | }, 103 | ], 104 | 'new-parens': 2, 105 | 'no-array-constructor': 2, 106 | 'no-caller': 2, 107 | 'no-console': 'off', 108 | 'no-class-assign': 2, 109 | 'no-cond-assign': 2, 110 | 'no-const-assign': 2, 111 | 'no-control-regex': 0, 112 | 'no-delete-var': 2, 113 | 'no-dupe-args': 2, 114 | 'no-dupe-class-members': 2, 115 | 'no-dupe-keys': 2, 116 | 'no-duplicate-case': 2, 117 | 'no-empty-character-class': 2, 118 | 'no-empty-pattern': 2, 119 | 'no-eval': 2, 120 | 'no-ex-assign': 2, 121 | 'no-extend-native': 2, 122 | 'no-extra-bind': 2, 123 | 'no-extra-boolean-cast': 2, 124 | 'no-extra-parens': [2, 'functions'], 125 | 'no-fallthrough': 2, 126 | 'no-floating-decimal': 2, 127 | 'no-func-assign': 2, 128 | 'no-implied-eval': 2, 129 | 'no-inner-declarations': [2, 'functions'], 130 | 'no-invalid-regexp': 2, 131 | 'no-irregular-whitespace': 2, 132 | 'no-iterator': 2, 133 | 'no-label-var': 2, 134 | 'no-labels': [ 135 | 2, 136 | { 137 | allowLoop: false, 138 | allowSwitch: false, 139 | }, 140 | ], 141 | 'no-lone-blocks': 2, 142 | 'no-mixed-spaces-and-tabs': 2, 143 | 'no-multi-spaces': 2, 144 | 'no-multi-str': 2, 145 | 'no-multiple-empty-lines': [ 146 | 2, 147 | { 148 | max: 1, 149 | }, 150 | ], 151 | 'no-native-reassign': 2, 152 | 'no-negated-in-lhs': 2, 153 | 'no-new-object': 2, 154 | 'no-new-require': 2, 155 | 'no-new-symbol': 2, 156 | 'no-new-wrappers': 2, 157 | 'no-obj-calls': 2, 158 | 'no-octal': 2, 159 | 'no-octal-escape': 2, 160 | 'no-path-concat': 2, 161 | 'no-proto': 2, 162 | 'no-redeclare': 2, 163 | 'no-regex-spaces': 2, 164 | 'no-return-assign': [2, 'except-parens'], 165 | 'no-self-assign': 2, 166 | 'no-self-compare': 2, 167 | 'no-sequences': 2, 168 | 'no-shadow-restricted-names': 2, 169 | 'no-spaced-func': 2, 170 | 'no-sparse-arrays': 2, 171 | 'no-this-before-super': 2, 172 | 'no-throw-literal': 2, 173 | 'no-trailing-spaces': 2, 174 | 'no-undef': 2, 175 | 'no-undef-init': 2, 176 | 'no-unexpected-multiline': 2, 177 | 'no-unmodified-loop-condition': 2, 178 | 'no-unneeded-ternary': [ 179 | 2, 180 | { 181 | defaultAssignment: false, 182 | }, 183 | ], 184 | 'no-unreachable': 2, 185 | 'no-unsafe-finally': 2, 186 | 'no-unused-vars': [ 187 | 2, 188 | { 189 | vars: 'all', 190 | args: 'none', 191 | }, 192 | ], 193 | 'no-useless-call': 2, 194 | 'no-useless-computed-key': 2, 195 | 'no-useless-constructor': 2, 196 | 'no-useless-escape': 0, 197 | 'no-whitespace-before-property': 2, 198 | 'no-with': 2, 199 | 'one-var': [ 200 | 2, 201 | { 202 | initialized: 'never', 203 | }, 204 | ], 205 | 'operator-linebreak': [ 206 | 2, 207 | 'after', 208 | { 209 | overrides: { 210 | '?': 'before', 211 | ':': 'before', 212 | }, 213 | }, 214 | ], 215 | 'padded-blocks': [2, 'never'], 216 | quotes: [ 217 | 2, 218 | 'single', 219 | { 220 | avoidEscape: true, 221 | allowTemplateLiterals: true, 222 | }, 223 | ], 224 | semi: [2, 'never'], 225 | 'semi-spacing': [ 226 | 2, 227 | { 228 | before: false, 229 | after: true, 230 | }, 231 | ], 232 | 'space-before-blocks': [2, 'always'], 233 | 'space-before-function-paren': [2, 'never'], 234 | 'space-in-parens': [2, 'never'], 235 | 'space-infix-ops': 2, 236 | 'space-unary-ops': [ 237 | 2, 238 | { 239 | words: true, 240 | nonwords: false, 241 | }, 242 | ], 243 | 'spaced-comment': [ 244 | 2, 245 | 'always', 246 | { 247 | markers: [ 248 | 'global', 249 | 'globals', 250 | 'eslint', 251 | 'eslint-disable', 252 | '*package', 253 | '!', 254 | ',', 255 | ], 256 | }, 257 | ], 258 | 'template-curly-spacing': [2, 'never'], 259 | 'use-isnan': 2, 260 | 'valid-typeof': 2, 261 | 'wrap-iife': [2, 'any'], 262 | 'yield-star-spacing': [2, 'both'], 263 | yoda: [2, 'never'], 264 | 'prefer-const': 2, 265 | 'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0, 266 | 'object-curly-spacing': [ 267 | 2, 268 | 'always', 269 | { 270 | objectsInObjects: false, 271 | }, 272 | ], 273 | 'array-bracket-spacing': [2, 'never'], 274 | }, 275 | } 276 | --------------------------------------------------------------------------------