从0搭建vue3组件库:Link组件

简介: 从0搭建vue3组件库:Link组件

image.png

携手创作,共同成长!这是我参与「掘金日新计划 · 8 月更文挑战」的第3天,点击查看活动详情


传统的a标签样式太过简陋,所以这篇文章将为我们组件库实现一个文字超链接Link组件。首先要做的就是目录结构的创建(和前面组件目录一致),如下图

image.png


当然如果你想更深入的了解Vue3组件库的搭建的话可以关注这个专栏->从零搭建vue3组件库系列专栏 将不断更新一些组件的实现方法。

接下来就开始实现我们组件库的第三个组件Link组件


基础用法



首先我们先将写出我们Link组件的基本框架,link.vue如下

<template>
    <a class="k-link">
        <slot />
    </a>
</template>
<script lang="ts">
import './style/index.less'
import { defineComponent } from 'vue'
export default defineComponent({
    name: 'k-link',
    setup(props) {
        return {
        }
    }
});
</script>

然后去除a标签的默认样式以及给Link标签加上基础样式 style/index.less如下

.k-link {
  display: inline-flex;
  flex-direction: row;
  align-items: center;
  justify-content: center;
  vertical-align: middle;
  position: relative;
  text-decoration: none;
  outline: none;
  cursor: pointer;
  padding: 0;
  font-size: 14px;
  font-weight: 500;
}

最后我们统一导出Link组件,其中目录结构如下图

image.png

  • link/index.ts

这里我们已经将withInstall封装成了一个包为我们组件提供install属性

import link from './link.vue'
import { withInstall } from '@kitty-ui/utils'
const Link = withInstall(link)
export default Link

  • src/index.ts

这里集中导出所有组件

export { default as Button } from './button'
export { default as Icon } from './Icon'
export { default as Link } from './link'
  • components/index.ts

这里分别导出单个组件,以及默认导出为所有组件赋予install函数的对象便于全局导入我们的组件库,app.use(xxx)

import * as components from './src/index'
export * from './src/index'
export default {
    install: (app: any) => {
        for (const comkey in components) {
            app.component((components as any)[comkey].name, (components as any)[comkey])
        }
    }
}

然后根目录下执行pnpm run exm:dev启动我们的测试组件实例项目examples,这里的做了一个脚本配置

image.png

然后在examples/app.vue中引入Link组件

<template>
    <div>
        <Link>link</Link>
    </div>
</template>
<script lang="ts" setup>
import { Link } from 'kitty-ui'
</script>
<style lang="less">
</style>

此时页面上已经展示了我们的Link组件,我们便可继续开发Link组件的其它功能了。


继承a标签原生属性


接下来我们要做的是将原生a标签上的属性原封不动的复制到我们的Link组件上,比如hreftarget等。我们可以使用vue3中的useAttrs获取传来的所有属性然后绑定在组件上。实现方式如下

<template>
    <a v-bind="attrs" class="k-link">
        <slot />
    </a>
</template>
<script lang="ts">
import './style/index.less'
import { defineComponent, useAttrs } from 'vue'
export default defineComponent({
    name: 'k-link',
    setup(props) {
        const attrs = useAttrs()
        console.log(attrs)
        return {
            attrs
        }
    }
});
</script>

然后在app.vue进行一个测试

<template>
    <div>
        <Link href="https://juejin.cn/post/7121381989864701982">link</Link>
    </div>
</template>
<script lang="ts" setup>
import { Link } from 'kitty-ui'
</script>
<style lang="less">
</style>

你会发现点击便可跳转到对应链接。


根据不同type展示不同颜色


接下来实现的其实和Button组件差不多,更具传来的不同type展示不同效果。首先我们在types.ts中定义组件的属性:

import { ExtractPropTypes } from 'vue'
export const LinkType = ['primary', 'success', 'info', 'warning', 'danger']
export const linkProps = {
    type: {
        type: String,
        validator(value: string) {
            return LinkType.includes(value)
        }
    },
}
export type LinkProps = ExtractPropTypes<typeof linkProps>

然后我们在link.vue中使用,然后用计算属性实现不同type对应不同类名

<template>
    <a v-bind="attrs" class="k-link" :class="styleClass">
        <slot />
    </a>
</template>
<script lang="ts">
import './style/index.less'
import { linkProps } from './types'
import { defineComponent, useAttrs, computed } from 'vue'
export default defineComponent({
    name: 'k-link',
    props: linkProps,
    setup(props) {
        const attrs = useAttrs()
        const styleClass = computed(() => {
            return {
                [`k-link--${props.type}`]: props.type,
            }
        })
        return {
            attrs,
            styleClass
        }
    }
});
</script>

同时我们在style/index.less中定义primary类型以及它的hover(其它type实现方式一样,这里就不一一展示了)

...
.k-link--primary {
  color: #409eff;
}
.k-link--primary:hover {
  color: #66b1ff;
}

展示如下

image.png

到这里Link组件的基础用法便实现了,接下来开始实现它的禁用状态


禁用状态



它的实现和和type差不多,同样根据disabled属性来赋予不同类名,这里同样只展示一个primary的禁用状态,奇遇type实现方式一致

  • types.ts
...
export const linkProps = {
    type: {
        type: String,
        validator(value: string) {
            return LinkType.includes(value)
        }
    },
    disabled: Boolean
}
...
  • link.vue


...
const styleClass = computed(() => {
            return {
                [`k-link--${props.type}`]: props.type,
                'is-disabled': props.disabled
            }
        })
...
  • style/index.less
...
.k-link.is-disabled {
  cursor: not-allowed;
}
.k-link.is-disabled {
  cursor: not-allowed;
}
.k-link--primary.is-disabled {
  color: #a0cfff;
}

