Appearance
xtf-grid-item
组件说明
xtf-grid-item 是宫格项,用于在 Grid 中声明单个功能入口。当前实现按源码声明的 props 渲染内容。
- 实际 Demo 路由:
#/pages/components/xtf-grid-item/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfGridItem title="账单详情">
<text class="doc-content-text">示例内容</text>
</XtfGridItem>
</view>
</template>
<script setup lang="uts">
import XtfGridItem from "@/uni_modules/xtf-linkuiunix/components/xtf-grid-item/xtf-grid-item.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口,并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfGridItem title="账单详情" :key="renderKey" :clickable="true">
<text class="doc-content-text">示例内容</text>
</XtfGridItem>
<button class="doc-action-button" @click="remountComponent">重新挂载组件</button>
</view>
</template>
<script setup lang="uts">
import XtfGridItem from "@/uni_modules/xtf-linkuiunix/components/xtf-grid-item/xtf-grid-item.uvue"
import { ref } from "vue"
const renderKey = ref(0)
function remountComponent(): void { renderKey.value += 1; console.log("xtf-grid-item 重新挂载", renderKey.value) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>3. 动态 disabled 状态
运行时切换 disabled,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfGridItem title="账单详情" :disabled="state">
<text class="doc-content-text">示例内容</text>
</XtfGridItem>
<button class="doc-action-button" @click="toggleState">切换 disabled</button>
<text class="doc-state-text">disabled: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfGridItem from "@/uni_modules/xtf-linkuiunix/components/xtf-grid-item/xtf-grid-item.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-content-text { color: #334155; font-size: 26rpx; }
.doc-action-button { margin-top: 16rpx; }
.doc-state-text { margin-top: 12rpx; color: #475569; font-size: 24rpx; }
</style>4. 定制 default 插槽
使用源码真实声明的 default slot 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfGridItem title="账单详情">
<template #default><text class="doc-content-text">自定义 default 内容</text></template>
</XtfGridItem>
</view>
</template>
<script setup lang="uts">
import XtfGridItem from "@/uni_modules/xtf-linkuiunix/components/xtf-grid-item/xtf-grid-item.uvue"
</script>
<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
title | string | "" | 参与组件运行逻辑;源码在 8 处读取该值;消费位置:script 行 16、template 行 9、template 行 12 | 需要提供业务文案或图标内容时设置。 |
desc | string | "" | 参与组件运行逻辑;源码在 6 处读取该值;消费位置:template 行 9、template 行 12 | 需要覆盖组件默认业务值时设置。 |
footer | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 13 | 需要覆盖组件默认业务值时设置。 |
badge | string | number | undefined | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 10 | 需要覆盖组件默认业务值时设置。 |
icon | string | "" | 参与组件运行逻辑;源码在 5 处读取该值;消费位置:template 行 10、template 行 11 | 需要提供业务文案或图标内容时设置。 |
iconTheme | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要覆盖组件默认业务值时设置。 |
theme | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要调整布局或视觉表现时设置。 |
iconSize | string | number | "" | 设置对应元素尺寸;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要调整布局或视觉表现时设置。 |
image | string | "" | 参与组件运行逻辑;源码在 5 处读取该值;消费位置:template 行 10、template 行 11 | 需要覆盖组件默认业务值时设置。 |
mediaWidth | string | number | -1 | 设置对应区域宽度;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要调整布局或视觉表现时设置。 |
mediaHeight | string | number | -1 | 设置对应区域高度;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要调整布局或视觉表现时设置。 |
mediaRadius | string | number | -1 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要调整布局或视觉表现时设置。 |
imageWidth | string | number | -1 | 设置对应区域宽度;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要调整布局或视觉表现时设置。 |
imageHeight | string | number | -1 | 设置对应区域高度;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要调整布局或视觉表现时设置。 |
imageRadius | string | number | -1 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要调整布局或视觉表现时设置。 |
imageMode | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要覆盖组件默认业务值时设置。 |
titleSize | string | number | -1 | 设置对应元素尺寸;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要调整布局或视觉表现时设置。 |
descSize | string | number | -1 | 设置对应元素尺寸;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要调整布局或视觉表现时设置。 |
titleColor | string | "" | 设置对应区域的颜色;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要调整布局或视觉表现时设置。 |
descColor | string | "" | 设置对应区域的颜色;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要调整布局或视觉表现时设置。 |
spacing | string | number | -1 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要覆盖组件默认业务值时设置。 |
align | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要调整布局或视觉表现时设置。 |
layout | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要调整布局或视觉表现时设置。 |
clickable | boolean | undefined | 开关对应显示或交互行为;消费位置:经 Object.assign 进入 Grid context 消费 | 需要覆盖组件默认业务值时设置。 |
disabled | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 Grid context 消费 | 需要控制显示、可用性或交互状态时设置。 |
loading | boolean | false | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 7、经 Object.assign 进入 Grid context 消费 | 需要控制显示、可用性或交互状态时设置。 |
variant | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 Grid context 消费 | 需要调整布局或视觉表现时设置。 |
contentAlign | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 resolveGridContent 消费 | 需要覆盖组件默认业务值时设置。 |
padding | number | -1 | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 16、经 Object.assign 进入 Grid context 消费 | 需要覆盖组件默认业务值时设置。 |
radius | number | -1 | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 16、经 Object.assign 进入 Grid context 消费 | 需要覆盖组件默认业务值时设置。 |
minHeight | number | -1 | 设置对应区域高度;消费位置:script 行 16、经 Object.assign 进入 Grid context 消费 | 需要调整布局或视觉表现时设置。 |
colSpan | number | 1 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 Grid context 消费 | 需要覆盖组件默认业务值时设置。 |
rowSpan | number | 1 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 Grid context 消费 | 需要覆盖组件默认业务值时设置。 |
square | boolean | undefined | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 Grid context 消费 | 需要覆盖组件默认业务值时设置。 |
border | boolean | undefined | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 Grid context 消费 | 需要覆盖组件默认业务值时设置。 |
activeEffect | string | "" | 提供当前受控状态;是否回写以事件表为准;消费位置:经 Object.assign 进入 Grid context 消费 | 需要覆盖组件默认业务值时设置。 |
activeScale | number | -1 | 提供当前受控状态;是否回写以事件表为准;消费位置:script 行 16、经 Object.assign 进入 Grid context 消费 | 需要覆盖组件默认业务值时设置。 |
divider | boolean | undefined | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:经 Object.assign 进入 Grid context 消费 | 需要覆盖组件默认业务值时设置。 |
dividerInset | number | -1 | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 16、经 Object.assign 进入 Grid context 消费 | 需要覆盖组件默认业务值时设置。 |
dividerColor | string | "" | 设置对应区域的颜色;消费位置:script 行 16、经 Object.assign 进入 Grid context 消费 | 需要调整布局或视觉表现时设置。 |
class | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 21 | 需要覆盖组件默认业务值时设置。 |
style | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 20、经 Object.assign 进入 Grid context 消费 | 需要覆盖组件默认业务值时设置。 |
itemKey | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 16 | 需要覆盖组件默认业务值时设置。 |
index | number | 0 | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 16、script 行 18 | 需要覆盖组件默认业务值时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
| - | 当前组件未调用 defineEmits。 | - | - |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
default | 无 scope 参数 | 仅在模板对应 <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。