现代 CSS

使用Vue构建可重用的分页组件

作者：大漠 日期：2018-03-25 点击：6095
Vue
Vue组件
会员专栏

特别声明：如果您喜欢小站的内容，可以点击申请会员进行全站阅读。如果您对付费阅读有任何建议或想法，欢迎发送邮件至: airenliao@gmail.com!或添加QQ：874472854(^_^)

Web应用程序中资源分页不仅对性能很有帮助，而且从用户体验的角度来说也是非常有用的。在这篇文章中，将了解如何使用Vue创建动态和可用的分页组件。

基本结构

分页组件应该允许用户访问第一个和最后一个页面，向前和向后移动，并直接切换到近距离的页面。

大多数应用程序在用户每次更改页面时都会发出API请求。我们需要确保组件允许这样做，但是我们不希望在组件内发出这样的请求。这样，我们将确保组件在整个应用程序中是可重用的，并且请求都是在操作或服务层中进行的。我们可以通过使用用户单击的页面的数字触发事件来实现此目的。

有几种可能的方法来实现API端点上的分页。对于这个例子，我们假设API告诉我们每个页面的结果数、页面总数和当前页面。这些将是我们的动态props。

相反，如果API只告诉记录的总数，那么我们可以通过将结果的数量除以每一页的结果数来计算页数：totalResults / resultsPerPage。

我们想要渲染一个按钮到第一页、上一页、页面数量范围、下一页和最后一页：

[first] [next] [1] [2] [3] [previous] [last]

比如像下图这样的一个效果：

尽管我们希望渲染一个系列的页面，但并不希望渲染所有可用页面。让我们允许在我们的组件中设置一个最多可见按钮的props。

既然我们知道了我们想要的组件要做成什么，需要哪些数据，我们就可以设置HTML结构和所需要的props。

<template id="pagination">
    <ul class="pagination">
        <li>
            <button type="button">« First</button>
        </li>
        <li>
            <button type="button">«</button>
        </li>
        <!-- 页数的范围 -->
        <li>
            <button type="button">Next »</button>
        </li>
        <li>
            <button type="button">»</button>
        </li>
    </ul>
</template>

Vue.component('pagination', {
    template: '#pagination',
    props: {
        maxVisibleButtons: {
            type: Number,
            required: false,
            default: 3
        },
        totalPages: {
            type: Number,
            required: true
        },
        total: {
            type: Number,
            required: true
        },
        currentPage: {
            type: Number,
            required: true
        }
    }
})

上面的代码注册了一个pagination组件，如果调用这个组件：

<div id="app">
    <pagination></pagination>
</div>

这个时候看到的效果如下：

注意，为了能让组件看上去好看一点，给组件添加了一点样式。

事件监听

现在我们需要通知父组件，当用户单击按钮时，用户点击了哪个按钮。

我们需要为每个按钮添加一个事件监听器。v-on指令允许侦听DOM事件。在本例中，我将使用v-on的快捷键来侦听单击事件。

为了通知父节点，我们将使用$emit方法来发出一个带有页面点击的事件。

我们还要确保分页按钮只有在页面可用时才唯一一个当前状态。为了这样做，将使用v-bind将disabled属性的值与当前页面绑定。我们还是使用:v-bind的快捷键:。

为了保持我们的template干净，将使用computed属性来检查按钮是否被禁用。使用computed也会被缓存，这意味着只要currentPage不会更改，对相同计算属性的几个访问将返回先前计算的结果，而不必再次运行该函数。

<template id="pagination">
    <ul class="pagination">
        <li>
            <button type="button" @click="onClickFirstPage" :disabled="isInFirstPage">« First</button>
        </li>
        <li>
            <button type="button" @click="onClickPreviousPage" :disabled="isInFirstPage">«</button>
        </li>
        <li v-for="page in pages">
            <button type="button" @click="onClickPage(page.name)" :disabled="page.isDisabled"> {{ page.name }}</button>
        </li>
        <li>
            <button type="button" @click="onClickNextPage" :disabled="isInLastPage">Next »</button>
        </li>
        <li>
            <button type="button" @click="onClickLastPage" :disabled="isInLastPage">»</button>
        </li>
    </ul>
