Skip to content

xtf-pagination ​

组件说明 ​

xtf-pagination 是分页器,用于切换页码并控制前后翻页。当前实现读取 pageSizeOptions 数据、通过 input 等事件反馈交互。

  • 实际 Demo 路由:#/pages/components/xtf-pagination/index
  • Demo 源码

基础用法 ​

1. 最小可用 ​

提供能够直接看到或操作组件的最少业务内容。

vue
<template>
  <view class="doc-minimum">
    <XtfPagination :total="120" />
  </view>
</template>

<script setup lang="uts">
import XtfPagination from "@/uni_modules/xtf-linkuiunix/components/xtf-pagination/xtf-pagination.uvue"

</script>

<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>

2. 核心数据与主要事件 ​

使用组件真实数据入口,并记录当前源码声明的主要事件。

vue
<template>
  <view class="doc-core">
    <XtfPagination :total="120" :page-size-options="fixture" @input="onPrimaryEvent" />
  </view>
</template>

<script setup lang="uts">
import XtfPagination from "@/uni_modules/xtf-linkuiunix/components/xtf-pagination/xtf-pagination.uvue"

const fixture = [10, 20, 50] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-pagination:input", payload) }
</script>

<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>

3. 动态 disabled 状态 ​

运行时切换 disabled,观察组件对应状态变化。

vue
<template>
  <view class="doc-dynamic">
    <XtfPagination :total="120" :disabled="state" />
    <button class="doc-action-button" @click="toggleState">切换 disabled</button>
    <text class="doc-state-text">disabled: {{ state }}</text>
  </view>
</template>

<script setup lang="uts">
import XtfPagination from "@/uni_modules/xtf-linkuiunix/components/xtf-pagination/xtf-pagination.uvue"

import { ref } from "vue"

const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("disabled", state.value) }
</script>

<style>
.doc-dynamic { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
.doc-state-text { margin-top: 12rpx; color: #475569; font-size: 24rpx; }
</style>

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
modelValuestring | numberundefined参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 35需要覆盖组件默认业务值时设置。
valuestring | numberundefined参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 35需要覆盖组件默认业务值时设置。
currentstring | number1提供当前受控状态;是否回写以事件表为准;消费位置:script 行 35需要覆盖组件默认业务值时设置。
pageSizestring | number10设置对应元素尺寸;消费位置:script 行 32需要调整布局或视觉表现时设置。
totalstring | number0参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 33需要覆盖组件默认业务值时设置。
pageCountstring | number0参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 34需要覆盖组件默认业务值时设置。
pageSizeOptionsany[]() => [10, 20, 50]提供组件渲染或选择使用的数据集合;消费位置:script 行 37数据驱动或选项渲染场景。
modestring'full'参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 55、template 行 5、template 行 15、template 行 25需要覆盖组件默认业务值时设置。
prevTextstring''设置对应区域的显示文案;消费位置:template 行 4需要提供业务文案或图标内容时设置。
nextTextstring''设置对应区域的显示文案;消费位置:template 行 17需要提供业务文案或图标内容时设置。
showJumperbooleanfalse开关对应显示或交互行为;消费位置:template 行 19需要控制显示、可用性或交互状态时设置。
showPageListbooleanfalse开关对应显示或交互行为;消费位置:template 行 5数据驱动或选项渲染场景。
showTotalbooleantrue开关对应显示或交互行为;消费位置:template 行 15需要控制显示、可用性或交互状态时设置。
pageButtonCountstring | number5参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 40需要覆盖组件默认业务值时设置。
pageStyleany''覆盖或追加对应内部区域的样式对象;消费位置:script 行 80需要调整布局或视觉表现时设置。
activePageStyleany''覆盖或追加对应内部区域的样式对象;消费位置:script 行 80需要调整布局或视觉表现时设置。
pageShapestring'rounded'参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 69需要覆盖组件默认业务值时设置。
variantstring'default'参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 53、script 行 64需要调整布局或视觉表现时设置。
disabledbooleanfalse参与组件运行逻辑;源码在 10 处读取该值;消费位置:script 行 94、script 行 99、script 行 119、template 行 2需要控制显示、可用性或交互状态时设置。
customClassstring''参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2需要调整布局或视觉表现时设置。
customStyleany''参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
inputnotify 内触发(script 行 87);参数表达式:page(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:modelValuenotify 内触发(script 行 88);参数表达式:page(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:valuenotify 内触发(script 行 89);参数表达式:page(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:currentnotify 内触发(script 行 90);参数表达式:page(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:pageSizechangeSize 内触发(script 行 101);参数表达式:size;前置 guard:props.disabled || !Number.isFinite(size) || size < 1 || size === pageSize.value(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
changenotify 内触发(script 行 91);参数表达式:{ current: page, pageSize: size }(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
page-size-changechangeSize 内触发(script 行 102);参数表达式:{ current: 1, pageSize: size };前置 guard:props.disabled || !Number.isFinite(size) || size < 1 || size === pageSize.value
setup 内触发(script 行 112);参数表达式:{ current: 1, pageSize: pageSize.value }
(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。

插槽 ​

插槽Scope 参数实际渲染位置
--当前模板没有公开 slot。

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
--当前组件没有公开实例方法。

公开状态 ​

状态类型 / 包装读取边界
--当前组件没有公开状态。

主题说明 ​

  • 当前组件 CSS 未读取 var(--xtf-*) 主题变量;颜色或尺寸可能来自 props、固定样式或父级上下文。

平台与实现边界 ​

  • 基线为 HBuilderX 5.26+ 与 uni-app x;当前报告已验证 Web Chromium 的对应 Demo,不据此承诺 Safari、小程序或 App 原生端等价。
  • Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力,只有源码或完整性报告明确覆盖的部分才可视为已验证。
  • 本文按当前源码生成,不补入旧版 xtf-linkui 存在但迁移版未实现的 props、事件、slot 或方法。
  • 详细公共边界见 平台与实现边界,逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。

MIT Licensed