Skip to content

feat(Fab): add Object type to the icon attr #4400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anlyyao merged 2 commits into from
Apr 8, 2026
Merged

feat(Fab): add Object type to the icon attr #4400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d2bff7
feat(Fab): add Object type to the icon attr
anlyyao Apr 7, 2026
bc00489
chore: stash changelog [ci skip]
tdesign-bot Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/components/fab/README.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ name | type | default | description | required
-- | -- | -- | -- | --
style | Object | - | CSS(Cascading Style Sheets) | N
custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on virtual component | N
button-props | Object | - | Typescript：`ButtonProps`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/fab/type.ts) | N
draggable | String / Boolean | false | Typescript：`boolean \| FabDirectionEnum ` `type FabDirectionEnum = 'all' \| 'vertical' \| 'horizontal'`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/fab/type.ts) | N
icon | String | - | \- | N
button-props | Object | - | Typescript: `ButtonProps`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/fab/type.ts) | N
draggable | String / Boolean | false | Typescript: `boolean \| FabDirectionEnum ` `type FabDirectionEnum = 'all' \| 'vertical' \| 'horizontal'`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/fab/type.ts) | N
icon | String / Object | - | icon name | N
text | String | - | \- | N
using-custom-navbar | Boolean | false | \- | N
y-bounds | Array | - | Typescript：`Array<string \| number>` | N
y-bounds | Array | - | Typescript: `Array<string \| number>` | N

### Fab Events

Expand Down
2 changes: 1 addition & 1 deletion packages/components/fab/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ style | Object | - | 样式 | N
custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
button-props | Object | - | 透传至 Button 组件。TS 类型：`ButtonProps`，[Button API Documents](./button?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/fab/type.ts) | N
draggable | String / Boolean | false | 是否可拖拽。`true` / `'all'`可拖动<br>`'vertical'`可垂直拖动<br>`'horizontal'`可水平拖动<br>`false`禁止拖动。TS 类型：`boolean \| FabDirectionEnum ` `type FabDirectionEnum = 'all' \| 'vertical' \| 'horizontal'`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/fab/type.ts) | N
icon | String | - | 图标 | N
icon | String / Object | - | 图标名称。值为字符串表示图标名称，值为 `Object` 类型，表示透传至 `icon` 组件 | N
text | String | - | 文本内容 | N
using-custom-navbar | Boolean | false | 是否使用了自定义导航栏 | N
y-bounds | Array | - | 设置垂直方向边界限制，示例：[48, 48] 或 ['96px', 80]。TS 类型：`Array<string \| number>` | N
Expand Down
4 changes: 2 additions & 2 deletions packages/components/fab/fab.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { SuperComponent, wxComponent } from '../common/src/index';
import config from '../common/config';
import props from './props';
import useCustomNavbar from '../mixins/using-custom-navbar';
import { unitConvert, systemInfo } from '../common/utils';
import { calcIcon, unitConvert, systemInfo } from '../common/utils';

const { prefix } = config;
const name = `${prefix}-fab`;
Expand Down Expand Up @@ -36,7 +36,7 @@ export default class Fab extends SuperComponent {
...baseButtonProps,
shape: this.properties.text ? 'round' : 'circle',
...this.properties.buttonProps,
icon: this.properties.icon,
icon: calcIcon(this.properties.icon),
content: this.properties.text,
ariaLabel: this.properties.ariaLabel,
},
Expand Down
5 changes: 2 additions & 3 deletions packages/components/fab/props.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,9 @@ const props: TdFabProps = {
type: null,
value: false,
},
/** 图标 */
/** 图标名称。值为字符串表示图标名称，值为 `Object` 类型，表示透传至 `icon` 组件 */
icon: {
type: String,
value: '',
type: null,
},
/** 悬浮按钮的样式，常用于调整位置（即将废弃，建议使用 `style`） */
style: {
Expand Down
7 changes: 3 additions & 4 deletions packages/components/fab/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,11 @@ export interface TdFabProps {
value?: boolean | FabDirectionEnum;
};
/**
* 图标
* @default ''
* 图标名称。值为字符串表示图标名称，值为 `Object` 类型，表示透传至 `icon` 组件
*/
icon?: {
type: StringConstructor;
value?: string;
type: null;
value?: string | object;
};
/**
* 悬浮按钮的样式，常用于调整位置（即将废弃，建议使用 `style`）
Expand Down
6 changes: 6 additions & 0 deletions packages/tdesign-miniprogram/.changelog/pr-4400.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
pr_number: 4400
contributor: anlyyao
---

- feat(Fab): 为 `icon` 属性新增 `Object` 类型，支持透传到图标组件 @anlyyao ([#4400](https://github.com/Tencent/tdesign-miniprogram/pull/4400))
Loading