跳转到主要内容

RtkPipToggle

{/* 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-pip-toggle/rtk-pip-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 to turn Picture-in-Picture mode on or off when available. For example, a participant can keep the meeting video visible while using another app.

Properties

Property Type Required Default Description
config UIConfig1 ❌ createDefaultConfig() Config
iconPack IconPack1 ❌ defaultIconPack Icon pack
meeting Meeting ✅ - Meeting object
size Size1 ✅ - Size
states States1 ✅ - States object
t RtkI18n ❌ useLanguage() Language
variant ControlBarVariant ✅ - Variant

Usage Examples

Basic Usage

import { RtkPipToggle } from '@cloudflare/realtimekit-react-ui';

function MyComponent() {
  return <RtkPipToggle />;
}

With Properties

import { RtkPipToggle } from '@cloudflare/realtimekit-react-ui';

function MyComponent() {
  return (
    <RtkPipToggle
      meeting={meeting}
      size="md"
      variant="button"
    />
  );
}