rtk-polls-toggle

---

• Properties
• Usage Examples
• Basic Usage
• With Properties

---

{/* 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-polls-toggle/rtk-polls-toggle.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 button which toggles visibility of polls. You need to pass the meeting object to it to see the unread polls count badge. When clicked it emits a rtkStateUpdate event with the data:

{ activeSidebar: boolean; sidebar: 'polls' }

Properties

Property	Type	Required	Default	Description
iconPack	IconPack	❌	defaultIconPack	Icon pack
meeting	Meeting	✅	-	Meeting object
size	Size	✅	-	Size
states	States	✅	-	States object
t	RtkI18n	❌	useLanguage()	Language
variant	ControlBarVariant	✅	-	Variant

Usage Examples

Basic Usage

<!-- component.html -->
<rtk-polls-toggle></rtk-polls-toggle>

With Properties

<!-- component.html -->
<rtk-polls-toggle
 [meeting]="meeting"
 size="md"
 variant="button">
</rtk-polls-toggle>