在Web应用中,星级评分组件经常被用于对商品、服务或其他内容进行评级。为了方便开发者使用,Vue.js社区已经有不少星级评分组件插件,但是,自己封装一个星级评分组件插件也很有必要。本篇文章将放弃传统的组件编写方式,引入Vue.js 3的Composition API,讲解如何使用Vue.js插件封装一个星级评分组件。
先来了解一下Composition API。Composition API主要有以下优点:
- 更好的逻辑封装:现在,逻辑可以按照逻辑进行分组,而不是按照生命周期或options API定义属性和方法。此外,可以根据单一职责原则来分组,使代码更易于维护和测试。
- 更容易重用逻辑:将逻辑封装到自定义hook中可以使其在组件中易于共享和重用,还可以将其与其他开发人员共享,甚至将其分发到npm上以供其他人使用。
- 更直观的组件代码:由于逻辑被拆分为较小的块,使代码更直观、更易于理解,减少不必要的标记和嵌套,从而更容易推断组件的作用。
- 更好的类型推断:Composition API与TypeScript紧密集成,从而使开发人员能够利用TypeScript的类型推断功能来编写更稳健的代码。
接下来,我们就使用Composition API来设计和实现星级评分组件。
第1步:创建一个Vue.js插件
插件是Vue.js底层结构的扩展方式。Vue.js插件可以为Vue.js应用程序提供全局级别的功能,因此它们很适合实现通用的组件或指令。以下是创建并安装Vue.js插件的基本步骤:
- 创建一个JavaScript对象,在该对象中定义install方法。此方法会接收Vue作为参数,并在一个new Vue() 实例的范围内注册新组件或其它功能。
- 在install方法中定义组件或其他实用程序。
- 调用Vue上的static use()方法,传递一个对象,该对象包含需要安装的插件。Vue.js将调用此对象中的install方法,并将Vue.js实例作为参数传递给该方法。
示例代码如下:
// 定义插件对象
const StarRating = {
install: function(Vue) {
// 在install方法中注册全局组件 star-rating
Vue.component('star-rating', {
// 组件选项
})
}
}
// 调用Vue.use()方法安装插件
Vue.use(StarRating)
第2步:设计组件的属性和事件
在Composition API中,推荐使用reactive()方法来定义组件的状态(state)。使用computed()方法来计算组件的派生状态(derived state),使用watch()方法来监听组件的状态变化。为了更好地通过props和emit传递数据,我们可以使用reactive()来定义属性和事件对象。
组件中应该具有以下几个属性:
- rating: 当前评级
- maxRating: 最大可评级数
- starSize: 星星大小
- padding: 星星之间的间距
- showRating: 是否显示评级
组件中应该具有以下事件:
以下是定义属性和事件对象的示例代码:
const StarRating = {
install: function(Vue) {
Vue.component('star-rating', {
setup(props, {emit}) {
const state = reactive({
rating: 0,
maxRating: props.maxRating || 5,
starSize: props.starSize || 25,
padding: props.padding || 5,
showRating: props.showRating || false,
})
function updateRating(rating) {
state.rating = rating
emit('update', rating)
}
return {
state,
updateRating
}
}
})
}
}
第3步:实现组件UI
接下来,我们使用模板代码实现组件的UI。Vue.js3中使用setup()函数来设置组件状态和事件,并使用template中的插值表达式和指令来渲染组件UI。
以下是实现组件UI的示例代码:
const StarRating = {
install: function(Vue) {
Vue.component('star-rating', {
setup(props, {emit}) {
const state = reactive({
rating: 0,
maxRating: props.maxRating || 5,
starSize: props.starSize || 25,
padding: props.padding || 5,
showRating: props.showRating || false,
})
function updateRating(rating) {
state.rating = rating
emit('update', rating)
}
const stars = []
for (let i = 0; i < state.maxRating; i++) {
stars.push(i < state.rating ? 'star' : 'star_border')
}
return {
state,
updateRating,
stars,
}
},
template: `
<div>
<i
v-for="star in stars"
:key="star"
:class="[star]"
:style="{
'font-size': state.starSize + 'px',
'padding-right': state.padding + 'px',
}"
@click="updateRating(stars.indexOf(star) + 1)"
></i>
<span v-if="state.showRating">{{state.rating}}/{{state.maxRating}}</span>
</div>
`
})
}
}
我们使用了v-for指令来循环渲染星星,并使用i标签和FontAwesome字体图标来呈现星星图标。这样我们就可以依据用户的选择更新评级了。
第4步:使用组件
现在,我们已经完成了一个星级评分组件插件的开发。我们可以在Vue.js应用程序中全局安装这个插件,然后在任何组件模板中使用它。
在Vue.js应用程序中使用组件的示例代码:
const app = Vue.createApp({})
ap
.........................................................