Skip to content

xtf-dropdown-item ​

组件说明 ​

xtf-dropdown-item 是下拉菜单项,用于在 DropdownMenu 中提供单选或多选内容。当前实现读取 options 数据、通过 change 等事件反馈交互、提供实例方法。

  • 实际 Demo 路由:#/pages/components/xtf-dropdown-item/index
  • Demo 源码

基础用法 ​

1. 最小可用 ​

提供能够直接看到或操作组件的最少业务内容。

vue
<template>
  <view class="doc-minimum">
    <XtfDropdownMenu>
      <XtfDropdownItem title="账单详情" :options="fixture" />
    </XtfDropdownMenu>
  </view>
</template>

<script setup lang="uts">
import XtfDropdownMenu from "@/uni_modules/xtf-linkuiunix/components/xtf-dropdown-menu/xtf-dropdown-menu.uvue"
import XtfDropdownItem from "@/uni_modules/xtf-linkuiunix/components/xtf-dropdown-item/xtf-dropdown-item.uvue"

const fixture = [{ text: '全部', value: 'all' }, { text: '收入', value: 'income' }] as Array<any>
</script>

<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>

2. 核心数据与主要事件 ​

使用组件真实数据入口,并记录当前源码声明的主要事件。

vue
<template>
  <view class="doc-core">
    <XtfDropdownMenu>
      <XtfDropdownItem title="账单详情" :options="fixture" @change="onPrimaryEvent" />
    </XtfDropdownMenu>
  </view>
</template>

<script setup lang="uts">
import XtfDropdownMenu from "@/uni_modules/xtf-linkuiunix/components/xtf-dropdown-menu/xtf-dropdown-menu.uvue"
import XtfDropdownItem from "@/uni_modules/xtf-linkuiunix/components/xtf-dropdown-item/xtf-dropdown-item.uvue"

const fixture = [{ text: '全部', value: 'all' }, { text: '收入', value: 'income' }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-dropdown-item:change", payload) }
</script>

<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>

3. 动态 disabled 状态 ​

运行时切换 disabled,观察组件对应状态变化。

vue
<template>
  <view class="doc-dynamic">
    <XtfDropdownMenu>
      <XtfDropdownItem title="账单详情" :options="fixture" :disabled="state" />
    </XtfDropdownMenu>
    <button class="doc-action-button" @click="toggleState">切换 disabled</button>
    <text class="doc-state-text">disabled: {{ state }}</text>
  </view>
</template>

<script setup lang="uts">
import XtfDropdownMenu from "@/uni_modules/xtf-linkuiunix/components/xtf-dropdown-menu/xtf-dropdown-menu.uvue"
import XtfDropdownItem from "@/uni_modules/xtf-linkuiunix/components/xtf-dropdown-item/xtf-dropdown-item.uvue"

import { ref } from "vue"
const fixture = [{ text: '全部', value: 'all' }, { text: '收入', value: 'income' }] as Array<any>
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>

4. 定制 default 插槽 ​

使用源码真实声明的 default slot 替换对应内容。

vue
<template>
  <view class="doc-slot">
    <XtfDropdownMenu>
      <XtfDropdownItem title="账单详情" :options="fixture">
      <template #default><text class="doc-content-text">自定义 default 内容</text></template>
    </XtfDropdownItem>
    </XtfDropdownMenu>
  </view>
</template>

<script setup lang="uts">
import XtfDropdownMenu from "@/uni_modules/xtf-linkuiunix/components/xtf-dropdown-menu/xtf-dropdown-menu.uvue"
import XtfDropdownItem from "@/uni_modules/xtf-linkuiunix/components/xtf-dropdown-item/xtf-dropdown-item.uvue"

const fixture = [{ text: '全部', value: 'all' }, { text: '收入', value: 'income' }] as Array<any>
</script>

<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>

5. 调用 open() ​

打开组件;签名为 open(): void。

vue
<template>
  <view class="doc-method">
    <XtfDropdownMenu>
      <XtfDropdownItem title="账单详情" :options="fixture" ref="componentRef" />
    </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 XtfDropdownItem from "@/uni_modules/xtf-linkuiunix/components/xtf-dropdown-item/xtf-dropdown-item.uvue"

import { ref } from "vue"
const fixture = [{ text: '全部', value: 'all' }, { text: '收入', value: 'income' }] as Array<any>
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.open(); console.log("调用 open") }
</script>

