Skip to content

F4RAN/vue-pagin8

Repository files navigation

Vue Pagin8

telegram-cloud-photo-size-4-6023883429155814448-m telegram-cloud-photo-size-4-6023883429155814449-m telegram-cloud-photo-size-4-6023883429155814450-m telegram-cloud-photo-size-4-6023883429155814451-m telegram-cloud-photo-size-4-6023883429155814452-m telegram-cloud-photo-size-4-6023883429155814453-m telegram-cloud-photo-size-4-6023883429155814454-m telegram-cloud-photo-size-4-6026135228969500601-m

Simple and beautiful Vue 2 pagination component (Vue 3 Here)

This pagination component can be used by client which changes the page with arrows or input

this project will be completed with new features and more styles in the future.

you can contribute in this project using the github repository.

Installation

for install vue-pagin8 you must run the following command in your command-line:

npm install vue-pagin8

Demo

You can see demo Here

Import Component-level

You should just import the component and use it.

<template>
  <div>
    <!-- Your Other Codes -->
    <!-- When triggering currentPage event, you should call your backend api to get $event page that shows the selected page by client -->
    <Paginate 
    :initPage="1" 
    :totalPages="totalPage" 
    @currentPage="callApiToGetOtherPage($event)"
    :color="red"
    >
    </Paginate>

    <!-- Your Other Codes -->
  </div>
</template>

<script>
import Paginate from "vue-pagin8";

export default {
data(){
    return{
        initPage:1,
        totalPages:1, // From backend
    }
}
// Your Other Codes
  components: {
    Paginate,
  },
// Your Other Codes
};
</script>

Import Globally

You should just import vue-pagin8 on main.js file in root directory of your project:

import Vue from 'vue'
// Your other imports
import Paginate from 'vue-pagin8'
// ...
Vue.component('Paginate', Paginate)
// ...

Props and Events

Props:

Property Usage Accepted Value
:initPage Pagination starts with which page 1,2,3,..
:totalPages How many pages exist in your document
that you are paginating
1,2,3,..
:color Your selected color depends on your UI 'green','red','orange','blue',
'gray','purple','dark'

Events:

Event Usage Parameters
@currentPage This event has been triggered
when client changes the page number
after it's been triggered you must
pass the $event value to the client
@currentPage(yourApiCall($event))
$event shows the page that client selected.
reset This event is used in specific cases, when you want to use component in a single page and reset it when v-if changes, you must define ref property (<Paginate ref="pagin8" />) for component and access to the function with it. (this.$refs.pagin8.reset()) in script part or ($refs.pagin8.reset()) in html null

About

A minimal vue pagination component, simple usage in many colors

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors