跳转到主要内容

rtk-controlbar-button

{/* AUTO-GENERATED FILE. DO NOT EDIT MANUALLY. Any manual changes will be overwritten the next time the docs are generated.

Source: https://github.com/cloudflare/realtimekit-ui/blob/main/packages/core/src/components/rtk-controlbar-button/rtk-controlbar-button.tsx Generator: https://github.com/cloudflare/realtimekit-ui/blob/main/scripts/generate-stencil-docs.js

To update this page, edit the component source in the realtimekit-ui repository and submit a pull request against the staging branch; the changes will automatically sync here upon the next release. */}

A skeleton component used for composing custom controlbar buttons.

Properties

Property Type Required Default Description
brandIcon boolean ✅ - Whether icon requires brand color
disabled boolean ✅ - Whether button is disabled
icon string ✅ - Icon
iconPack IconPack ❌ defaultIconPack Icon pack
isLoading boolean ✅ - Loading state Ignores current icon and shows a spinner if true
label string ✅ - Label of button
showWarning boolean ✅ - Whether to show warning icon
size Size ✅ - Size
variant ControlBarVariant1 ✅ - Variant

Usage Examples

Basic Usage

<!-- component.html -->
<rtk-controlbar-button></rtk-controlbar-button>

With Properties

<!-- component.html -->
<rtk-controlbar-button
 [brandIcon]="true"
 [disabled]="true"
 icon="example">
</rtk-controlbar-button>
这篇文档对你有帮助吗？
想留言或继续讨论？请到 Cyberforums 赛博论坛参与。 参与讨论 / 回复