最后展示如下

image.png


下划线



我们使用underline来控制我们组件是否展示下划线,如果underlinetrue我们便给组件添加个类名is-underline,并给is-underline添加个伪类after

  • types.ts
...
export const linkProps = {
    type: {
        type: String,
        validator(value: string) {
            return LinkType.includes(value)
        }
    },
    disabled: Boolean,
    underline: Boolean
}
...
  • link.vue
...
 const styleClass = computed(() => {
            return {
                [`k-link--${props.type}`]: props.type,
                'is-disabled': props.disabled,
                'is-underline': props.underline,
            }
        })
...
  • style/index.less
.k-link.k-underline:hover:after {
  content: "";
  position: absolute;
  left: 0;
  right: 0;
  height: 0;
  bottom: 0;
  border-bottom: 1px solid #409eff;
}

在app.vue中使用

<Link type="primary" underline>主要链接</Link>

此时鼠标移入便出现了下划线

image.png


直接使用



组件库代码已经上传到gitee,如果你感兴趣的话可以直接点击->kittyui 使用(记得给个star哦~~~~ ),然后你只需要以下几步便可启动项目、组件库文档以及本地调试项目

  • 安装 pnpm npm i pnpm -g
  • 安装所有依赖 pnpm install
  • 启动本地调试vue3项目 pnpm run exm:dev
  • 打包 pnpm run build
  • 启动文档 pnpm run docs:dev
  • 打包文档 pnpm run docs:build
  • 启动打包后文档服务 pnpm run docs:serve



相关文章
|
2月前
|
缓存 JavaScript UED
Vue3中v-model在处理自定义组件双向数据绑定时有哪些注意事项?
在使用`v-model`处理自定义组件双向数据绑定时,要仔细考虑各种因素,确保数据的准确传递和更新,同时提供良好的用户体验和代码可维护性。通过合理的设计和注意事项的遵循,能够更好地发挥`v-model`的优势,实现高效的双向数据绑定效果。
157 64
|
21天前
|
JavaScript API 数据处理
vue3使用pinia中的actions,需要调用接口的话
通过上述步骤,您可以在Vue 3中使用Pinia和actions来管理状态并调用API接口。Pinia的简洁设计使得状态管理和异步操作更加直观和易于维护。无论是安装配置、创建Store还是在组件中使用Store,都能轻松实现高效的状态管理和数据处理。
69 3
|
2月前
|
前端开发 JavaScript 测试技术
Vue3中v-model在处理自定义组件双向数据绑定时,如何避免循环引用?
Web 组件化是一种有效的开发方法,可以提高项目的质量、效率和可维护性。在实际项目中,要结合项目的具体情况,合理应用 Web 组件化的理念和技术,实现项目的成功实施和交付。通过不断地探索和实践,将 Web 组件化的优势充分发挥出来,为前端开发领域的发展做出贡献。
47 8
|
2月前
|
存储 JavaScript 数据管理
除了provide/inject,Vue3中还有哪些方式可以避免v-model的循环引用?
需要注意的是,在实际开发中,应根据具体的项目需求和组件结构来选择合适的方式来避免`v-model`的循环引用。同时,要综合考虑代码的可读性、可维护性和性能等因素,以确保系统的稳定和高效运行。
42 1
|
2月前
|
JavaScript
Vue3中使用provide/inject来避免v-model的循环引用
`provide`和`inject`是 Vue 3 中非常有用的特性,在处理一些复杂的组件间通信问题时,可以提供一种灵活的解决方案。通过合理使用它们,可以帮助我们更好地避免`v-model`的循环引用问题,提高代码的质量和可维护性。
51 1
|
2月前
|
JavaScript
在 Vue 3 中,如何使用 v-model 来处理自定义组件的双向数据绑定?
需要注意的是,在实际开发中,根据具体的业务需求和组件设计,可能需要对上述步骤进行适当的调整和优化,以确保双向数据绑定的正确性和稳定性。同时,深入理解 Vue 3 的响应式机制和组件通信原理,将有助于更好地运用 `v-model` 实现自定义组件的双向数据绑定。
|
14天前
|
JavaScript
vue使用iconfont图标
vue使用iconfont图标
82 1
|
25天前
|
JavaScript 关系型数据库 MySQL
基于VUE的校园二手交易平台系统设计与实现毕业设计论文模板
基于Vue的校园二手交易平台是一款专为校园用户设计的在线交易系统,提供简洁高效、安全可靠的二手商品买卖环境。平台利用Vue框架的响应式数据绑定和组件化特性,实现用户友好的界面,方便商品浏览、发布与管理。该系统采用Node.js、MySQL及B/S架构,确保稳定性和多功能模块设计,涵盖管理员和用户功能模块,促进物品循环使用,降低开销,提升环保意识,助力绿色校园文化建设。
|
2月前
|
JavaScript 前端开发 开发者
vue学习第一章
欢迎来到我的博客!我是瑞雨溪,一名热爱前端的大一学生,专注于JavaScript与Vue,正向全栈进发。博客分享Vue学习心得、命令式与声明式编程对比、列表展示及计数器案例等。关注我,持续更新中!🎉🎉🎉
54 1
vue学习第一章
|
2月前
|
JavaScript 前端开发 索引
vue学习第三章
欢迎来到瑞雨溪的博客,一名热爱JavaScript与Vue的大一学生。本文介绍了Vue中的v-bind指令,包括基本使用、动态绑定class及style等,希望能为你的前端学习之路提供帮助。持续关注,更多精彩内容即将呈现!🎉🎉🎉
49 1