Vue3中setup怎么添加name

星伟大大_2921

星伟大大_2921

2023-05-13

3530人浏览

转载

    Vue3中name有什么用呢?

    1.在递归组件的时候需要定义name

    2.配合keep-alive include exclude 可以缓存组件

    3.在Vue有报错或者调试的时候可以看到组件的name

    Vue3 定义 name

    1.自动生成

    <script setup></script> 只要在script开启setup语法糖模式 单文件组件会自动根据文件名生成对应的 name 选项 例如 Tree.vue 那他的name 就是 Tree 自动生成,这样做有一个弊端如果想修改name需要修改组件名称如果有地方import 该组件需要一并修改。

    2.在开启一个script用来定义name

    优点 这种方式可以随意定义name 弊端 一个单文件组件出现两个script 会让人感到疑惑。

    <template><div></div>
    </template><script>
    import {ref,reactive } from 'vue'
    </script><script>
     export default {
        name:"XXX"
     }
    </script><style>
    
    </style>

    3.使用第三方插件 unplugin-vue-define-options

    安装方法 npm i unplugin-vue-define-options -D

    vite 使用

    // vite.config.ts
    import DefineOptions from 'unplugin-vue-define-options/vite'
    import Vue from '@vitejs/plugin-vue'
    
    export default defineConfig({
      plugins: [Vue(), DefineOptions()],
    })

    配置tsconfig.json

    // tsconfig.json
    {
      "compilerOptions": {
        // ...
        "types": ["unplugin-vue-define-options/macros-global" /* ... */]
      }
    }

    使用方法 通过编译宏 defineOptions 添加name 和 inheritAttrs

    <script>
    defineOptions({
      name: 'Foo',
      inheritAttrs: false,
    })
    </script>

    4.个人想法 我想着直接在script 定义name 不好吗?

    <template><div></div>
    </template><script>
    import {ref,reactive } from 'vue'
    </script><style>
    
    </style>

    这件事情在Vue社区也是进行了激烈的讨论,而尤大也是做出了回复

    尤大觉得这个构思很好,但是有一些担忧,在我们使用组件的时候需要定义name 和 inheritAttrs 情况非常罕见,大部分组件库的开发人员可能经常会使用这两个东西,但对于90%的应用程序组件来说,这确实是一组不同的权衡,并且处理props将会变得很麻烦,再加上实现的复杂性,不确定做这件事是否值得。

    Element Plus UI Vue3
    Element Plus UI Vue3

    Element Plus Vue3 桌面组件库。在开发 Vue 3.x 页面时调用,使用 Element Plus 组件(如 el-button、el-input、el-form、el-table 等)。

    下载

    不过已经有一个插件实现该功能 unplugin-vue-setup-extend-plus

    我们来复刻一个简易版 其原理还是加一个script 只不过开发人员看不到了这个script

    Vue3 setup 支持 name 插件实现 思路借鉴上面插件

    import type { Plugin } from 'vite'
    //@vue/compiler-sfc 这个插件是处理我们单文件组件的代码解析
    import { compileScript, parse } from '@vue/compiler-sfc'
    
    export default function setupName(): Plugin {
        return {
    
            name: 'vite:plugin:vue:name',
            //一个 Vite 插件可以额外指定一个 `enforce` 属性
            //(类似于 webpack 加载器)来调整它的应用顺序。`enforce` 的值可以是`pre` 或 `post`
            //加载顺序为
              //Alias
              //带有 `enforce: 'pre'` 的用户插件
              //Vite 核心插件
              //没有 enforce 值的用户插件
              //Vite 构建用的插件
              //带有 `enforce: 'post'` 的用户插件
             //Vite 后置构建插件(最小化,manifest,报告)
            enforce: "pre",
            //transform code参数就是我们写的代码比如vue代码  id就是路径例如/src/xx/xx.vue
            transform(code, id) {
                //只处理vue结尾的文件
                if (/.vue$/.test(id)) {
                    let { descriptor } = parse(code)
                    //通过compileScript 处理script 返回result
                      //attrs: { name: 'xm', lang: 'ts', setup: true },
                      //lang: 'ts',
                      //setup: true,
                    const result = compileScript(descriptor, { id })
                    //attrs 此时就是一个对象
                    const name = result.attrs.name 
                    const lang = result.attrs.lang
                    const inheritAttrs = result.attrs.inheritAttrs
                    //写入script
                    const template = `
                    <script>
                     export default {
                        ${name ? `name:"${name}",`  : ''}
                        ${inheritAttrs ? `inheritAttrs: ${inheritAttrs !== 'false'},` : ''}
                     }
                    </script>
                    `;
                    //最后拼接上这段代码 也就是我们加的script这一段 返回code
                    code += template;
                   // console.log(code)
                }
    
                return code
            }
        }
    }

    然后在vite config ts 引入我们写好的插件

    Vue3中setup怎么添加name

    Tree.vue 子组件

    <template>
        <div>
            {{ item.name }}
            <xm></xm>
        </div>
    </template><script>
    import { ref, reactive } from 'vue'
    defineProps<{
        data: any[]
    }>()
    </script>

    App.vue 父组件

    <template>
        <treevue></treevue></template><script>
    import TreeVue from './components/Tree.vue';
    const data = [
        {
            name: "1",
            children: [
                {
                    name: "1-1",
                    children: [
                        {
                            name: "1-1-1"
                        }
                    ]
                }
            ]
        }
    ]
    </script>

    组件成功递归出来

    Vue3中setup怎么添加name

    前端入门到VUE实战笔记:立即使用
    在学习笔记中,你将探索 前端 的入门与实战技巧!

    相关文章

    PHP速学视频免费教程(入门到精通)
    PHP速学视频免费教程(入门到精通)

    PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

    下载

    相关标签:

    vue3

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

    相关专题

    更多
    json数据格式
    json数据格式

    JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

    2023.08.07

    2415

    5

    json是什么
    json是什么

    JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

    2023.08.23

    4022

    1

    jquery怎么操作json
    jquery怎么操作json

    操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

    2023.10.13

    1336

    3

    go语言处理json数据方法
    go语言处理json数据方法

    本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

    2025.09.10

    4679

    7

    typedef和define区别
    typedef和define区别

    typedef和define区别在类型检查、作用范围、可读性、错误处理和内存占用等。本专题为大家提供typedef和define相关的文章、下载、课程内容,供大家免费下载体验。

    2023.09.26

    333

    5

    define的用法
    define的用法

    define用法:1、定义常量;2、定义函数宏:3、定义条件编译;4、定义多行宏。更多关于define的用法的内容,大家可以阅读本专题下的文章。

    2023.10.11

    619

    5

    Navicat创建数据库教程
    Navicat创建数据库教程

    本专题整理Navicat创建数据库相关教程,介绍新建前的准备、基础设置和创建后的检查方法。内容兼顾入门学习及实际使用需求,帮助用户了解不同数据库类型下的操作差异,为后续建表、保存数据和日常管理提供参考。

    2026.11.20

    0

    7

    Navicat入门教程大全
    Navicat入门教程大全

    本专题整理Navicat入门教程,从认识软件界面到开展数据库操作,介绍初次使用需要了解的知识和方法。内容兼顾连接配置、数据管理及日常使用中的疑问,方便用户按学习进度查阅,为后续实践和独立操作打好基础。

    2026.11.20

    0

    17

    Navicat数据库连接配置指南
    Navicat数据库连接配置指南

    从确认数据库信息到建立可用连接,本专题串联Navicat连接数据库的相关知识和操作方法。既有初次配置时需要了解的基础内容,也有连接后的检查思路,方便用户按实际需求查阅教程,逐步熟悉数据库连接的设置流程。

    2026.11.20

    0

    10

    热门下载

    更多
    网站特效
    /
    网站源码
    /
    网站素材
    /
    前端模板

    精品课程

    更多
    相关推荐
    /
    热门推荐
    /
    最新课程
    Vue3.x 工具篇--十天技能课堂
    Vue3.x 工具篇--十天技能课堂

    共26课时 | 2.6万人学习

    Vue3.x 核心篇--十天技能课堂
    Vue3.x 核心篇--十天技能课堂

    共30课时 | 2.5万人学习

    Vue3.x新特性篇--十天基础课堂
    Vue3.x新特性篇--十天基础课堂

    共20课时 | 1.8万人学习