0.3.0 • Published 3 years ago

advanced-laravel-vue-paginate v0.3.0

Weekly downloads
106
License
MIT
Repository
github
Last release
3 years ago

npm Downloads

Advanced-Laravel-Vue-Paginate

A advanced, smart, highly customizable vue pagination component for Laravel Pagination

Demo & Playground

See https://shibbirweb.github.io/advanced-laravel-vue-paginate

Requirements

Install

npm install advanced-laravel-vue-paginate --save

Usage

Register the component:

// register as a global Vue component
import 'advanced-laravel-vue-paginate/dist/advanced-laravel-vue-paginate.css'
Vue.use(require('advanced-laravel-vue-paginate'));

// or, import as a single Vue component
import AdvancedLaravelVuePaginate from 'advanced-laravel-vue-paginate';
import 'advanced-laravel-vue-paginate/dist/advanced-laravel-vue-paginate.css'

// register in vue component
export default {
	components: {
		AdvancedLaravelVuePaginate
	}
}

Use the component:

<ul>
    <li v-for="post in laravelData.data" :key="post.id">{{ post.title }}</li>
</ul>

<advanced-laravel-vue-paginate :data="laravelData" @paginateTo="getResults"/>
export default {

	data() {
		return {
			// Our data object that holds the Laravel paginator data
			laravelData: {},
		}
	},
	mounted() {
		// Fetch initial results
		this.getResults();
	},
	methods: {
		// Our method to GET results from a Laravel endpoint
		getResults(page = 1) {
			axios.get('example/results?page=' + page)
				.then(response => {
					this.laravelData = response.data;
				});
		}
	}
}

API

Props

NameTypeParameterDefaultDescription
dataObject (required)Laravel paginate default objectAn object containing the structure of a Laravel paginator response.
onEachSideNumber (optional)Any Integer number3Number of page number show each side of current page. Any negative value show all page links.
showNextPrevBoolean (optional)truefalsetrueShow next/previous button. true for show Next/Previous button and false for hide next/previous button
dotsString (optional)Any String value...Symbol for hidden page numbers
previousTextString (optional)Any String valuePreviousText for previous button
nextTextString (optional)Any String valueNextText for next button
useStyleString (optional)defaultbootstrapcustomdefaultdefault for default component style.bootstrap for bootstrap style (required Bootstrap).custom for custom style. Use below props to style as you want.
alignmentString (optional)nullleftcenterrightnullCustom alignment of pagination. null for default style, left for align to left, center for align to center, right for align to right
activeClassString (optional)Any String valueactiveClass for current pagination page
activeClassInString (optional)lialiActive class placement
listClassString (optional)Any String valuepaginationList (ul) class
listItemClassString (optional)Any String valuepage-itemClass for List item (li)
contentAlignClassString (optional)Any String valuejustify-content-centerContent align class
linkClassString (optional)Any String valuepage-linkAnchor link (a) class
disableClassString (optional)Any String valuedisabledDisable class name
disableClassInString (optional)lialiDisable class placement
autoHidePaginateBoolean (optional)truefalsetrueAuto hide paginator if has not more than one page

###Events |Name|Return | Description| |:---:|:---:|---| |paginateTo| Number | Invoked when user click on a pagination link and return clicked page number|


For Development

Project setup

npm install

Compiles and hot-reloads for development

npm run serve
0.3.0

3 years ago

0.2.0

3 years ago

0.1.9

4 years ago

0.1.8

4 years ago

0.1.7

4 years ago

0.1.6

4 years ago

0.1.5

4 years ago

0.1.4

4 years ago

0.1.3

4 years ago

0.1.2

4 years ago

0.1.1

4 years ago

0.1.0

4 years ago