实现简单Pagination分页组件
对于分页组件,常见的就是支持点击切换某个值,进行页面的改变;还有就是在页面空间有限的情况下,能够对显示的最大的操作数进行控制,在显示不全的情况下,显示更多的操作按钮进行切换,参考element-plus可知,除了上述的功能以外,还具有,页码大小切换、分页总数和数量总数等功能。(这里的实现思路也是来源于element-plus),这里主要实现一个简单的分页组件,具备的功能主要有:
旅行的意义并不是告诉别人“这里我来过”,是一种改变。旅行会改变人的气质,让人的目光变得更加长远。
实现简单Pagination分页组件
实现效果

需求分析
对于分页组件,常见的就是支持点击切换某个值,进行页面的改变;还有就是在页面空间有限的情况下,能够对显示的最大的操作数进行控制,在显示不全的情况下,显示更多的操作按钮进行切换,参考element-plus可知,除了上述的功能以外,还具有,页码大小切换、分页总数和数量总数等功能。(这里的实现思路也是来源于element-plus),这里主要实现一个简单的分页组件,具备的功能主要有:
- 单个上下页切换
- 超过设置的按钮数量时(控制数),显示上下的更多按钮,在控制数内进行切换
- 如果当前的值为第一页,禁止上一页切换;如果当前页为最后一页,禁止下一页切换
- 。。。。
基础布局
vue
<script setup lang="ts">
// 定义分页参数
import {computed} from "vue";
interface Pagination {
// 数据总数
total: number;
// 需要显示的最大控制数
pagerCount?: number;
/**
* 每页的大小,total/pageSize得到总页数
*/
pageSize?: number;
}
const props =withDefaults(defineProps<Pagination>(), {
total: 50,
/**
* 默认控制数为7
*/
pagerCount: 7,
/**
* 每页的数量
*/
pageSize: 5,
})
/**
* 根据总数和每页的数量计算总页数,向上取整
*/
const pageCount = computed(() => Math.ceil(props.total / props.pageSize));
</script>
<template>
<ul class="pagination">
<li v-for="item in pageCount" :class="{
active: item===1,
}">{{item}}</li>
</ul>
</template>
<style scoped lang="scss">
ul.pagination {
/**
设置为行内元素
*/
display: inline-block;
padding: 0;
margin: 0;
> li{
display: inline;
min-width: 32px;
min-height: 32px;
line-height: 16px;
float: left;
margin: 0 4px;
background-color: #f0f2f5;
padding:8px;
/**
去掉li标签的默认样式
*/
text-decoration: none;
}
/**
改变鼠标移入样式
*/
> li:hover{
cursor: pointer;
color: white;
}
/**
鼠标移入时,非激活的样式
*/
> li:hover:not(.active) {
background-color: #85b5fa;
}
/**
激活的样式
*/
> li.active {
background-color: #589cfc;
color: white;
}
}
</style>
效果

单页切换
单页其实就是点击哪个分页的时候,就绑定当前点击的值。其实这里可以分为,点击具有数值的页码,还可以通过控制按钮来一个个递增或者递减的方式进行分页改变,这里先实现点击数值的分页页码。
如果点击哪个页码就进行改变的话,需要在每个元素上面进行添加事件绑定,这样就会出现很多重复的代码,因此,可以利用事件委托的方法,在ul元素上面添加一个点击事件的绑定即可。
steup代码添加:
typescript
/**
* 当前双向绑定的分页,即当前的分页页码
*/
const modelValue = defineModel('value', {
type: Number,
default: 1,
})
/**
* 通过事件委托的方式,处理点击的分页页码
* @param event
*/
const handleClick = (event: Event): void => {
}
HTML代码部分改为:
vue
<ul class="pagination" @click="handleClick">
<li v-for="item in pageCount" :class="{active: item===modelValue,}">{{item}}</li>
</ul>
现在单页的大致部分已经添加完成,现在就是处理单页控制的逻辑处理了,主要集中在handleClick方法上面。
typescript
/**
* 通过事件委托的方式,处理点击的分页页码
* @param event
*/
const handleClick = (event: Event): void => {
// 获取触发点击的元素
const target = event.target as HTMLElement
const { tagName, textContent } = target
// 如果是ul元素触发的,或者内容是空的,不处理
if (tagName.toLowerCase() === 'ul' || !textContent) {
return
}
// 如果是数值的话,直接改变分页
if (!Number.isNaN(+textContent)){
modelValue.value = +textContent
}
}
现在单页切换的代码大致实现了,不过还有一些细节的处理,后面实现完多页切换后,再进行完善。

