Skip to content

Pagination 分頁

分頁組件用於將大量數據分頁顯示,並提供頁面導航功能。

基本用法

基本的分頁組件用法,設置總項目數和每頁項目數。

當前頁數: 1

自定義設定

可以通過 sibling-count 屬性控制當前頁面附近顯示的頁碼數量,通過 show-edges 控制是否顯示首末頁按鈕。

當前頁數: 5

帶資訊顯示

使用 info 插槽可以顯示當前分頁的詳細資訊。

當前頁數: 3

按鈕尺寸

通過 size 屬性可以設置分頁按鈕的尺寸大小,支援 smalldefaultlarge 三種尺寸。

小尺寸 (Small)

當前頁數: 1

默認尺寸 (Default)

當前頁數: 1

大尺寸 (Large)

當前頁數: 1

按鈕樣式變體

可以通過 textghostoutlineborderd 等屬性設置分頁按鈕的樣式變體。

不同樣式變體的分頁

Default (預設)

Text (文字按鈕)

Ghost (幽靈按鈕)

Outline (外框按鈕)

Bordered (帶邊框按鈕)

禁用狀態

設置 disabled 屬性可以禁用分頁組件。

當前頁數: 2

API

Props

屬性名類型預設值說明
modelValuenumber1當前頁數,支持 v-model
totalnumber總項目數量
pageSizenumber10每頁項目數量
siblingCountnumber2當前頁面附近顯示的頁碼數量
showEdgesbooleantrue是否顯示首頁和末頁按鈕
showPrevNextbooleantrue是否顯示上一頁下一頁按鈕
disabledbooleanfalse是否禁用
classstring自定義類名
textbooleanfalse文字按鈕樣式
ghostbooleanfalse幽靈按鈕樣式
outlinebooleanfalse外框按鈕樣式
borderdbooleanfalse帶邊框按鈕樣式
size'large' | 'default' | 'small''default'按鈕尺寸大小

Events

事件名參數說明
update:modelValue(page: number)頁數變更時觸發
change(page: number)頁數變更時觸發

Slots

插槽名參數說明
info{ current: number, total: number, pageSize: number, totalItems: number }自定義資訊顯示區域

響應式設計

組件在小螢幕設備上會自動隱藏首末頁按鈕和按鈕文字,只保留圖示以節省空間。

樣式自定義

組件提供了豐富的 CSS 類名供樣式自定義:

  • .sh-pagination - 分頁容器
  • .sh-pagination__list - 分頁按鈕列表
  • .sh-pagination__button - 分頁按鈕
  • .sh-pagination__button--active - 活動狀態按鈕
  • .sh-pagination__ellipsis - 省略號
  • .sh-pagination__info - 資訊顯示區域

Released under the MIT License.