<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
titlestring""参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 28、script 行 49、template 行 3需要提供业务文案或图标内容时设置。
disabledbooleanfalse参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 32、script 行 54、script 行 59、script 行 60需要控制显示、可用性或交互状态时设置。
optionsany[]() => [] as any[]参与组件运行逻辑;源码在 9 处读取该值;消费位置:script 行 17、script 行 48、template 行 4、template 行 6数据驱动或选项渲染场景。
valueanynull参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 35、script 行 64需要覆盖组件默认业务值时设置。
modelValueanynull参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 35、script 行 63需要覆盖组件默认业务值时设置。
valueKeystring"value"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 38、script 行 39需要覆盖组件默认业务值时设置。
labelKeystring"text"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 39需要提供业务文案或图标内容时设置。
multiplebooleanfalse参与组件运行逻辑;源码在 17 处读取该值;消费位置:script 行 17、script 行 28、script 行 36、script 行 43需要控制显示、可用性或交互状态时设置。
showToolbarbooleantrue开关对应显示或交互行为;消费位置:script 行 17、script 行 59、template 行 14需要控制显示、可用性或交互状态时设置。
showHeaderbooleanfalse开关对应显示或交互行为;消费位置:script 行 17、script 行 28需要控制显示、可用性或交互状态时设置。
visibleOptionCountnumber | string0参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 17、script 行 47需要覆盖组件默认业务值时设置。
optionHeightnumber | string76设置对应区域高度;消费位置:script 行 17、script 行 47需要调整布局或视觉表现时设置。
maxHeightnumber | string600设置对应区域高度;消费位置:script 行 17、script 行 47需要调整布局或视觉表现时设置。
useScrollViewbooleantrue参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 17、script 行 20、script 行 30、template 行 4需要覆盖组件默认业务值时设置。
confirmTextstring""设置对应区域的显示文案;消费位置:template 行 14需要提供业务文案或图标内容时设置。
resetTextstring""设置对应区域的显示文案;消费位置:template 行 14需要提供业务文案或图标内容时设置。
emptyTextstring""设置对应区域的显示文案;消费位置:template 行 12、template 行 13需要提供业务文案或图标内容时设置。
showSelectedTitlebooleantrue开关对应显示或交互行为;消费位置:script 行 49需要控制显示、可用性或交互状态时设置。
showSelectedCountbooleantrue开关对应显示或交互行为;消费位置:script 行 49、script 行 50需要控制显示、可用性或交互状态时设置。
rememberKeystring""参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 57、script 行 67需要覆盖组件默认业务值时设置。
optionColumnsnumber | string1提供组件渲染或选择使用的数据集合;消费位置:script 行 17、script 行 31、template 行 5、template 行 9数据驱动或选项渲染场景。
selectedSeparatorstring" / "提供当前受控状态;是否回写以事件表为准;消费位置:script 行 49需要覆盖组件默认业务值时设置。
popupClassstring""追加到对应内部区域的 class;消费位置:template 行 2需要调整布局或视觉表现时设置。
popupStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:script 行 29需要调整布局或视觉表现时设置。
headerClassstring""追加到对应内部区域的 class;消费位置:template 行 3需要调整布局或视觉表现时设置。
headerStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:template 行 3需要调整布局或视觉表现时设置。
bodyClassstring""追加到对应内部区域的 class;消费位置:template 行 4、template 行 9、template 行 12、template 行 13需要调整布局或视觉表现时设置。
bodyStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:script 行 30需要调整布局或视觉表现时设置。
optionClassstring""追加到对应内部区域的 class;消费位置:template 行 6、template 行 10需要调整布局或视觉表现时设置。
optionStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:script 行 31需要调整布局或视觉表现时设置。
activeOptionClassstring""追加到对应内部区域的 class;消费位置:script 行 45需要调整布局或视觉表现时设置。
footerClassstring""追加到对应内部区域的 class;消费位置:template 行 14需要调整布局或视觉表现时设置。
footerStyleUTSJSONObject() => ({} as UTSJSONObject)覆盖或追加对应内部区域的样式对象;消费位置:template 行 14需要调整布局或视觉表现时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 29需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
changecommit 内触发(script 行 58);参数表达式:Object.assign({ "value": committed.value }, detail)
select 内触发(script 行 59);参数表达式:{ "value": next.slice(), "option": option, "index": index };前置 guard:props.disabled || !visible.value || optionDisabled(option)、!props.multiple
(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
openopenPanel 内触发(script 行 54);参数表达式:无回调参数;前置 guard:props.disabled || visible.value(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
closeclosePanel 内触发(script 行 55);参数表达式:无回调参数;前置 guard:!visible.value(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
openedsetup 内触发(script 行 54);参数表达式:无回调参数(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
closedsetup 内触发(script 行 55);参数表达式:无回调参数(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
inputcommit 内触发(script 行 58);参数表达式:committed.value(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:valuecommit 内触发(script 行 58);参数表达式:committed.value(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:modelValuecommit 内触发(script 行 58);参数表达式:committed.value(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
confirmselect 内触发(script 行 59);参数表达式:{ "value": committed.value, "option": option, "index": index };前置 guard:props.disabled || !visible.value || optionDisabled(option)、!props.multiple
confirm 内触发(script 行 60);参数表达式:{ "value": committed.value };前置 guard:props.disabled || !visible.value
(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
resetreset 内触发(script 行 61);参数表达式:{ "value": draft.value };前置 guard:props.disabled(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。

插槽 ​

插槽Scope 参数实际渲染位置
default无 scope 参数仅在模板对应 <slot> 渲染位置生效。

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
openopen(): void打开组件;通过组件 ref 调用,参数和返回值按签名处理。
closeclose(): void请求关闭组件;通过组件 ref 调用,参数和返回值按签名处理。
confirmconfirm(): void提交当前草稿;通过组件 ref 调用,参数和返回值按签名处理。
resetreset(): void恢复初始状态;通过组件 ref 调用,参数和返回值按签名处理。

公开状态 ​

状态类型 / 包装读取边界
--当前组件没有公开状态。

主题说明 ​

  • var(--xtf-color-border):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-primary):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-primary-soft):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-surface):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-text):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-text-secondary):组件样式实际读取的主题变量,可在 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