rtk-sidebar
{/* 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-sidebar/rtk-sidebar.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 component which handles the sidebar and you can customize which sections you want, and which section you want as the default.
Properties
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
config |
UIConfig |
❌ | createDefaultConfig() |
Config |
defaultSection |
RtkSidebarSection |
✅ | - | Default section |
enabledSections |
RtkSidebarTab[] |
✅ | - | Enabled sections in sidebar |
iconPack |
IconPack |
❌ | defaultIconPack |
Icon pack |
meeting |
Meeting |
✅ | - | Meeting object |
size |
Size |
✅ | - | Size |
states |
States |
✅ | - | States object |
t |
RtkI18n |
❌ | useLanguage() |
Language |
view |
RtkSidebarView |
✅ | - | View type |
Usage Examples
Basic Usage
<!-- component.html -->
<rtk-sidebar></rtk-sidebar>
With Properties
<!-- component.html -->
<rtk-sidebar
[defaultSection]="rtksidebarsection"
[enabledSections]="[]"
[meeting]="meeting">
</rtk-sidebar>
这篇文档对你有帮助吗？
谢谢你的反馈！