# vue3-bootstrap-paginate

> #### Vue3 Bootstrap Paginate is a paging library for VueJS that uses bootstrap's style.

Latest version **1.0.0** (published 2022-12-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue3-bootstrap-paginate
pnpm add vue3-bootstrap-paginate
yarn add vue3-bootstrap-paginate
bun add vue3-bootstrap-paginate
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-12-17 |
| First published | 2022-12-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 21.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | ndtpro |
| Keywords | vue3-bootstrap-paginate, vue, paginate, nuxt, pagination, vue-pagination, vue bootstrap paginate, nuxt.js 3, vue.js 3, vue pagination, vue pagination component, vue pagination module, vue paginate, vue pagination, vue.js paginate, vue.js pagination |

## Links

- npm: https://www.npmjs.com/package/vue3-bootstrap-paginate
- Repository: https://github.com/ndt-pro/vue3-bootstrap-paginate
- Issues: https://github.com/ndt-pro/vue3-bootstrap-paginate/issues
- npm.io page: https://npm.io/package/vue3-bootstrap-paginate

## Dependencies (1)

- [vue](https://npm.io/package/vue.md) ^3.2.41

## Alternatives

- [@sveltejs/kit](https://npm.io/package/@sveltejs/kit.md) — 2.2M weekly downloads
- [@atlaskit/theme](https://npm.io/package/@atlaskit/theme.md) — 402.0K weekly downloads
- [@tangle-network/brand](https://npm.io/package/@tangle-network/brand.md) — 10.0K weekly downloads
- [seneca](https://npm.io/package/seneca.md) — 7.4K weekly downloads
- [@bsb/base](https://npm.io/package/@bsb/base.md) — 7.2K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2022-12-17

## README

# Vue3 Bootstrap Paginate

#### Vue3 Bootstrap Paginate is a paging library for VueJS that uses bootstrap's style.

![With Bootstrap 3](https://res.cloudinary.com/ndtpro/image/upload/v1671209654/projects/github/vue3-bootstrap-paginate-3_w0l4th.png)

![With Bootstrap 4,5](https://res.cloudinary.com/ndtpro/image/upload/v1671209654/projects/github/vue3-bootstrap-paginate-45_ylnw7p.png)


[![ndt-pro - vue3-bootstrap-paginate](https://img.shields.io/static/v1?label=ndt-pro&message=vue3-bootstrap-paginate&color=yellow&logo=github)](https://github.com/ndt-pro/vue3-bootstrap-paginate "Go to GitHub repo")
[![npm version](https://img.shields.io/npm/v/vue3-bootstrap-paginate.svg)](http://badge.fury.io/js/vue3-bootstrap-paginate) [![npm downloads](https://img.shields.io/npm/dm/vue3-bootstrap-paginate.svg)](http://badge.fury.io/js/vue3-bootstrap-paginate) [![License](https://img.shields.io/badge/License-MIT-blue)](https://github.com/ndt-pro/vue3-bootstrap-paginate/blob/main/LICENSE)

---

## :cd: Installation

-   npm: `npm i vue3-bootstrap-paginate`

## Usage

You can import and register the component globally in your main.js, or import and use it in a particular component.

**Vue2: To register in your `main.js`**

```javascript
import Vue from 'vue';
// Import the component
import { Vue3BsPaginate } from 'vue3-bootstrap-paginate';

// Register the component globally
Vue.component('Vue3BsPaginate', Vue3BsPaginate);
```

**Vue3: To register in your `main.js`**

```javascript
import { createApp } from 'vue';

// Import the component
import { Vue3BsPaginate } from 'vue3-bootstrap-paginate';

const app = createApp({});

// Register the component globally
app.component('Vue3BsPaginate', Vue3BsPaginate);
```

**To register in your component**

```vue
<script>
	import Vue3BsPaginate from 'vue3-bootstrap-paginate';
	export default {
		components: { Vue3BsPaginate },
	};
</script>
```

**Using in your `.vue` file**

```vue
<template>
	<Vue3BsPaginate
		:total="150"
		v-model="currentPage"
		:perPage="10"
		:onChange="onChangePage"
		alignment="center"
	/>
</template>
```

## API

### Props

| Prop | Type | Default | Options | Description |
| ------ | ------ | ------ | ------ | ------ |
| total | Number | required | | Total number of items that you want to paginate |
| perPage | Number | 10 | | Total number of items that you explicitly want to show per one page |
| pagesShown | Number | 5 | | Maximum pagination page to be shown |
| v-model | Number | required | | Current active page |
| size | String | 'md' | 'lg','sm' | Size of button according to bootstrap |
| alignment | String | 'start' | 'center','end' | Align the position of the pagination |
| prevContent | String | '‹' | | Content of previous button |
| nextContent | String | '›' | | Content of next button |
| firstJumpContent | String | '«' | | Content of jump to first button |
| lastJumpContent | String | '»' | | Content of jump to last button |
| showPrevNextButton | Boolean | true | | Show previous and next button |
| showJumpButtons | Boolean | false | | Show jump to first and last button |
| onChange | Function | () => { } | | A function that runs when the user changes a page by clicking any of the elements of the component (Passing the new active page to the function as a parameter) |

## Project setup

### Install dependencies

-   npm: `npm install`

### Start Dev Server

-   npm: `npm run serve`

### Compiles and minifies for production

-   npm: `npm run build`

---
_Source: https://npm.io/package/vue3-bootstrap-paginate · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._