跳转到主要内容

RtkNetworkIndicator

{/* 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-network-indicator/rtk-network-indicator.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. */}

Properties

Property Type Required Default Description
iconPack IconPack1 ❌ defaultIconPack Icon pack
isScreenShare boolean ✅ - Is for screenshare
meeting Meeting ✅ - Meeting
participant Peer ✅ - Participant or Self
t RtkI18n1 ❌ useLanguage() Language

Usage Examples

Basic Usage

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

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

With Properties

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

function MyComponent() {
  return (
    <RtkNetworkIndicator
      isScreenShare={true}
      meeting={meeting}
      participant={participant}
    />
  );
}