分类 Vue 下的文章

在 src下的目录结构

QQ20240531-081042@2x.png

在 router下的路由实现

import { createRouter, createWebHistory } from 'vue-router'

// const routes = [
//     {
//         path: '/',
//         component: () => import('/pages/views/index/index.vue'),
//     },
//     {
//         path: '/about',
//         component: () => import('/pages/views/about/index.vue'),
//     }
// ]

const pageModules = import.meta.glob('../views/**/page.js', {
    eager: true,
    import: 'default'
});

const pageComps = import.meta.glob('../views/**/index.vue',{
    eager: true,
    import: 'default'
});

const routes =Object.entries(pageModules).map(([pagePath, config])=> {
    console.log(pagePath, config);
    let path = pagePath.replace('../views', '').replace('/page.js', '');
    path = path || '/';
    const name = path.split('/').filter(Boolean).join('-') || 'index';
    const compPath = pagePath.replace('page.js', 'index.vue');
    return {
        path,
        name,
        component: pageComps[compPath],
        meta: config,
    };
});

console.log(routes)


const router = createRouter({
    history: createWebHistory(),
    routes
})

export default router

config.mjs

import {defineConfig} from 'vitepress'
import {setSidebar} from "./utils/auto-sidebar.mjs";
import {viteCMSFront} from "./sider/cms-front.js"

// https://vitepress.dev/reference/site-config
// https://vitepress.dev/reference/default-theme-config
export default defineConfig({
    title: "资料库",
    description: "Mallray's description",
    lang: 'zh-CN',
    base: '/public/note', //默认站点目录
    lastUpdated: true,
    head: [["link", { rel: "icon", href: "/file/favicon.ico" }]],
    markdown: {
        lineNumbers: true
    },
    themeConfig: {
        logo: '/images/logo.svg',
        outline: [2, 6],
        outlineTitle: '章节导航',
        docFooter: {
            prev: '←上一篇',
            next: '下一篇→',
        },
        lastUpdatedText: '上次更新时间',
        //首页顶部导航
        nav: [
            {text: '首页', link: '/'},
            {
                text: '技术笔记',
                items: [
                    {text: '前端VUE3', link: '/doc/cms/front/'},
                    {text: '后台Golang', link: '/doc/cms/back/'}
                ]
            }
        ],
        //侧边框
        sidebar: {
            "/doc/cms/front": setSidebar("/doc/cms/front"),
            "/doc/cms/back": setSidebar("/doc/cms/back"),
            // "/doc/cms/front": viteCMSFront,
        },
        //主页图片导航
        socialLinks: [
            {icon: 'github', link: 'http://a.liziyu.com'}
        ],
        //页脚版权
        footer: {
            message: '',
            copyright: "liziyu.com"
        },
        // 设置搜索框的样式
        search: {
            provider: "local",
            options: {
                translations: {
                    button: {
                        buttonText: "搜索文档",
                        buttonAriaLabel: "搜索文档",
                    },
                    modal: {
                        noResultsText: "无法找到相关结果",
                        resetButtonTitle: "清除查询条件",
                        footer: {
                            selectText: "选择",
                            navigateText: "切换",
                        },
                    },
                },
            },
        },
    },
})

auto-siderbar.mjs

import path from "node:path";
import fs from "node:fs";

// 文件根目录
const DIR_PATH = path.resolve();
// 白名单,过滤不是文章的文件和文件夹
const WHITE_LIST = [
    "index.md",
    ".vitepress",
    "node_modules",
    ".idea",
    "assets",
];

// 判断是否是文件夹
const isDirectory = (path) => fs.lstatSync(path).isDirectory();

// 取差值
const intersections = (arr1, arr2) =>
    Array.from(new Set(arr1.filter((item) => !new Set(arr2).has(item))));

// 把方法导出直接使用
function getList(params, path1, pathname) {
    // 存放结果
    const res = [];
    // 开始遍历params
    for (let file in params) {
        // 拼接目录
        const dir = path.join(path1, params[file]);
        // 判断是否是文件夹
        const isDir = isDirectory(dir);
        if (isDir) {
            // 如果是文件夹,读取之后作为下一次递归参数
            const files = fs.readdirSync(dir);
            res.push({
                text: params[file],
                collapsible: true,
                items: getList(files, dir, `${pathname}/${params[file]}`),
            });
        } else {
            // 获取名字
            const name = path.basename(params[file]);
            // 排除非 md 文件
            const suffix = path.extname(params[file]);
            if (suffix !== ".md") {
                continue;
            }
            res.push({
                text: name,
                link: `${pathname}/${name}`,
            });
        }
    }
    // 对name做一下处理,把后缀删除
    res.map((item) => {
        item.text = item.text.replace(/\.md$/, "");
    });
    return res;
}

