Skip to content

UI 组件清单

列出 全部组件 与模板标签(含别名),及其对应的 JS Wrapper 类型。

Quick Start

xml
<!-- 在客户端模板(BUI)中使用组件 -->
<Panel id="root" class="container">
  <Label ref="title" text="Hello" />
  <Button ref="ok" text="确认" />
  <TextField ref="input" placeholder="输入文本..." />
</Panel>
js
// 在 JS 中获取引用并操作
const title = ref("title")
title.setValueString("标题文字")

const btn = ref("ok")
btn.setOnClick(() => closeUI())

TIP

所有组件均继承 UIElementWrapper 的通用方法(setVisibleaddClasssetBackground 等)。


1. 基础组件

组件标签说明JS Wrapper
UIElementPanel, div, element, uielement通用容器UIElementWrapper
LabelLabel文本显示(静态/动态)LabelWrapper
TextElementtext, textelement文本基类TextElementWrapper
ButtonButton, btn按钮ButtonWrapper

2. 输入组件

组件标签说明JS Wrapper
TextFieldTextField, input单行输入TextFieldWrapper
TextAreaTextArea多行输入TextAreaWrapper
ToggleToggle, checkbox复选ToggleWrapper
SwitchSwitch开关SwitchWrapper
SelectorSelector, select下拉选择SelectorWrapper
SearchComponentSearchComponent, search搜索选择SearchComponentWrapper
ColorSelectorColorSelector, colorpicker颜色选择ColorSelectorWrapper
TagFieldTagField, nbtfieldNBT/Tag 输入TagFieldWrapper

3. 容器组件

组件标签说明JS Wrapper
ScrollerViewScrollerView, scroll可滚动容器ScrollerViewWrapper
Scroller (V)vscroller, verticalscroller垂直滚动条ScrollerWrapper
Scroller (H)hscroller, horizontalscroller水平滚动条ScrollerWrapper
SplitView (H)splitview.horizontal, hsplitview, hsplit水平分割SplitViewWrapper
SplitView (V)splitview.vertical, vsplitview, vsplit垂直分割SplitViewWrapper
TabViewTabView, tabs标签页容器TabViewWrapper
TabTab标签页头TabWrapper
MenuMenu树形菜单MenuWrapper
TreeListTreeList树形列表TreeListWrapper
VirtualListVirtualList虚拟列表VirtualListWrapper
DialogDialog, modal对话框DialogWrapper
FormForm表单FormWrapper
FieldField表单字段FieldWrapper

4. 展示组件

组件标签说明JS Wrapper
ProgressBarProgressBar, progress进度条ProgressBarWrapper
GraphViewGraphView, graph可缩放画布GraphViewWrapper
EntityViewEntityView, entityviewer, entitydisplay实体展示EntityViewWrapper
ChatHistoryViewChatHistoryView, chat-history, chathistory聊天记录ChatHistoryViewWrapper
VideoPlayerVideoPlayer, video视频播放UIElementWrapper

WARNING

ChatHistoryView 的 JS Wrapper 是 ChatHistoryViewWrapper(提供 setChatFocused 方法),而非通用 UIElementWrapper

5. 槽位组件

组件标签说明JS Wrapper
DisplaySlotDisplaySlot, slot物品展示槽DisplaySlotWrapper
ItemSlotItemSlot, item-slot交互槽位ItemSlotWrapper
InventorySlotsInventorySlots, inventory玩家背包槽位InventorySlotsWrapper

6. Ponder 组件

组件标签说明JS Wrapper
PonderElementPonder, PonderElementPonder 场景视图PonderElementWrapper
PonderPlayerPonderPlayer, PonderUIPonder 播放器PonderPlayerWrapper
PonderRuntimeUIPonderRuntime, PonderRuntimeUI, PonderIndexPonder 索引视图PonderRuntimeUIWrapper

TIP

Ponder 组件的 JS Wrapper 提供完整的播放控制 API(播放/暂停/跳转等),详见 JS API 参考

7. 内置/特殊组件

组件标签说明JS Wrapper
TeleportTeleport, portal传送节点UIElementWrapper
KeepAliveKeepAlive组件缓存UIElementWrapper
SuspenseSuspense异步占位UIElementWrapper
Dynamic Componentcomponent :is=...动态组件UIElementWrapper