Appearance
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 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
modelValue | string | number | undefined | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 35 | 需要覆盖组件默认业务值时设置。 |
value | string | number | undefined | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 35 | 需要覆盖组件默认业务值时设置。 |
current | string | number | 1 | 提供当前受控状态;是否回写以事件表为准;消费位置:script 行 35 | 需要覆盖组件默认业务值时设置。 |
pageSize | string | number | 10 | 设置对应元素尺寸;消费位置:script 行 32 | 需要调整布局或视觉表现时设置。 |
total | string | number | 0 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 33 | 需要覆盖组件默认业务值时设置。 |
pageCount | string | number | 0 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 34 | 需要覆盖组件默认业务值时设置。 |
pageSizeOptions | any[] | () => [10, 20, 50] | 提供组件渲染或选择使用的数据集合;消费位置:script 行 37 | 数据驱动或选项渲染场景。 |
mode | string | 'full' | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 55、template 行 5、template 行 15、template 行 25 | 需要覆盖组件默认业务值时设置。 |
prevText | string | '' | 设置对应区域的显示文案;消费位置:template 行 4 | 需要提供业务文案或图标内容时设置。 |
nextText | string | '' | 设置对应区域的显示文案;消费位置:template 行 17 | 需要提供业务文案或图标内容时设置。 |
showJumper | boolean | false | 开关对应显示或交互行为;消费位置:template 行 19 | 需要控制显示、可用性或交互状态时设置。 |
showPageList | boolean | false | 开关对应显示或交互行为;消费位置:template 行 5 | 数据驱动或选项渲染场景。 |
showTotal | boolean | true | 开关对应显示或交互行为;消费位置:template 行 15 | 需要控制显示、可用性或交互状态时设置。 |
pageButtonCount | string | number | 5 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 40 | 需要覆盖组件默认业务值时设置。 |
pageStyle | any | '' | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 80 | 需要调整布局或视觉表现时设置。 |
activePageStyle | any | '' | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 80 | 需要调整布局或视觉表现时设置。 |
pageShape | string | 'rounded' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 69 | 需要覆盖组件默认业务值时设置。 |
variant | string | 'default' | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 53、script 行 64 | 需要调整布局或视觉表现时设置。 |
disabled | boolean | false | 参与组件运行逻辑;源码在 10 处读取该值;消费位置:script 行 94、script 行 99、script 行 119、template 行 2 | 需要控制显示、可用性或交互状态时设置。 |
customClass | string | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
customStyle | any | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
input | notify 内触发(script 行 87);参数表达式:page | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:modelValue | notify 内触发(script 行 88);参数表达式:page | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:value | notify 内触发(script 行 89);参数表达式:page | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:current | notify 内触发(script 行 90);参数表达式:page | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:pageSize | changeSize 内触发(script 行 101);参数表达式:size;前置 guard:props.disabled || !Number.isFinite(size) || size < 1 || size === pageSize.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
change | notify 内触发(script 行 91);参数表达式:{ current: page, pageSize: size } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
page-size-change | changeSize 内触发(script 行 102);参数表达式:{ current: 1, pageSize: size };前置 guard:props.disabled || !Number.isFinite(size) || size < 1 || size === pageSize.valuesetup 内触发(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。