Appearance
xtf-bubble-menu
组件说明
xtf-bubble-menu 是气泡菜单,用于围绕触发元素展示轻量操作菜单。当前实现读取 actions 数据、由 show 控制显示、通过 update:show 等事件反馈交互。
- 实际 Demo 路由:
#/pages/components/xtf-bubble-menu/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfBubbleMenuHost>
<XtfBubbleMenu :show="true">
<text class="doc-content-text">示例内容</text>
</XtfBubbleMenu>
</XtfBubbleMenuHost>
</view>
</template>
<script setup lang="uts">
import XtfBubbleMenuHost from "@/uni_modules/xtf-linkuiunix/components/xtf-bubble-menu-host/xtf-bubble-menu-host.uvue"
import XtfBubbleMenu from "@/uni_modules/xtf-linkuiunix/components/xtf-bubble-menu/xtf-bubble-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
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2. 核心数据与主要事件
使用组件真实数据入口,并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfBubbleMenuHost>
<XtfBubbleMenu :show="true" :actions="fixture" @open="onPrimaryEvent">
<text class="doc-content-text">示例内容</text>
</XtfBubbleMenu>
</XtfBubbleMenuHost>
</view>
</template>
<script setup lang="uts">
import XtfBubbleMenuHost from "@/uni_modules/xtf-linkuiunix/components/xtf-bubble-menu-host/xtf-bubble-menu-host.uvue"
import XtfBubbleMenu from "@/uni_modules/xtf-linkuiunix/components/xtf-bubble-menu/xtf-bubble-menu.uvue"
const fixture = [{ key: 'edit', label: '编辑账单', icon: 'edit' }, { key: 'delete', label: '删除账单', icon: 'delete', danger: true }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-bubble-menu:open", 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
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
3. 动态 show 状态
运行时切换 show,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfBubbleMenuHost>
<XtfBubbleMenu :show="state">
<text class="doc-content-text">示例内容</text>
</XtfBubbleMenu>
</XtfBubbleMenuHost>
<button class="doc-action-button" @click="toggleState">切换 show</button>
<text class="doc-state-text">show: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfBubbleMenuHost from "@/uni_modules/xtf-linkuiunix/components/xtf-bubble-menu-host/xtf-bubble-menu-host.uvue"
import XtfBubbleMenu from "@/uni_modules/xtf-linkuiunix/components/xtf-bubble-menu/xtf-bubble-menu.uvue"
import { ref } from "vue"
const state = ref(true)
function toggleState(): void { state.value = !state.value; console.log("show", 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
26
27
28
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
4. 定制 default 插槽
使用源码真实声明的 default slot 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfBubbleMenuHost>
<XtfBubbleMenu :show="true">
<template #default><text class="doc-content-text">自定义 default 内容</text></template>
</XtfBubbleMenu>
</XtfBubbleMenuHost>
</view>
</template>
<script setup lang="uts">
import XtfBubbleMenuHost from "@/uni_modules/xtf-linkuiunix/components/xtf-bubble-menu-host/xtf-bubble-menu-host.uvue"
import XtfBubbleMenu from "@/uni_modules/xtf-linkuiunix/components/xtf-bubble-menu/xtf-bubble-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
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
show | boolean | false | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 70、script 行 81 | 需要控制显示、可用性或交互状态时设置。 |
actions | XtfBubbleMenuAction[] | () => [] as XtfBubbleMenuAction[] | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 63、script 行 105、script 行 127、template 行 7 | 数据驱动或选项渲染场景。 |
trigger | "click" | "manual" | "hover" | "click" | 参与组件运行逻辑;源码在 6 处读取该值;可选值:click / manual / hover;消费位置:script 行 75、script 行 135、script 行 178、script 行 191 | 需要覆盖组件默认业务值时设置。 |
placement | XtfBubbleMenuPlacement | "bottom" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 128 | 需要覆盖组件默认业务值时设置。 |
width | number | 280 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 129 | 需要覆盖组件默认业务值时设置。 |
maxWidth | number | 0 | 设置对应区域宽度;消费位置:script 行 130 | 需要调整布局或视觉表现时设置。 |
offset | number | 16 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 131 | 需要覆盖组件默认业务值时设置。 |
zIndex | number | 2300 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 132 | 需要覆盖组件默认业务值时设置。 |
transitionDuration | number | 220 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 133 | 需要覆盖组件默认业务值时设置。 |
arrow | boolean | true | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 134 | 需要覆盖组件默认业务值时设置。 |
disabled | boolean | false | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 74、script 行 77、script 行 105、script 行 178 | 需要控制显示、可用性或交互状态时设置。 |
closeOnClickOutside | boolean | true | 开关对应显示或交互行为;消费位置:script 行 135 | 需要覆盖组件默认业务值时设置。 |
closeOnClickAction | boolean | true | 开关对应显示或交互行为;消费位置:script 行 136、script 行 185 | 需要覆盖组件默认业务值时设置。 |
beforeClose | ((payload: UTSJSONObject) => boolean) | null | null | 提供源码调用的业务回调,参数和返回值以类型列为准;消费位置:script 行 158、script 行 186、script 行 198 | 需要接入业务守卫、转换或过滤逻辑时设置。 |
iconSize | "xs" | "sm" | "md" | "lg" | "xl" | "sm" | 设置对应元素尺寸;可选值:xs / sm / md / lg / xl;消费位置:script 行 140 | 需要调整布局或视觉表现时设置。 |
imageSize | number | 32 | 设置对应元素尺寸;消费位置:script 行 141 | 需要调整布局或视觉表现时设置。 |
showIcon | boolean | true | 设置对应区域的图标名称;消费位置:script 行 137 | 需要控制显示、可用性或交互状态时设置。 |
showSuffix | boolean | true | 开关对应显示或交互行为;消费位置:script 行 138 | 需要控制显示、可用性或交互状态时设置。 |
suffixIcon | string | "chevron_right" | 设置对应区域的图标名称;消费位置:script 行 139 | 需要提供业务文案或图标内容时设置。 |
customClass | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 142、template 行 2 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 143、template 行 2 | 需要调整布局或视觉表现时设置。 |
panelClass | string | "" | 追加到对应内部区域的 class;消费位置:script 行 144 | 需要调整布局或视觉表现时设置。 |
panelStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 145 | 需要调整布局或视觉表现时设置。 |
listClass | string | "" | 追加到对应内部区域的 class;消费位置:script 行 146、template 行 6 | 需要调整布局或视觉表现时设置。 |
listStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 147、template 行 6 | 需要调整布局或视觉表现时设置。 |
arrowClass | string | "" | 追加到对应内部区域的 class;消费位置:script 行 148 | 需要调整布局或视觉表现时设置。 |
arrowStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 149 | 需要调整布局或视觉表现时设置。 |
iconClass | string | "" | 追加到对应内部区域的 class;消费位置:script 行 150 | 需要调整布局或视觉表现时设置。 |
iconStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 151 | 需要调整布局或视觉表现时设置。 |
imageClass | string | "" | 追加到对应内部区域的 class;消费位置:script 行 152 | 需要调整布局或视觉表现时设置。 |
imageStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 153 | 需要调整布局或视觉表现时设置。 |
labelClass | string | "" | 追加到对应内部区域的 class;消费位置:script 行 154 | 需要调整布局或视觉表现时设置。 |
labelStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 155 | 需要调整布局或视觉表现时设置。 |
itemClass | string | "" | 追加到对应内部区域的 class;消费位置:script 行 156、template 行 7 | 需要调整布局或视觉表现时设置。 |
itemStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 157、template 行 7 | 需要调整布局或视觉表现时设置。 |
XtfBubbleMenuAction 数据结构
| 字段 | 源码类型 | 字段语义 |
|---|---|---|
key | string | 稳定渲染标识 |
value | string | 业务值 |
name | string | 名称或兼容显示字段 |
label | string | 显示文字 |
description | string | 补充说明 |
desc | string | 简短说明 |
icon | string | 图标名称 |
image | string | 图片地址 |
img | string | 源码声明的业务扩展字段;当前实现未提供更具体语义。 |
imageMode | string | 源码声明的业务扩展字段;当前实现未提供更具体语义。 |
theme | XtfBubbleMenuTheme | 源码声明的业务扩展字段;当前实现未提供更具体语义。 |
color | string | 源码声明的业务扩展字段;当前实现未提供更具体语义。 |
danger | boolean | 是否使用危险语义 |
disabled | boolean | 是否禁止该项交互 |
keepOpen | boolean | 操作后是否保持浮层打开 |
showIcon | boolean | 源码声明的业务扩展字段;当前实现未提供更具体语义。 |
showSuffix | boolean | 源码声明的业务扩展字段;当前实现未提供更具体语义。 |
suffixIcon | string | 源码声明的业务扩展字段;当前实现未提供更具体语义。 |
iconClass | string | 源码声明的业务扩展字段;当前实现未提供更具体语义。 |
iconStyle | UTSJSONObject | 源码声明的业务扩展字段;当前实现未提供更具体语义。 |
imageClass | string | 源码声明的业务扩展字段;当前实现未提供更具体语义。 |
imageStyle | UTSJSONObject | 源码声明的业务扩展字段;当前实现未提供更具体语义。 |
labelClass | string | 源码声明的业务扩展字段;当前实现未提供更具体语义。 |
labelStyle | UTSJSONObject | 源码声明的业务扩展字段;当前实现未提供更具体语义。 |
itemClass | string | 源码声明的业务扩展字段;当前实现未提供更具体语义。 |
itemStyle | UTSJSONObject | 源码声明的业务扩展字段;当前实现未提供更具体语义。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
update:show | setVisible 内触发(script 行 119);参数表达式:next;前置 guard:disposed、next == visible.value || (next && (props.disabled || host == null || (props.actions.length == 0 && slots["content"] == null)))、disposed || !visible.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
open | setVisible 内触发(script 行 120);参数表达式:无回调参数;条件分支:next;前置 guard:disposed、next == visible.value || (next && (props.disabled || host == null || (props.actions.length == 0 && slots["content"] == null)))、disposed || !visible.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
close | setVisible 内触发(script 行 120);参数表达式:无回调参数;条件分支:!(next);前置 guard:disposed、next == visible.value || (next && (props.disabled || host == null || (props.actions.length == 0 && slots["content"] == null)))、disposed || !visible.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
select | onSelect 内触发(script 行 175);参数表达式:payloadselectRaw 内触发(script 行 184);参数表达式:{ index, action };前置 guard:action.disabled == true || !visible.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
default | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
content | { actions, select } | 仅在模板对应 <slot> 渲染位置生效。 |
item | { action, index } | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
| - | - | 当前组件没有公开实例方法。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
- 当前组件 CSS 未读取
var(--xtf-*)主题变量;颜色或尺寸可能来自 props、固定样式或父级上下文。
平台与实现边界
- 基线为 HBuilderX 5.26+ 与 uni-app x;当前报告已验证 Web Chromium 的对应 Demo,不据此承诺 Safari、小程序或 App 原生端等价。
- Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力,只有源码或完整性报告明确覆盖的部分才可视为已验证。
- 本文按当前源码生成,不补入旧版
xtf-linkui存在但迁移版未实现的 props、事件、slot 或方法。 - 详细公共边界见 平台与实现边界,逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。