export const setSidebar = (pathname) => {
    // 获取pathname的路径
    const dirPath = path.join(DIR_PATH, pathname);
    // 读取pathname下的所有文件或者文件夹
    const files = fs.readdirSync(dirPath);
    // 过滤掉
    const items = intersections(files, WHITE_LIST);
    // getList 函数后面会讲到
    return getList(items, dirPath, pathname);
};

上传组件的封装

<template>
  <div class="upload-file">
    <el-upload multiple :action="uploadFileUrl" :data="fileData" :before-upload="handleBeforeUpload"
               :file-list="fileList" :limit="limit" :on-error="handleUploadError" :on-exceed="handleExceed"
               :on-success="handleUploadSuccess" :on-progress="handleProgress" :show-file-list="false" :headers="headers"
               class="upload-file-uploader" ref="upload">
      <!-- 上传按钮 -->
      <slot>
        <el-button type="primary">选取文件</el-button>
      </slot>
    </el-upload>
    <!-- 上传提示 -->
    <div class="el-upload__tip" v-if="showTip">
      请上传
      <template v-if="fileSize">
        大小不超过 <b style="color: #f56c6c">{{ fileSize }}MB</b>
      </template>
      <template v-if="fileType">
        格式为 <b style="color: #f56c6c">{{ fileType.join("/") }}</b>
      </template>
      的文件
    </div>
    <!-- 文件列表 -->
    <transition-group class="upload-file-list el-upload-list el-upload-list--text" name="el-fade-in-linear" tag="ul" v-if="showFileList">
      <li :key="file.uid" class="el-upload-list__item ele-upload-list__item-content" v-for="(file, index) in fileList">
        <el-link :href="`${baseUrl}${file.url}`" :underline="false" target="_blank">
                    <span class="document">
                        {{ getFileName(file.name) }}
                    </span>
        </el-link>
        <div class="ele-upload-list__item-content-action">
          <el-link :underline="false" @click="handleDelete(index)" type="danger">删除</el-link>
        </div>
      </li>
    </transition-group>
    <div class="flex flex-direction justify-center align-center" v-if="upLoading"
         style="position: fixed;top: 0;bottom: 0;left: 0;right: 0;height: 100vh;width: 100vw;z-index: 9999999;background-color: rgba(0,0,0,0.8);">
      <div v-loading="upLoading" element-loading-text="" element-loading-background="rgba(0, 0, 0, 0)"
           style="width: 10px;height: 10px;"></div>
      <span style="font-size: 16px;color: var(--el-color-primary);margin-top: 40px;">上传进度:{{ upProgress }}%</span>
    </div>
  </div>
</template>

<script setup>
import { genFileId ,ElMessage } from 'element-plus'
import { computed, getCurrentInstance, reactive, ref, watch } from "vue";
import { API_BASE_URL, FILE_FULL_PATH } from '@/config/setting.js'

const props = defineProps({
  modelValue: [String, Object, Array],
  limit: {
    type: Number,
    default: 0,
  },
  fileSize: {
    type: Number,
    default: 0,
  },
  fileType: {
    type: Array,
    default: ['pdf','png','jpg'],
  },
  // 是否显示提示
  isShowTip: {
    type: Boolean,
    default: false,
  },
  // 超出上传数量时,是否覆盖继续上传
  isExceed: {
    type: Boolean,
    default: false,
  },
  showFileList: {
    type: Boolean,
    default: true,
  },
  //定义上传附件要传递的字段
  source: {
    type: String,
    default: "",
  }
});

const emit = defineEmits(['update:modelValue', 'uploadSuccess']);
const upload = ref()
const num = ref(0);
const uploadList = ref([]);
// 文件访问地址
const baseUrl = FILE_FULL_PATH;
// 上传接口地址
const uploadFileUrl = API_BASE_URL + "api/sys/upload";
// 请求头
const headers = { Authorization: "Bearer " };
const fileList = ref();
const upLoading = ref(false)
const upProgress = ref(0)
const showTip = computed(
  () => props.isShowTip && (props.fileType || props.fileSize)
);
const fileData = reactive({
  'source': props.source
})

