vue-selectpage
Version:
SelectPage for Vue, a select items components provides the list of items with pagination
186 lines (143 loc) • 5.34 kB
Markdown
<a href="https://terryz.github.io/vue/#/selectpage" target="_blank">
<img src="https://terryz.github.io/image/v-selectpage/v3/selectpage-list-multiple.png" alt="SelectPage" align="right" valign="top" >
</a>
# [v-selectpage](https://terryz.github.io/vue/#/selectpage)
[](https://dl.circleci.com/status-badge/redirect/gh/TerryZ/v-selectpage/tree/master) [](https://codecov.io/gh/TerryZ/v-selectpage) [](https://www.npmjs.com/package/v-selectpage)
SelectPage for Vue3, a select items components provides the list of items with pagination
[](https://opencollective.com/v-selectpage)
[](https://standardjs.com)
[](https://www.npmjs.com/package/v-selectpage)
If you are using vue `2.x` version, please use [v-selectpage 2.x](https://github.com/TerryZ/v-selectpage/tree/dev-vue-2) version instead
<br><br><br><br><br><br><br><br>
## Examples and Documentation
Documentation and examples please visit below sites
- [github-pages](https://terryz.github.io/docs-vue3/selectpage/)
The jQuery version: [SelectPage](https://github.com/TerryZ/SelectPage)
## Features
- Display contents with pagination
- I18n support
- Select single / multiple options
- Tags form for multiple selection
- Keyboard navigation
- Searchable
- Provide display forms such as list view and table view
- Customization of row / cell content rendering
- Core module that can be used independently
I18n support languages
<!-- Chinese Simplified • English • Japanese • Arabic • Spanish • German • Romanian • French • Portuguese-Brazil • Polish • Dutch • Chinese Traditional • Russian • Turkish -->
- Chinese Simplified
- English
- Japanese
- Arabic
- Spanish
- German
- Romanian
- French
- Portuguese-Brazil
- Polish
- Dutch
- Chinese Traditional
- Russian
- Turkish
## Installation
[](https://www.npmjs.com/package/v-selectpage)
Install `v-selectpage` to your project
``` bash
# npm
npm i v-selectpage
# yarn
yarn add v-selectpage
# pnpm
pnpm add v-selectpage
```
## Usage
Quick start example
```vue
<template>
<SelectPageList
key-prop="id"
label-prop="name"
@fetch-data="fetchData"
/>
</template>
<script setup lang="ts">
import { SelectPageList } from 'v-selectpage'
import type { PageParameters, FetchDataCallback } from 'v-selectpage'
function fetchData (data: PageParameters, callback: FetchDataCallback) {
// pagination information and search keyword
const { search, pageNumber, pageSize } = data
// request parameters
const parameters = {
search,
pageNumber,
pageSize,
...
}
// fetch data list with pagination state
doDataRequest(parameters)
.then(resp => {
/**
* Return data format for example
* {
* list: object[], // current page data list
* total: number // result count
* }
*/
callback(resp.list, resp.total)
})
.catch(() => {
// clear the data list if necessary when request fails
callback([], 0)
})
}
</script>
```
Set default selected items
```vue
<template>
<SelectPageTable
language="zh-chs"
v-model="selected"
:multiple="true"
:columns="columns"
@fetch-data="fetchData"
@fetch-selected-data="fetchSelectedData"
/>
</template>
<script setup lang="ts">
import { ref } from 'vue'
import { SelectPageTable } from 'v-selectpage'
import type {
SelectPageKey, FetchSelectedDataCallback,
PageParameters, FetchDataCallback, SelectPageTableColumn
} from 'v-selectpage'
const selected = ref<SelectPageKey[]>([2, 4, 7])
const columns: SelectPageTableColumn[] = [
{ title: 'Id', data: 'id' },
{ title: 'Team name', data: row => `${row.abbr} - ${row.name}`, width: 250 },
{ title: 'Description', data: 'desc' }
]
// fetch current page data
function fetchData (data: PageParameters, callback: FetchDataCallback) {
...
}
// fetch selected items data
function fetchSelectedData (keys: SelectPageKey[], callback: FetchSelectedDataCallback) {
// get data models by keys
doDataRequest({ keys }).then(resp => {
callback(resp)
})
}
</script>
```
## Plugin preview
List view for Single selection
List view for multiple selection with tags form
Table view for single selection
## Dependencies
- [v-dropdown](https://github.com/TerryZ/v-dropdown) - The dropdown container
## License
[](https://mit-license.org/)