多页切换
实现多页切换,其实的核心就是,我们根据需要显示的最大控制数(记作pagerCount)去计算是否当前的页码是否超过pagerCount的中间值(记作halfPagerCount)。
为什么是中间值呢?
其实我们想实现的就是:
- 当前的页码大于
pagerCount-halfPagerCount时,需要除了第一页的控制外,在第二个位置显示一个更多的按钮(多页)来对左侧页码的控制; - 当页面小于总页数
pageCount-halfPagerCount时需要显示倒数第二个位置显示一个更多的按钮来控制右侧的页码,否则说明当前的页面已经到了pagerCount的右侧
typescript
// 向上取正,计算页数
const computedPage = computed(() => {
const currentPage = Number(modelValue.value)
const pagerCount = Number(props.pagerCount)
const halfPagerCount = (pagerCount - 1) / 2 // 需要显示的页数的一半
const pages: number[] = [] // 分页数据
let showPrevMore = false
let showNextMore = false
// 如果总页数大于需要控制显示的页数
if (unref(pageCount) > pagerCount ){
// 如果当前的页数大于需要显示的页数减去需要显示的页数的一半,说明已经到右侧了,需要显示左侧更多按钮
if (currentPage > pagerCount - halfPagerCount){
showPrevMore = true
}
// 如果当前页小于总页数减去需要显示的页数的一半,说明需要显示下一页的更多按钮
if (currentPage < unref(pageCount) - halfPagerCount){
showNextMore = true
}
}
// 只需要显示上一页的更多
if (showPrevMore && !showNextMore){
const startPage = unref(pageCount) - (pagerCount - 2) // 减2 一个是预留给默认第一页,和更多的按钮
for (let i = startPage; i < unref(pageCount); i++) {
pages.push(i)
}
}
// 只需要显示下一页的更多
else if (!showPrevMore && showNextMore){
// 直接从第二页开始
for (let i = 2; i < pagerCount; i++) {
pages.push(i)
}
}
// 上一页的更多和下一页的更多都需要显示
else if (showPrevMore && showNextMore){
const offset = Math.floor(pagerCount / 2) - 1 // 左右两侧的偏移量
for (let i = currentPage - offset; i <= currentPage + offset; i++) {
pages.push(i)
}
} else {
for (let i = 2; i < unref(pageCount); i++) {
pages.push(i)
}
}
return pages
});
修改HTML部分代码:
vue
<template>
<ul class="cz-pagination" @click="handleClick">
<li v-if="pageCount >0" :class="{active: modelValue === 1}">
1
</li>
<li v-if="showPrevMore" class="quick-prev">«</li>
<li v-for="page in computedPage" :key="page" :class="{active: modelValue === page}">
{{ page }}
</li>
<li v-if="showNextMore" class="quick-next">»</li>
<li v-if="pageCount > 1" :class="{active: modelValue === pageCount}">
{{ pageCount }}
</li>
</ul>
</template>
setup修改代码:
typescript
const showPrevMore = ref(false) // 是否显示上一页更多
const showNextMore = ref(false) // 是否显示上一页更多
/**
* 根据点击的分页计算是否需要显示更多分页按钮
*/
const updateMore = ()=> {
const halfPagerCount = (props.pagerCount - 1) / 2
showPrevMore.value = false
showNextMore.value = false
if (pageCount.value! > props.pagerCount) {
if (modelValue.value > props.pagerCount - halfPagerCount) {
showPrevMore.value = true
}
if (modelValue.value < pageCount.value - halfPagerCount) {
showNextMore.value = true
}
}
}
/**
* 通过事件委托的方式,处理点击的分页页码
* @param event
*/
const handleClick = (event: Event): void => {
// 获取触发点击的元素
const target = event.target as HTMLElement
const { tagName, textContent } = target
// 如果是ul元素触发的,或者内容是空的,不处理
if (tagName.toLowerCase() === 'ul' || !textContent) {
return
}
if (target.className.includes('quick-prev')){
modelValue.value = modelValue.value - props.pagerCount - 2
} else if (target.className.includes('quick-next')){
modelValue.value = modelValue.value + props.pagerCount - 2
} else if (!Number.isNaN(+textContent)){ // 如果是数值的话,直接改变分页
modelValue.value = +textContent
}
// 计算显示更多按钮
updateMore()
}

