Skip to content

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>

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>

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>

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>

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>

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
activeKeystring | number-1提供当前受控状态;是否回写以事件表为准;消费位置:script 行 47、script 行 82需要覆盖组件默认业务值时设置。
variantstring"soft"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 25需要调整布局或视觉表现时设置。
overlaybooleantrue参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 9需要控制显示、可用性或交互状态时设置。
closeOnClickOverlaybooleantrue开关对应显示或交互行为;消费位置:script 行 80需要覆盖组件默认业务值时设置。
lockScrollbooleantrue参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 81需要覆盖组件默认业务值时设置。
popupOffsetnumber | string0参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 34需要覆盖组件默认业务值时设置。
matchTriggerWidthbooleantrue设置对应区域宽度;消费位置:script 行 41、script 行 42需要调整布局或视觉表现时设置。
durationnumber | string200参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 76、script 行 79需要覆盖组件默认业务值时设置。
zIndexnumber | string100参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 28需要覆盖组件默认业务值时设置。
activeColorstring""设置对应区域的颜色;消费位置:script 行 27需要调整布局或视觉表现时设置。
itemClassstring""追加到对应内部区域的 class;消费位置:template 行 3需要调整布局或视觉表现时设置。
itemStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:template 行 3需要调整布局或视觉表现时设置。
titleClassstring""追加到对应内部区域的 class;消费位置:template 行 4需要调整布局或视觉表现时设置。
titleStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:template 行 4需要调整布局或视觉表现时设置。
arrowClassstring""追加到对应内部区域的 class;消费位置:template 行 6需要调整布局或视觉表现时设置。
arrowStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:template 行 6需要调整布局或视觉表现时设置。
popupClassstring""追加到对应内部区域的 class;消费位置:template 行 10需要调整布局或视觉表现时设置。
popupStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:script 行 31需要调整布局或视觉表现时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 26需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 27需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
changeopen 内触发(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[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
openopen 内触发(script 行 75);参数表达式:index;前置 guard:id != requestId || currentIndex.value != index || items.value[index] == null、!measured、items.value[index].disabled()(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
closeopen 内触发(script 行 67);参数表达式:previous;前置 guard:normalizedIndex(index) != index || index >= items.value.length || items.value[index].disabled() || currentIndex.value == index
close 内触发(script 行 79);参数表达式:previous;前置 guard:currentIndex.value < 0
(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
openedsetup 内触发(script 行 76);参数表达式:index(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
closedopen 内触发(script 行 67);参数表达式:previous;前置 guard:normalizedIndex(index) != index || index >= items.value.length || items.value[index].disabled() || currentIndex.value == index
setup 内触发(script 行 79);参数表达式:previous
(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:activeKeyopen 内触发(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> 渲染位置生效。

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
openopen(index: number): Promise<void>打开组件;通过组件 ref 调用,参数和返回值按签名处理。
closeclose(): 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。

MIT Licensed