watch(
  () => props.modelValue,
  (val) => {
    if (val) {
      let temp = 1;
      // 首先将值转为数组
      const list = Array.isArray(val)
        ? val
        : (props.modelValue?.toString().split(","));
      // 然后将数组转为对象数组
      fileList.value = list.map((item) => {
        if (typeof item === "string") {
          item = { name: item, url: item };
        }
        item.uid = item.uid || new Date().getTime() + temp++;
        return item;
      });
    } else {
      fileList.value = [];
      return [];
    }
  },
  { deep: true, immediate: true }
);

// 上传前校检格式和大小
const handleBeforeUpload = (file) => {
  // 校检文件类型
  if (props.fileType.length) {
    let fileExtension = "";
    if (file.name.lastIndexOf(".") > -1) {
      fileExtension = file.name.slice(file.name.lastIndexOf(".") + 1);
    }
    const isTypeOk = props.fileType.some((type) => {
      if (file.type.indexOf(type) > -1) return true;
      if (fileExtension && fileExtension.indexOf(type) > -1) return true;
      return false;
    });
    if (!isTypeOk) {
      ElMessage.error(
        `文件格式不正确, 请上传${props.fileType.join("/")}格式文件!`
      );
      return false;
    }
  }
  // 校检文件大小
  if (props.fileSize) {
    const isLt = file.size / 1024 / 1024 < props.fileSize;
    if (!isLt) {
      ElMessage.error(`上传文件大小不能超过 ${props.fileSize} MB!`);
      return false;
    }
  }
  // ElMessage.loading("正在上传文件,请稍候...");
  upLoading.value = true;
  num.value++;
  return true;
};

// 文件个数超出
const handleExceed = (files) => {
  if (props.isExceed) {
    upload.value.clearFiles()
    const file = files[0]
    file.uid = genFileId()
    upload.value.handleStart(file)
    upload.value.submit()
  } else {
    ElMessage.error(`上传文件数量不能超过 ${props.limit} 个!`);
  }
};

// 上传失败
const handleUploadError = (err) => {
  upload.value = false
  ElMessage.error("上传文件失败");
};

// 上传成功回调
const handleUploadSuccess = (res, file) => {
  if (res.code === 200) {
    upLoading.value = false
    //注意下面的数据返回格式 res.data即文件名
    uploadList.value.push({ name: res.data, url: res.data });
    if (uploadList.value.length === num.value) {
      fileList.value = fileList.value
        .filter((f) => f.url !== undefined)
        .concat(uploadList.value);
      uploadList.value = [];
      num.value = 0;
      emit("update:modelValue", listToString(fileList.value));
      emit("uploadSuccess");
    }
  } else {
    ElMessage.error(res.message);
  }
};

// 上传进度
const handleProgress = (evt, uploadFile, uploadFiles) => {
  upProgress.value = Math.round((evt.percent * 100)) / 100
}

// 删除文件
const handleDelete = (index) => {
  fileList.value.splice(index, 1);
  emit("update:modelValue", listToString(fileList.value));
};

// 获取文件名称
const getFileName = (name) => {
  if (!name) {
    console.log('getFileName\'s name is null')
    return
  }
  //console.log('name', name);
  if (name.lastIndexOf("/") > -1) {
    return name.slice(name.lastIndexOf("/") + 1);
  } else {
    return name;
  }
};

// 对象转成指定字符串分隔
const listToString = (list, separator) => {
  let strs = "";
  separator = separator || ",";
  for (let i in list) {
    if (undefined !== list[i].url) {
      strs += list[i].url + separator;
    }
  }
  return strs !== "" ? strs.substring(0, strs.length - 1) : "";
};
</script>

<style scoped lang="scss">
.upload-file-uploader {
  margin-bottom: 5px;
}

.upload-file-list .el-upload-list__item {
  padding: 20px 0;
  border: 1px solid #e4e7ed;
  line-height: 2;
  margin-bottom: 10px;
  position: relative;
}

.upload-file-list .ele-upload-list__item-content {
  display: flex;
  justify-content: space-between;
  align-items: center;
  color: inherit;
  padding: 2px 12px;
}

.ele-upload-list__item-content-action .el-link {
  margin-left: 16px;
}
</style>

调用

