Appearance
xtf-grid
组件说明
xtf-grid 是宫格，用于以数据或子组件方式排列功能入口。当前实现读取 items 数据、通过 click 等事件反馈交互。
- 实际 Demo 路由：
#/pages/components/xtf-grid/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfGrid :items="fixture" />
</view>
</template>
<script setup lang="uts">
import XtfGrid from "@/uni_modules/xtf-linkuiunix/components/xtf-grid/xtf-grid.uvue"
const fixture = [{ key: 'bill', title: '账单', icon: 'receipt_long', desc: '本月明细', clickable: true }, { key: 'stats', title: '统计', icon: 'bar_chart', desc: '分类趋势', clickable: true }] as Array<any>
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口，并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfGrid :items="fixture" :clickable="true" :columns="2" @click="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfGrid from "@/uni_modules/xtf-linkuiunix/components/xtf-grid/xtf-grid.uvue"
const fixture = [{ key: 'bill', title: '账单', icon: 'receipt_long', desc: '本月明细', clickable: true }, { key: 'stats', title: '统计', icon: 'bar_chart', desc: '分类趋势', clickable: true }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-grid:click", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 border 状态
运行时切换 border，观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfGrid :items="fixture" :border="state" />
<button class="doc-action-button" @click="toggleState">切换 border</button>
<text class="doc-state-text">border: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfGrid from "@/uni_modules/xtf-linkuiunix/components/xtf-grid/xtf-grid.uvue"
import { ref } from "vue"
const fixture = [{ key: 'bill', title: '账单', icon: 'receipt_long', desc: '本月明细', clickable: true }, { key: 'stats', title: '统计', icon: 'bar_chart', desc: '分类趋势', clickable: true }] as Array<any>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("border", 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>4. 定制 section 插槽
使用源码真实声明的 section slot 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfGrid :items="fixture" section-title="常用功能">
<template #section><text class="doc-content-text">自定义 section 内容</text></template>
</XtfGrid>
</view>
</template>
<script setup lang="uts">
import XtfGrid from "@/uni_modules/xtf-linkuiunix/components/xtf-grid/xtf-grid.uvue"
const fixture = [{ key: 'bill', title: '账单', icon: 'receipt_long', desc: '本月明细', clickable: true }, { key: 'stats', title: '统计', icon: 'bar_chart', desc: '分类趋势', clickable: true }] as Array<any>
</script>
<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
items | XtfGridItemData[] | () => [] as XtfGridItemData[] | 参与组件运行逻辑；源码在 5 处读取该值；消费位置：script 行 26、script 行 29、script 行 68、template 行 4 | 数据驱动或选项渲染场景。 |
columns | number | 3 | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 23 | 数据驱动或选项渲染场景。 |
gap | number | 20 | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 30 | 需要覆盖组件默认业务值时设置。 |
rowGap | number | -1 | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 30 | 需要调整布局或视觉表现时设置。 |
columnGap | number | -1 | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 30 | 需要调整布局或视觉表现时设置。 |
padding | number | 0 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 24 | 需要覆盖组件默认业务值时设置。 |
itemPadding | number | 24 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 41 | 需要覆盖组件默认业务值时设置。 |
itemRadius | number | 20 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 42 | 需要调整布局或视觉表现时设置。 |
itemMinHeight | number | 0 | 设置对应区域高度；消费位置：script 行 43 | 需要调整布局或视觉表现时设置。 |
iconSize | string | number | "lg" | 设置对应元素尺寸；消费位置：index.uts 行 114 | 需要调整布局或视觉表现时设置。 |
mediaWidth | string | number | 0 | 设置对应区域宽度；消费位置：index.uts 行 100 | 需要调整布局或视觉表现时设置。 |
mediaHeight | string | number | 0 | 设置对应区域高度；消费位置：index.uts 行 101 | 需要调整布局或视觉表现时设置。 |
mediaRadius | string | number | 16 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：index.uts 行 102 | 需要调整布局或视觉表现时设置。 |
imageWidth | string | number | 0 | 设置对应区域宽度；消费位置：index.uts 行 116 | 需要调整布局或视觉表现时设置。 |
imageHeight | string | number | 0 | 设置对应区域高度；消费位置：index.uts 行 117 | 需要调整布局或视觉表现时设置。 |
imageRadius | string | number | -1 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：index.uts 行 118 | 需要调整布局或视觉表现时设置。 |
imageMode | string | "aspectFill" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：index.uts 行 119 | 需要覆盖组件默认业务值时设置。 |
titleSize | string | number | "" | 设置对应元素尺寸；消费位置：index.uts 行 124 | 需要调整布局或视觉表现时设置。 |
descSize | string | number | "" | 设置对应元素尺寸；消费位置：index.uts 行 125 | 需要调整布局或视觉表现时设置。 |
titleColor | string | "" | 设置对应区域的颜色；消费位置：index.uts 行 124 | 需要调整布局或视觉表现时设置。 |
descColor | string | "" | 设置对应区域的颜色；消费位置：index.uts 行 125 | 需要调整布局或视觉表现时设置。 |
spacing | string | number | 12 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：index.uts 行 106 | 需要覆盖组件默认业务值时设置。 |
align | string | "center" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：index.uts 行 104 | 需要调整布局或视觉表现时设置。 |
contentAlign | string | "center" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 44、script 行 69、index.uts 行 103 | 需要覆盖组件默认业务值时设置。 |
sectionTitle | string | "" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：template 行 3 | 需要提供业务文案或图标内容时设置。 |
sectionDesc | string | "" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：template 行 3 | 需要覆盖组件默认业务值时设置。 |
theme | string | "primary" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：index.uts 行 115 | 需要调整布局或视觉表现时设置。 |
variant | string | "soft" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 31 | 需要调整布局或视觉表现时设置。 |
border | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 45 | 需要覆盖组件默认业务值时设置。 |
square | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 51 | 需要覆盖组件默认业务值时设置。 |
activeEffect | string | "scale" | 提供当前受控状态；是否回写以事件表为准；消费位置：script 行 53 | 需要覆盖组件默认业务值时设置。 |
activeScale | number | 0.96 | 提供当前受控状态；是否回写以事件表为准；消费位置：script 行 54 | 需要覆盖组件默认业务值时设置。 |
clickable | boolean | false | 开关对应显示或交互行为；消费位置：script 行 70、script 行 71 | 需要覆盖组件默认业务值时设置。 |
divider | boolean | false | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 52、script 行 58、script 行 59、script 行 61 | 需要覆盖组件默认业务值时设置。 |
dividerInset | number | 0 | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 63、script 行 67 | 需要覆盖组件默认业务值时设置。 |
dividerColor | string | "#dbe3ee" | 设置对应区域的颜色；消费位置：script 行 64、script 行 67 | 需要调整布局或视觉表现时设置。 |
emptyText | string | "暂无内容" | 设置对应区域的显示文案；消费位置：template 行 4 | 需要提供业务文案或图标内容时设置。 |
emptyDesc | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 4 | 需要覆盖组件默认业务值时设置。 |
emptyIcon | string | "grid_view" | 设置对应区域的图标名称；消费位置：template 行 4 | 需要提供业务文案或图标内容时设置。 |
cascade | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 113 | 需要覆盖组件默认业务值时设置。 |
cascadeStep | number | 60 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 113 | 需要覆盖组件默认业务值时设置。 |
layout | string | "header" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：index.uts 行 107 | 需要调整布局或视觉表现时设置。 |
customClass | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 5 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2 | 需要调整布局或视觉表现时设置。 |
XtfGridItemData 数据结构
| 字段 | 源码类型 | 字段语义 |
|---|---|---|
iconSize | string | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
iconTheme | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
theme | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
mediaWidth | string | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
mediaHeight | string | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
mediaRadius | string | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
imageWidth | string | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
imageHeight | string | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
imageRadius | string | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
imageMode | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
titleSize | string | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
descSize | string | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
titleColor | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
descColor | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
spacing | string | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
align | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
contentAlign | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
layout | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
key | string | 稳定渲染标识 |
title | string | 主标题 |
desc | string | 简短说明 |
icon | string | 图标名称 |
image | string | 图片地址 |
badge | string | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
disabled | boolean | 是否禁止该项交互 |
loading | boolean | 该项是否显示加载状态 |
clickable | boolean | 该项是否允许点击 |
colSpan | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
rowSpan | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
square | boolean | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
footer | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
variant | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
padding | string | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
radius | string | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
minHeight | string | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
activeEffect | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
activeScale | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
border | boolean | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
divider | boolean | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
dividerInset | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
dividerColor | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
style | UTSJSONObject | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
click | handleClick 内触发（script 行 70）；参数表达式：payload；前置 guard：item.disabled == true || item.loading == true || !(item.clickable != null ? item.clickable : props.clickable) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
item-click | handleClick 内触发（script 行 70）；参数表达式：payload；前置 guard：item.disabled == true || item.loading == true || !(item.clickable != null ? item.clickable : props.clickable) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
section | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
empty | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
default | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
item | { item, index } | 仅在模板对应 <slot> 渲染位置生效。 |
header | { item, index } | 仅在模板对应 <slot> 渲染位置生效。 |
icon | { item, index } | 仅在模板对应 <slot> 渲染位置生效。 |
footer | { item, index } | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
| - | - | 当前组件没有公开实例方法。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-shadow-soft)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。
平台与实现边界
- 基线为 HBuilderX 5.26+ 与 uni-app x；当前报告已验证 Web Chromium 的对应 Demo，不据此承诺 Safari、小程序或 App 原生端等价。
- Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力，只有源码或完整性报告明确覆盖的部分才可视为已验证。
- 本文按当前源码生成，不补入旧版
xtf-linkui存在但迁移版未实现的 props、事件、slot 或方法。 - 详细公共边界见 平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。