ss-paging-vue
v3.0.0-beta.3
Published
SSPaging: A Full Server-side pagination library for Vue.js
Downloads
10
Readme
SSPaging
SSPaging is a server-side (or a low-level) pagination library for Vue.js. The name was taken from Smartscore Pagination which was a part from past project of SSPaging creator. SSPaging provides sets of ready-to-use functions and properties to create pagination. SSPaging provides some built-in components you can use in your project, but you can also learn how to create your own with the provided examples
Installation
SSPaging can be installed using NPM:
npm install ss-paging-vue
Breaking Changes in v3.x
In v3.x, SSPaging shares the same codebase for both Composition API and Pinia version. This change affects the way accessing the state. For example, in v2.x you can directly access SSPaging state with paging.rows
in Pinia version, while in v3.x you should replace it with paging.state.rows
.
Basic Usage
After it is installed, you can import the composables or Pinia version of SSPaging (choose one depend on your need!).
import { usePaging, usePagingStore } from 'ss-paging-vue'
// in composables mode
const paging = usePaging()
// in Pinia mode
const paging = usePagingStore()
For use without build tool, you can include SSPaging via CDN:
<script src="https://unpkg.com/ss-paging-vue@latest/dist/ss-paging.dist.js"></script>
// in your JS file
const paging = SSPaging.usePaging()
Documentation
For complete documentation, please refer to SSPaging Official Documentation instead.
Contribution
Just create a pull request if you want to add features or fix bugs.