<el-form-item label="上传图片" prop="thum">
 <!--图片上传组件-->
 <UploadImage
     v-model="form.thum"
     :fileType="['png','jpg','jpeg','bmp']"
     :isShowTip="true"
     :source="'sys_sys_upload_release'" >
     <el-button>+ 上传</el-button>
   </UploadImage>
</el-form-item>

项目打包后默认只能部署在服务器根路径,如果想 http://localhost:5173/admin/ 这种形式,可以根据 vite、vue-router 文档介绍进行配置。

1、在 vite.config.js 中配置:

// ......省略其它代码
export default defineConfig(({ command }) => {
    return {
        // 在这里增加 base 写子路径
        base: '/admin/',  // 注意这里前后都要有斜杠
        // ......省略其它代码
        resolve: { /*......省略*/ }
        // 如果要修改打包后的输出目录可以加这个配置
        build: {
            outDir: 'admin'  // 默认是 dist
        }
    };
});

2、然后在 src/router/index.js 中增加:

// ......省略其它代码
const router = createRouter({
    routes,
    // 给 createWebHistory 方法传参数配置子路径
    history: createWebHistory(import.meta.env.BASE_URL)
});

3、然后重新运行(run dev)或者打包(run build)部署后再访问就可以带上配置的子路径了,也可以在打包的时候动态设置子路径:

npm run build --base=/admin/

App.vue

<script setup>
import {ref} from 'vue'
import Footer from './components/footer.vue'

const uid = ref("")

const userName = (res) =>{
  uid.value = res

}

</script>

<template>
  <div>
    接收子组件值为:{{uid}}
    <hr />
  </div>
<!--Footer上的 name与 age传给的是组件页-->
  <Footer @emitsUserName="userName" name="张小虎" age="22">
<!--#abc是插槽名称,其中 data是用来接收子组件 slot上的属性值-->
    <template #abc="d">
      <!--接收来的属性值直接可以在此使用-->
      {{d.title}} - {{d.score}}
      <!--下面本段文字是直接被子组件 slot显示并装载至父组件内-->
      我是一个小小鸟
    </template>
    <template #cde>
      Footer内的第二个 slot传来的值。
    </template>
  </Footer>
</template>



footer.vue

<script setup>
  const props = defineProps({
    name:{
      type:String,
      required:true,
      default:"默认值哦哦"
    },
    age:{
      type:String,
    },
  });

  var emits = defineEmits(["emitsUserName"]);
  emits("emitsUserName", "Footer子传父亲")
</script>

<template>
<div>
  <div>
    父组件传递过来的值:<h3>{{props.name}} --- {{props.age}}</h3>
    <hr />
  </div>
  <div>
    <slot name="abc" title="我是子组件内 slot上的title" score="100"></slot>
    <hr />
  </div>
  <div>
    <slot name="cde"></slot>
  </div>
</div>
</template>

<style scoped>

</style>

效果:

QQ20240310-165113@2x.png

简述,下述组件的粗略粗略粗略的理解:
其中“:button-style”表示父组件向子组件传值;
其中“@upload”表示,子向父传值,这里接收的是一个事件。
<el-upload
    :button-style="buttonStyle"
    v-model="data"
    @upload="onUpload"
/>



:button-style="buttonStyle" 是将 buttonStyle 这个属性的值从父组件传递给子组件的语法。在父组件中,你可以定义一个名为 buttonStyle 的属性,并将其绑定到子组件的 button-style 属性上。子组件可以使用这个属性值来自定义按钮的样式。

@upload="onUpload" 是父组件监听子组件触发的 upload 事件的语法。在子组件中,当某个操作或条件满足时,你可以使用 this.$emit('upload') 来触发 upload 事件。父组件可以在相应的方法(例如 onUpload)中定义逻辑来响应该事件。

通过这样的方式,父组件可以向子组件传递属性(props)和监听事件(events),实现父子组件之间的数据传递和通信。

总结:

步骤 1、首页在子组件定义组件需要发射的组件事件,数组方式,如:
const emits = defineEmits(["emit_a", "emit_b"])
步骤 2、然后通过返回的变量 emits来执行发射服务,如下:
emits("emit_a", {name:"liziyu",age:20})
步骤 3、在父组件内的子组件标签通过@与事件名emit_a作为接收点,如:
<Footer @emit_a="getEmitsObj" />
其中 getEmitsObj为任意自定义的函数名。
步骤 4、在父组件内,定义getEmitsObj函数,来接收子组件的值。如:
const getEmitsObj = (data) => {console.log(data);}
其中data就是接收到的值,此时可以将它赋值给组件变量,就可以正常使用了。