</template>

Vue.component('pagination', {
    template: '#pagination',
    props: {
        maxVisibleButtons: {
            type: Number,
            required: false,
            default: 3
        },
        totalPages: {
            type: Number,
            required: true
        },
        total: {
            type: Number,
            required: true
        },
        currentPage: {
            type: Number,
            required: true
        }
    },
    computed: {
        isInFirstPage: function () {
            return this.currentPage === 1
        },
        isInLastPage: function () {
            return this.currentPage === this.totalPages
        }
    },
    methods: {
        onClickFirstPage: function () {
            this.$emit('pagechanged', 1)
        },
        onClickPreviousPage: function () {
            this.$emit('pagechanged', this.currentPage - 1)
        },
        onClickPage: function (page) {
            this.$emit('pagechanged', page)
        },
        onClickNextPage: function () {
            this.$emit('pagechanged', this.currentPage + 1)
        },
        onClickLastPage: function () {
            this.$emit('pagechanged', this.totalPages)
        }
    }
})

在调用pagination组件时，将totalPages和total以及currentPage传到组件中：

<div id="app">
    <pagination :total-pages="11" :total="120" :current-page="currentPage"></pagination>
</div>

let app = new Vue({
    el: '#app',
    data () {
        return {
            currentPage: 2
        }
    }
})

运行上面的代码，将会报错：

不难发现，在pagination组件中，咱们还少了pages。从前面介绍的内容，我们不难发现，需要计算出pages的值。

Vue.component('pagination', {
    template: '#pagination',
    props: {
        maxVisibleButtons: {
            type: Number,
            required: false,
            default: 3
        },
        totalPages: {
            type: Number,
            required: true
        },
        total: {
            type: Number,
            required: true
        },
        currentPage: {
            type: Number,
            required: true
        }
    },
    computed: {
        isInFirstPage: function () {
            return this.currentPage === 1
        },
        isInLastPage: function () {
            return this.currentPage === this.totalPages
        },
        startPage: function () {
            if (this.currentPage === 1) {
                return 1
            }
            if (this.currentPage === this.totalPages) {
                return this.totalPages - this.maxVisibleButtons + 1
            }
            return this.currentPage - 1
        },
        endPage: function () {
            return Math.min(this.startPage + this.maxVisibleButtons - 1, this.totalPages)
        },
        pages: function () {
            const range = []
            for (let i = this.startPage; i <= this.endPage; i+=1) {
                range.push({
                    name: i,
                    isDisabled: i === this.currentPage
                })
            }
            return range
        }
    },
    methods: {
        onClickFirstPage: function () {
            this.$emit('pagechanged', 1)
        },
        onClickPreviousPage: function () {
            this.$emit('pagechanged', this.currentPage - 1)
        },
        onClickPage: function (page) {
            this.$emit('pagechanged', page)
        },
        onClickNextPage: function () {
            this.$emit('pagechanged', this.currentPage + 1)
        },
        onClickLastPage: function () {
            this.$emit('pagechanged', this.totalPages)
        }
    }
})

这个时候得到的结果不再报错，你在浏览器中将看到下图这样的效果：

添加样式

现在我们的组件实现了最初想要的所有功能，而且添加了一些样式，让它看起来更像一个分页组件，而不仅像是一个列表。

我们还希望用户能够清楚地识别他们所在的页面。让我们改变表示当前页面的按钮的颜色。

为此，我们可以使用对象语法将HTML类绑定到当前页面按钮上。当使用对象语法绑定类名时，Vue将在值发生变化时自动切换类。

虽然v-for中的每个块都可以访问父作用域范围，但是我们将使用method来检查页面是否处于active状态，以便保持我们的templage干净。

