Appearance
xtf-floating-bubble
组件说明
xtf-floating-bubble 是悬浮气泡,用于提供可拖动的浮动主入口和快捷菜单。当前实现读取 menu 数据、通过 click 等事件反馈交互、提供实例方法。
- 实际 Demo 路由:
#/pages/components/xtf-floating-bubble/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfFloatingBubble label="保存" />
</view>
</template>
<script setup lang="uts">
import XtfFloatingBubble from "@/uni_modules/xtf-linkuiunix/components/xtf-floating-bubble/xtf-floating-bubble.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口,并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfFloatingBubble label="保存" :menu="fixture" @click="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfFloatingBubble from "@/uni_modules/xtf-linkuiunix/components/xtf-floating-bubble/xtf-floating-bubble.uvue"
const fixture = [{ key: 'add', label: '记一笔', icon: 'add' }, { key: 'scan', label: '扫码', icon: 'scan' }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-floating-bubble:click", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 disabled 状态
运行时切换 disabled,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfFloatingBubble label="保存" :disabled="state" />
<button class="doc-action-button" @click="toggleState">切换 disabled</button>
<text class="doc-state-text">disabled: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfFloatingBubble from "@/uni_modules/xtf-linkuiunix/components/xtf-floating-bubble/xtf-floating-bubble.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-action-button { margin-top: 16rpx; }
.doc-state-text { margin-top: 12rpx; color: #475569; font-size: 24rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
icon | string | "+" | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:template 行 12、template 行 13 | 需要提供业务文案或图标内容时设置。 |
label | string | "" | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:template 行 13、template 行 14 | 需要提供业务文案或图标内容时设置。 |
badge | string | number | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 15 | 需要覆盖组件默认业务值时设置。 |
menu | Array<any> | () => [] as Array<any> | 提供组件渲染或选择使用的数据集合;消费位置:script 行 52 | 数据驱动或选项渲染场景。 |
size | number | 104 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 45、script 行 148 | 需要覆盖组件默认业务值时设置。 |
color | string | "#2563eb" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 49 | 需要覆盖组件默认业务值时设置。 |
expanded | boolean | undefined | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 17、script 行 118 | 需要覆盖组件默认业务值时设置。 |
disabled | boolean | false | 参与组件运行逻辑;源码在 13 处读取该值;消费位置:script 行 20、script 行 36、script 行 40、script 行 71 | 需要控制显示、可用性或交互状态时设置。 |
variant | string | "solid" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 51、script 行 70 | 需要调整布局或视觉表现时设置。 |
shape | string | "circle" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 50 | 需要覆盖组件默认业务值时设置。 |
menuVariant | string | "solid" | 参与组件运行逻辑;源码在 7 处读取该值;消费位置:script 行 114、script 行 115 | 需要覆盖组件默认业务值时设置。 |
menuLayout | string | "fan" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 89 | 需要覆盖组件默认业务值时设置。 |
gradientEndColor | string | "" | 设置对应区域的颜色;消费位置:script 行 74 | 需要调整布局或视觉表现时设置。 |
textColor | string | "" | 设置对应区域的颜色;消费位置:script 行 51 | 需要调整布局或视觉表现时设置。 |
showPulse | boolean | true | 开关对应显示或交互行为;消费位置:script 行 36、script 行 40、template 行 11 | 需要控制显示、可用性或交互状态时设置。 |
showMask | boolean | true | 开关对应显示或交互行为;消费位置:template 行 3 | 需要控制显示、可用性或交互状态时设置。 |
closeOnMask | boolean | true | 开关对应显示或交互行为;消费位置:script 行 121 | 需要覆盖组件默认业务值时设置。 |
autoCollapse | boolean | true | 开关对应显示或交互行为;消费位置:script 行 120 | 需要覆盖组件默认业务值时设置。 |
animationType | string | "lift" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 101 | 需要覆盖组件默认业务值时设置。 |
animationDuration | string | number | 360 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 47 | 需要覆盖组件默认业务值时设置。 |
animationStagger | string | number | 42 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 48 | 需要覆盖组件默认业务值时设置。 |
dock | string | "auto" | 参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 67、script 行 138、script 行 147 | 需要覆盖组件默认业务值时设置。 |
defaultPosition | any | null | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 138、script 行 147 | 需要覆盖组件默认业务值时设置。 |
initialPosition | any | null | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 138、script 行 147 | 需要覆盖组件默认业务值时设置。 |
draggable | boolean | true | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 123、script 行 127、script 行 149 | 需要覆盖组件默认业务值时设置。 |
snapToEdge | boolean | true | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 136 | 需要覆盖组件默认业务值时设置。 |
edgeOffset | number | 24 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 46、script 行 148 | 需要覆盖组件默认业务值时设置。 |
gap | number | 0 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 80 | 需要覆盖组件默认业务值时设置。 |
customStyle | string | UTSJSONObject | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
click | toggle 内触发(script 行 119);参数表达式:{ expanded: expanded.value };前置 guard:props.disabled || Date.now() < suppressUntil | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
menu-select | select 内触发(script 行 120);参数表达式:item;前置 guard:props.disabled || item.disabled || !expanded.value || !menuActive.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:expanded | setExpanded 内触发(script 行 118);参数表达式:value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
change | setPosition 内触发(script 行 65);参数表达式:{ x: next.x, y: next.y } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
| - | - | 当前模板没有公开 slot。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
| - | - | 当前组件没有公开实例方法。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
position | position: inferred (ref) | 通过组件 ref 读取;这是公开状态,不可作为函数调用。 |
normalizedMenu | normalizedMenu: inferred (computed) | 通过组件 ref 读取;这是公开状态,不可作为函数调用。 |
主题说明
- 当前组件 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。