Skip to content

RtkDialog

Last updated View as MarkdownAgent setup

A dialog component.

Properties

Property Type Required Default Description
config UIConfig ❌ createDefaultConfig() UI Config
disableEscapeKey boolean ✅ - Whether Escape key can close the modal
hideCloseButton boolean ✅ - Whether to show the close button
iconPack IconPack ❌ defaultIconPack Icon pack
meeting Meeting ✅ - Meeting object
open boolean ✅ - Whether a dialog is open or not
size Size ✅ - Size
states States ✅ - States object
t RtkI18n ❌ useLanguage() Language

Usage Examples

Basic Usage

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

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

With Properties

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

function MyComponent() {
  return (
    <RtkDialog
      disableEscapeKey={true}
      hideCloseButton={true}
      meeting={meeting}
    />
  );
}

Was this helpful?