Vue.component('pagination', {
    template: '#pagination',
    props: {
        maxVisibleButtons: {
            type: Number,
            required: false,
            default: 3
        },
        totalPages: {
            type: Number,
            required: true
        },
        total: {
            type: Number,
            required: true
        },
        currentPage: {
            type: Number,
            required: true
        }
    },
    computed: {
        isInFirstPage: function () {
            return this.currentPage === 1
        },
        isInLastPage: function () {
            return this.currentPage === this.totalPages
        },
        startPage: function () {
            if (this.currentPage === 1) {
                return 1
            }
            if (this.currentPage === this.totalPages) {
                return this.totalPages - this.maxVisibleButtons + 1
            }
            return this.currentPage - 1
        },
        endPage: function () {
            return Math.min(this.startPage + this.maxVisibleButtons - 1, this.totalPages)
        },
        pages: function () {
            const range = []
            for (let i = this.startPage; i <= this.endPage; i+=1) {
                range.push({
                    name: i,
                    isDisabled: i === this.currentPage
                })
            }
            return range
        }
    },
    methods: {
        onClickFirstPage: function () {
            this.$emit('pagechanged', 1)
        },
        onClickPreviousPage: function () {
            this.$emit('pagechanged', this.currentPage - 1)
        },
        onClickPage: function (page) {
            this.$emit('pagechanged', page)
        },
        onClickNextPage: function () {
            this.$emit('pagechanged', this.currentPage + 1)
        },
        onClickLastPage: function () {
            this.$emit('pagechanged', this.totalPages)
        },
        isPageActive: function (page) {
            return this.currentPage === page;
        }
    }
})

接下来，在pages中添加当前状态：

<li v-for="page in pages">
    <button type="button" @click="onClickPage(page.name)" :disabled="page.isDisabled" :class="{active: isPageActive(page.name)}"> {{ page.name }}</button>
</li>

这个时候你看到效果如下：

但依然还存在一点点小问题，当你在点击别的按钮时，active状态并不会随着切换：

继续添加代码改变其中的效果：

let app = new Vue({
    el: '#app',
    data () {
        return {
            currentPage: 2
        }
    },
    methods: {
        onPageChange: function (page) {
            console.log(page)
            this.currentPage = page;
        }
    }
})

在调用组件时：

<div id="app">
    <pagination :total-pages="11" :total="120" :current-page="currentPage" @pagechanged="onPageChange"></pagination>
</div>

这个时候的效果如下了：

到这里，基本上实现了咱想要的分页组件效果。

无障碍化处理

熟悉Bootstrap的同学都应该知道，Bootstrap中的组件都做了无障碍化的处理，就是在组件中添加了WAI-ARIA相关的设计。比如在分页按钮上添加aria-label相关属性：

在我们这个组件中，也相应的添加有关于WAI-ARIA相关的处理：

<template id="pagination">
    <ul class="pagination" aria-label="Page navigation">
        <li>
            <button type="button" @click="onClickFirstPage" :disabled="isInFirstPage" aria-label="Go to the first page">« First</button>
        </li>
        <li>
            <button type="button" @click="onClickPreviousPage" :disabled="isInFirstPage" aria-label="Previous">«</button>
        </li>
        <li v-for="page in pages">
            <button type="button" @click="onClickPage(page.name)" :disabled="page.isDisabled" :aria-label="`Go to page number ${page.name}`"> {{ page.name }}</button>
        </li>
        <li>
            <button type="button" @click="onClickNextPage" :disabled="isInLastPage" aria-label="Next">Next »</button>
        </li>
        <li>
            <button type="button" @click="onClickLastPage" :disabled="isInLastPage" aria-label="Go to the last page">»</button>
        </li>
    </ul>
</template>

这样有关于aria相关的属性就加上了：

最终的效果如下：

总结

这篇文章主要介绍了怎么使用Vue创建一个动态分页组件。分页组件应该允许用户访问第一个和最后一个页面，向前和向后移动，并直接切换到近距离的页面。希望你会喜欢。

大漠

常用昵称“大漠”，W3CPlus创始人，目前就职于手淘。对HTML5、CSS3和Sass等前端脚本语言有非常深入的认识和丰富的实践经验，尤其专注对CSS3的研究，是国内最早研究和使用CSS3技术的一批人。CSS3、Sass和Drupal中国布道者。2014年出版《图解CSS3：核心技术与案例实战》。

如需转载，烦请注明出处：https://www.w3cplus.com/vue/create-pagination-component.htmlAir Jordan 3 For Women-024

返回顶部