TAYUN 9132174b11
docs: ✏️ 修复基础组件文档问题 - 阶段一完成 (#1220)
* docs(button): 更新按钮组件文档对开放能力的描述

- 修改 session-message-title 和 session-message-path 属性名称
- 新增 chooseavatar 和 agreeprivacyauthorization 事件回调

* docs(icon): 更新图标组件文档

- 调整属性描述,明确 name 属性可用于图标名称或图片链接
- 添加事件列表,明确 click 事件的参数
- 移除英文示例代码中不必要的示例和图标列表
- 优化文档结构和格式,使信息更加清晰

* docs(config-provider): 更新全局配置组件文档

- 调整文档中的强调样式,使用加粗替代下划线
- 完善英文文档缺失的内容,保持和中文文档一致

* docs(component): 更新 Popup 组件文档

- 调整文档结构,优化标题层级
- 添加 v-model 使用示例,明确组件绑定值
- 移除冗余的代码示例,精简文档内容
- 更新属性表格,统一属性描述
- 添加防止滚动穿透的解决方案说明

* docs(resize):  ✏️ 更新 resize 组件文档

- 修正事件名称从 `size` 改为 `resize`
- 添加组件属性(Attributes)、事件(Events)和插槽(Slots)的详细说明
- 更新文档结构,使其更加完整和易于理解

* docs(transition): ✏️完善Transition 动画组件文档的属性和事件描述

- 增加自定义根节点样式类、懒渲染、动画结束后销毁子节点等属性
- 添加进入和离开过渡的开始、激活和结束状态类
- 新增点击事件和默认插槽
- 更新文档以反映新增功能

* docs(fab): ✏️更新fab组件文档

- 优化了文档结构,调整了部分格式
- 添加了 Methods 和 default Slot 相关的信息
- 更新了 custom-style 属性的命名

* docs(component): ✏️ 更新 Text 组件文档

- 优化文档格式,调整表格结构
- 添加缺失的参数说明和示例代码
- 更新参数类型和默认值
- 增加 call 参数说明
- 补充 Slots 表格

* docs(root-portal):  ✏️ 更新组件文档

- 添加 Attributes 和 Events 部分,说明该组件无相关配置
- 修正 Slots 部分的版本信息,统一为 1.11.0
- 更新中文和英文文档
2025-08-17 14:08:48 +08:00

8.5 KiB
Raw Blame History

Fab 悬浮按钮

悬浮动作按钮组件,按下可显示一组动作按钮。

:::warning 因为uni-app组件无法监听点击自己以外的地方,为了在点击页面其他地方时,可以自动关闭 fab ,建议使用组件库的 useQueue hook会关闭所有 dropmenu、popover、toast、swipeAction、fab在页面的根元素上监听点击事件的冒泡。

如果存在用户手动点击 fab 以外某个地方如按钮滑出 fab 的场景,则需要在点击的元素(在这里是按钮)加上 click.stop="" 阻止事件冒泡到根元素上,避免触发 closeOutside把要手动打开的 fab 关闭了。 :::

基本用法

通过type设置悬浮按钮触发器的类型,position设置悬浮按钮触发器的位置,direction设置动作按钮的打开方向,disabled设置悬浮按钮是否禁用。

<wd-fab :disabled="disabled" :type="type" :position="position" :direction="direction">
  <wd-button @click="showToast('一键三连')" :disabled="disabled" custom-class="custom-button" type="primary" round>
    <wd-icon name="github-filled" size="22px"></wd-icon>
  </wd-button>
  <wd-button @click="showToast('我要收藏')" :disabled="disabled" custom-class="custom-button" type="success" round>
    <wd-icon name="star" size="22px"></wd-icon>
  </wd-button>

  <wd-button @click="showToast('我要投币')" :disabled="disabled" custom-class="custom-button" type="error" round>
    <wd-icon name="money-circle" size="22px"></wd-icon>
  </wd-button>
  <wd-button @click="showToast('我要点赞')" :disabled="disabled" custom-class="custom-button" type="warning" round>
    <wd-icon name="thumb-up" size="22px"></wd-icon>
  </wd-button>
</wd-fab>
import { useToast } from '@/uni_modules/wot-design-uni'
const { show: showToast } = useToast()
const type = ref<'primary' | 'success' | 'info' | 'warning' | 'error' | 'default'>('primary')
const position = ref<'left-top' | 'right-top' | 'left-bottom' | 'right-bottom' | 'left-center' | 'right-center' | 'top-center' | 'bottom-center'>(
  'left-bottom'
)
const direction = ref<'top' | 'right' | 'bottom' | 'left'>('top')
const disabled = ref<boolean>(false)
:deep(.custom-button) {
  min-width: auto !important;
  box-sizing: border-box;
  width: 32px !important;
  height: 32px !important;
  border-radius: 16px !important;
  margin: 8rpx;
}

:deep(.custom-radio) {
  height: 32px !important;
  line-height: 32px !important;
}

动作菜单展开/收起

通过v-model:active控制动作按钮菜单的展开/收起

<wd-fab v-model:active="active"></wd-fab>
const active = ref<boolean>(false)

可拖动按钮

<wd-fab :draggable="true"></wd-fab>

:::warning 开启拖动后direction属性将失效,会根据拖动后的位置自动计算弹出方向。拖动完成后按钮将会自动吸边。 :::

自定义触发器

通过trigger插槽自定义触发器,expandable控制点击触发器是否展开/收起动作按钮菜单。

<wd-fab position="left-bottom" :expandable="false">
  <template #trigger>
    <wd-button @click="handleClick" icon="share" type="error">分享给朋友</wd-button>
  </template>
</wd-fab>
const handleClick = () => {
  console.log('点击了')
}

Attributes

参数 说明 类型 可选值 默认值 最低版本
v-model:active 是否激活 boolean - false 0.1.57
type 类型 FabType 'primary' | 'success' | 'info' | 'warning' | 'error' | 'default' 'primary' 0.1.57
position 悬浮按钮位置 FabPosition 'left-top' | 'right-top' | 'left-bottom' | 'right-bottom' | left-center | right-center | top-center | bottom-center 'right-bottom' 0.1.57
draggable 按钮能否拖动 boolean false 1.2.19
direction 悬浮按钮菜单弹出方向 FabDirection 'top' | 'right' | 'bottom' | 'left' 'top' 0.1.57
disabled 是否禁用 boolean - false 0.1.57
inactiveIcon 悬浮按钮未展开时的图标 string - 'add' 0.1.57
activeIcon 悬浮按钮展开时的图标 string - 'close' 0.1.57
zIndex 自定义悬浮按钮层级 number - 99 0.1.57
gap 自定义悬浮按钮与可视区域边缘的间距 FabGap - { top: 16, left: 16, right: 16, bottom: 16 } 1.2.26
custom-style 自定义样式 string - '' 0.1.57
expandable 用于控制点击时是否展开菜单,设置为 false 时触发 click boolean - true 1.3.11

Events

事件名称 说明 参数 最低版本
click expandable 设置为 false 时,点击悬浮按钮触发 1.3.11

Methods

方法名 说明 参数 最低版本
open 展开菜单 - 0.1.57
close 收起菜单 - 0.1.57

Slot

name 说明 最低版本
default 动作按钮,通常放置多个按钮 0.1.57
trigger 触发器插槽,用于自定义点击按钮,使用此插槽时组件不会抛出 click 1.3.11

外部样式类

类名 说明 最低版本
custom-class 自定义样式类 0.1.57