跳转到主要内容

rtk-setup-screen

{/* 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-setup-screen/rtk-setup-screen.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 screen shown before joining the meeting, where you can edit your display name, and media settings.

Properties

Property Type Required Default Description
config UIConfig ❌ createDefaultConfig() Config object
iconPack IconPack ❌ defaultIconPack Icon pack
meeting Meeting ✅ - Meeting object
size Size ✅ - Size
states States ✅ - States object
t RtkI18n ❌ useLanguage() Language

Usage Examples

Basic Usage

<!-- component.html -->
<rtk-setup-screen></rtk-setup-screen>

With Properties

<!-- component.html -->
<rtk-setup-screen
 [meeting]="meeting"
 size="md">
</rtk-setup-screen>