Appearance
xtf-dropdown-menu
组件说明
xtf-dropdown-menu 是下拉菜单,用于管理多个下拉筛选项的展开状态。当前实现通过 change 等事件反馈交互、提供实例方法。
- 实际 Demo 路由:
#/pages/components/xtf-dropdown-menu/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfDropdownMenu >
<text class="doc-content-text">示例内容</text>
</XtfDropdownMenu>
</view>
</template>
<script setup lang="uts">
import XtfDropdownMenu from "@/uni_modules/xtf-linkuiunix/components/xtf-dropdown-menu/xtf-dropdown-menu.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2. 核心数据与主要事件
使用组件真实数据入口,并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfDropdownMenu @change="onPrimaryEvent">
<text class="doc-content-text">示例内容</text>
</XtfDropdownMenu>
</view>
</template>
<script setup lang="uts">
import XtfDropdownMenu from "@/uni_modules/xtf-linkuiunix/components/xtf-dropdown-menu/xtf-dropdown-menu.uvue"
function onPrimaryEvent(payload: any): void { console.log("xtf-dropdown-menu:change", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
3. 动态 overlay 状态
运行时切换 overlay,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfDropdownMenu :overlay="state">
<text class="doc-content-text">示例内容</text>
</XtfDropdownMenu>
<button class="doc-action-button" @click="toggleState">切换 overlay</button>
<text class="doc-state-text">overlay: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfDropdownMenu from "@/uni_modules/xtf-linkuiunix/components/xtf-dropdown-menu/xtf-dropdown-menu.uvue"
import { ref } from "vue"
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("overlay", 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>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
4. 定制 default 插槽
使用源码真实声明的 default slot 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfDropdownMenu >
<template #default><text class="doc-content-text">自定义 default 内容</text></template>
</XtfDropdownMenu>
</view>
</template>
<script setup lang="uts">
import XtfDropdownMenu from "@/uni_modules/xtf-linkuiunix/components/xtf-dropdown-menu/xtf-dropdown-menu.uvue"
</script>
<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
5. 调用 close()
请求关闭组件;签名为 close(): void。
vue
<template>
<view class="doc-method">
<XtfDropdownMenu ref="componentRef">
<text class="doc-content-text">示例内容</text>
</XtfDropdownMenu>
<button class="doc-action-button" @click="callMethod">请求关闭组件</button>
</view>
</template>
<script setup lang="uts">
import XtfDropdownMenu from "@/uni_modules/xtf-linkuiunix/components/xtf-dropdown-menu/xtf-dropdown-menu.uvue"
import { ref } from "vue"
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.close(); console.log("调用 close") }
</script>
<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
activeKey | string | number | -1 | 提供当前受控状态;是否回写以事件表为准;消费位置:script 行 47、script 行 82 | 需要覆盖组件默认业务值时设置。 |
variant | string | "soft" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 25 | 需要调整布局或视觉表现时设置。 |
overlay | boolean | true | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 9 | 需要控制显示、可用性或交互状态时设置。 |
closeOnClickOverlay | boolean | true | 开关对应显示或交互行为;消费位置:script 行 80 | 需要覆盖组件默认业务值时设置。 |
lockScroll | boolean | true | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 81 | 需要覆盖组件默认业务值时设置。 |
popupOffset | number | string | 0 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 34 | 需要覆盖组件默认业务值时设置。 |
matchTriggerWidth | boolean | true | 设置对应区域宽度;消费位置:script 行 41、script 行 42 | 需要调整布局或视觉表现时设置。 |
duration | number | string | 200 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 76、script 行 79 | 需要覆盖组件默认业务值时设置。 |
zIndex | number | string | 100 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 28 | 需要覆盖组件默认业务值时设置。 |
activeColor | string | "" | 设置对应区域的颜色;消费位置:script 行 27 | 需要调整布局或视觉表现时设置。 |
itemClass | string | "" | 追加到对应内部区域的 class;消费位置:template 行 3 | 需要调整布局或视觉表现时设置。 |
itemStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:template 行 3 | 需要调整布局或视觉表现时设置。 |
titleClass | string | "" | 追加到对应内部区域的 class;消费位置:template 行 4 | 需要调整布局或视觉表现时设置。 |
titleStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:template 行 4 | 需要调整布局或视觉表现时设置。 |
arrowClass | string | "" | 追加到对应内部区域的 class;消费位置:template 行 6 | 需要调整布局或视觉表现时设置。 |
arrowStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:template 行 6 | 需要调整布局或视觉表现时设置。 |
popupClass | string | "" | 追加到对应内部区域的 class;消费位置:template 行 10 | 需要调整布局或视觉表现时设置。 |
popupStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 31 | 需要调整布局或视觉表现时设置。 |
customClass | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 26 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 27 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
change | open 内触发(script 行 75);参数表达式:index;前置 guard:id != requestId || currentIndex.value != index || items.value[index] == null、!measured、items.value[index].disabled()close 内触发(script 行 79);参数表达式:-1;前置 guard:currentIndex.value < 0 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
open | open 内触发(script 行 75);参数表达式:index;前置 guard:id != requestId || currentIndex.value != index || items.value[index] == null、!measured、items.value[index].disabled() | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
close | open 内触发(script 行 67);参数表达式:previous;前置 guard:normalizedIndex(index) != index || index >= items.value.length || items.value[index].disabled() || currentIndex.value == indexclose 内触发(script 行 79);参数表达式:previous;前置 guard:currentIndex.value < 0 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
opened | setup 内触发(script 行 76);参数表达式:index | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
closed | open 内触发(script 行 67);参数表达式:previous;前置 guard:normalizedIndex(index) != index || index >= items.value.length || items.value[index].disabled() || currentIndex.value == indexsetup 内触发(script 行 79);参数表达式:previous | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:activeKey | open 内触发(script 行 75);参数表达式:index;前置 guard:id != requestId || currentIndex.value != index || items.value[index] == null、!measured、items.value[index].disabled()close 内触发(script 行 79);参数表达式:-1;前置 guard:currentIndex.value < 0 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
default | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
open | open(index: number): Promise<void> | 打开组件;通过组件 ref 调用,参数和返回值按签名处理。 |
close | close(): void | 请求关闭组件;通过组件 ref 调用,参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-color-border):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-primary-soft):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-surface):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-dropdown-active):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-dropdown-menu-bg):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-dropdown-menu-border):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-dropdown-title):组件样式实际读取的主题变量,可在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。