到这里已经完成了更多分页按钮的逻辑处理,那么现在完善一下单个分页的情况
HTML代码修改为:
vue
<template>
<ul class="pagination" @click="handleClick">
<li class="page-single single-prev" :class="{disabled: singlePage.prev}"> 上一页 </li>
<li v-if="pageCount >0" :class="{active: modelValue === 1}">
1
</li>
<li v-if="showPrevMore" class="quick-prev">«</li>
<li v-for="page in computedPage" :key="page" :class="{active: modelValue === page}">
{{ page }}
</li>
<li v-if="showNextMore" class="quick-next">»</li>
<li v-if="pageCount > 1" :class="{active: modelValue === pageCount}">
{{ pageCount }}
</li>
<li class="page-single single-next" :class="{disabled: singlePage.next}"> 下一页 </li>
</ul>
</template>
样式代码新增:
css
> li.page-single.single-prev.disabled, li.page-single.single-next.disabled{
cursor: not-allowed;
color: #a8abb2;
user-select: none;
}
setup新增代码:
typescript
// 保存上下分页的按钮是否可用
const singlePage= reactive({
next: modelValue.value===pageCount.value,
prev: modelValue.value===1,
})
handleClick添加逻辑
typescript
if (target.className.includes('single-next')){
modelValue.value +=1
} else if (target.className.includes('single-prev')){
modelValue.value -=1
}
....
else if (!Number.isNaN(+textContent)){ // 如果是数值的话,直接改变分页
modelValue.value = +textContent
// 计算上下一页是否可用
singlePage.next = pageCount.value === modelValue.value
singlePage.prev = 1=== modelValue.value
}
好了,目前已经完成了基本的功能。其实还可以像element-plus那样添加页数大小、总数等等功能,这里只是实现一个简单的功能而已。
完整代码
vue
<script setup lang="ts">
// 定义分页参数
import {computed, reactive, ref, unref} from "vue";
interface Pagination {
// 数据总数
total: number;
// 需要显示的最大控制数
pagerCount?: number;
/**
* 每页的大小,total/pageSize得到总页数
*/
pageSize?: number;
}
const props =withDefaults(defineProps<Pagination>(), {
total: 50,
/**
* 默认控制数为7
*/
pagerCount: 7,
/**
* 每页的数量
*/
pageSize: 5,
})
const showPrevMore = ref(false) // 是否显示上一页更多
const showNextMore = ref(false) // 是否显示上一页更多
/**
* 根据总数和每页的数量计算总页数,向上取整
*/
const pageCount = computed(() => Math.ceil(props.total / props.pageSize));
/**
* 当前双向绑定的分页,即当前的分页页码
*/
const modelValue = defineModel('value', {
type: Number,
default: 1,
})
const singlePage= reactive({
next: modelValue.value===pageCount.value,
prev: modelValue.value===1,
})
// 向上取正,计算页数
const computedPage = computed(() => {
const currentPage = Number(modelValue.value)
const pagerCount = Number(props.pagerCount)
const halfPagerCount = (pagerCount - 1) / 2 // 需要显示的页数的一半
const pages: number[] = [] // 分页数据
let showPrevMore = false
let showNextMore = false
// 如果总页数大于需要控制显示的页数
if (unref(pageCount) > pagerCount ){
// 如果当前的页数大于需要显示的页数减去需要显示的页数的一半,说明已经到右侧了,需要显示左侧更多按钮
if (currentPage > pagerCount - halfPagerCount){
showPrevMore = true
}
// 如果当前页小于总页数减去需要显示的页数的一半,说明需要显示下一页的更多按钮
if (currentPage < unref(pageCount) - halfPagerCount){
showNextMore = true
}
}
// 只需要显示上一页的更多
if (showPrevMore && !showNextMore){
const startPage = unref(pageCount) - (pagerCount - 2) // 减2 一个是预留给默认第一页,和更多的按钮
for (let i = startPage; i < unref(pageCount); i++) {
pages.push(i)
}
}
// 只需要显示下一页的更多
else if (!showPrevMore && showNextMore){
// 直接从第二页开始
for (let i = 2; i < pagerCount; i++) {
pages.push(i)
}
}
// 上一页的更多和下一页的更多都需要显示
else if (showPrevMore && showNextMore){
const offset = Math.floor(pagerCount / 2) - 1 // 左右两侧的偏移量
for (let i = currentPage - offset; i <= currentPage + offset; i++) {
pages.push(i)
}
} else {
for (let i = 2; i < unref(pageCount); i++) {
pages.push(i)
}
}
return pages
});
/**
* 根据点击的分页计算是否需要显示更多分页按钮
*/
const updateMore = ()=> {
const halfPagerCount = (props.pagerCount - 1) / 2
showPrevMore.value = false
showNextMore.value = false
if (pageCount.value! > props.pagerCount) {
if (modelValue.value > props.pagerCount - halfPagerCount) {
showPrevMore.value = true
}
if (modelValue.value < pageCount.value - halfPagerCount) {
showNextMore.value = true
}
}
}
/**
* 通过事件委托的方式,处理点击的分页页码
* @param event
*/
const handleClick = (event: Event): void => {
// 获取触发点击的元素
const target = event.target as HTMLElement
const { tagName, textContent } = target
// 如果是ul元素触发的,或者内容是空的,不处理
if (tagName.toLowerCase() === 'ul' || !textContent) {
return
}
if (target.className.includes('single-next')){
modelValue.value +=1
} else if (target.className.includes('single-prev')){
modelValue.value -=1
}
else if (target.className.includes('quick-prev')){
modelValue.value = modelValue.value - props.pagerCount - 2
} else if (target.className.includes('quick-next')){
modelValue.value = modelValue.value + props.pagerCount - 2
} else if (!Number.isNaN(+textContent)){ // 如果是数值的话,直接改变分页
modelValue.value = +textContent
singlePage.next = pageCount.value === modelValue.value
singlePage.prev = 1=== modelValue.value
}
updateMore()
}
</script>
<template>
<ul class="pagination" @click="handleClick">
<li class="page-single single-prev" :class="{disabled: singlePage.prev}"> 上一页 </li>
<li v-if="pageCount >0" :class="{active: modelValue === 1}">
1
</li>
<li v-if="showPrevMore" class="quick-prev">«</li>
<li v-for="page in computedPage" :key="page" :class="{active: modelValue === page}">
{{ page }}
</li>
<li v-if="showNextMore" class="quick-next">»</li>
<li v-if="pageCount > 1" :class="{active: modelValue === pageCount}">
{{ pageCount }}
</li>
<li class="page-single single-next" :class="{disabled: singlePage.next}"> 下一页 </li>
</ul>
</template>
<style scoped lang="scss">
ul.pagination {
/**
设置为行内元素
*/
display: inline-block;
padding: 0;
margin: 0;
> li{
display: inline;
min-width: 32px;
min-height: 32px;
line-height: 16px;
user-select: none;
float: left;
margin: 0 4px;
background-color: #f0f2f5;
padding:8px;
/**
去掉li标签的默认样式
*/
text-decoration: none;
}
/**
改变鼠标移入样式
*/
> li:hover{
cursor: pointer;
color: white;
}
/**
鼠标移入时,非激活的样式
*/
> li:hover:not(.active) {
background-color: #85b5fa;
}
/**
激活的样式
*/
> li.active {
background-color: #589cfc;
color: white;
}
> li.page-single.single-prev.disabled, li.page-single.single-next.disabled{
cursor: not-allowed;
color: #a8abb2;
}
}
</style>