App.vue

<script setup>
  import { reactive,ref } from 'vue'

  //导入子组件
  import Header from "./components/header.vue"

  //响应式数据
  const web = reactive({
    name: "邓瑞编程",
    url: 'dengruicode.com'
  })

  const user = ref(0)

  //子传父
  const emitsWeb = (data) => {
    console.log("emitsWeb:",data)
    web.url = data.url
  }

  const emitsUser = (data) => {
    console.log("emitsUser:",data)
    user.value += data
  }
</script>

<template>
  <!-- 子传父 -->
  <Header @web="emitsWeb" @user="emitsUser" />

  {{ web.url }} - {{ user }}
</template>

<style scoped></style>


header.vue

<script setup>
    //子组件

    /*
        defineEmits是Vue3的编译时宏函数,
        用于子组件向父组件发送自定义事件
    */
    //子传父
    //定义一个名为 emits 的对象, 用于存储自定义事件
    const emits = defineEmits(["web","user"])
    //发送名为 web 和 user 的自定义事件
    emits("web", {name:"邓瑞",url:"www.dengruicode.com"})
    
    //添加用户
    const userAdd = () => {
        //发送名为 user 的自定义事件
        emits("user", 10)
    }
</script>

<template>
    <h3>Header</h3>

    <button @click="userAdd">添加用户</button>
</template>

<style scoped>

</style>

转自:邓瑞编程

总结:

一、传数组:

步骤 1、在父亲组件内,通过子组件标签属性方式,定义参数名称,如:
<Header propsName="liziyu" propsAge=20 />

步骤 2、然后在子组件页面内,接收两个参数,如:
defineProps(["propsName", "propsAge"])
这样就可以在header 里使用上面两个数组元素了。

二、传对象:

步骤 1、在父组件内,通过子组件标签绑定一个对象参数的名称,如:
reactive({name:"liziyu",age:20})
<Footer v-bind="propsObj" />

步骤 2、在子组件页面内,接收这两个参数,与接收数组不同的是,需要在子组件内定义接收对象各字段类型用于接收对象值(有点像 golang的请求对象的结构体),如:
defineProps({name:String, age:Number})

App.vue

<script setup>
  import { reactive } from 'vue'

  //导入子组件
  //App.vue是父组件,因为它包含了header.vue和footer.vue两个子组件
  import Header from "./components/header.vue"
  import Footer from "./components/footer.vue"

  /*
  const propsWeb = {
    user: 10,
    ip: '127.0.0.1'
  }
  */
  //响应式数据
  const propsWeb = reactive({
    user: 10,
    ip: '127.0.0.1'
  })

  //添加用户
  const userAdd = () => {
    propsWeb.user++
    console.log(propsWeb.user)
  }
</script>

<template>
  <!-- 父传子 - 方式1 -->
  <Header propsName="邓瑞编程" propsUrl="dengruicode.com" />

  dengruicode.com

  <button @click="userAdd">添加用户</button>

  <!-- 父传子 - 方式2 -->
  <!-- <Footer v-bind="propsWeb" /> -->
  <Footer :="propsWeb" />
</template>

<style scoped></style>


header.vue

<script setup>
    //子组件

    //接收方式1 - 数组
    /*
        defineProps是Vue3的编译时宏函数,
        用于接收父组件向子组件传递的属性(props)

        注
        当使用Vue编译器编译包含defineProps的组件时,
        编译器会将这些宏替换为相应的运行时代码
    */
    const props = defineProps(["propsName","propsUrl"])
    console.log(props)
</script>

<template>
    <h3>Header</h3>
</template>

<style scoped>

</style>


footer.vue

<script setup>
    //子组件

    //接收方式2 - 对象
    /*
    const props = defineProps({
        user: Number,
        ip: String
    })
    */
    const props = defineProps({
        user: Number,
        ip: {
            type: String,
            required: true, //true表示必传属性,若未传则会提示警告信息
            default: 'localhost' //未传默认值
        }
    })

    console.log(props)
</script>

<template>
    <h3>Footer</h3>
    user: {{ props.user }}
</template>

<style scoped>

</style>

转自:邓瑞编程