跳转到内容
搜索文档

RtkProvider

最后更新 查看 MarkdownAgent 设置

一个为 Flutter 应用程序初始化并提供 RealtimeKit 环境的基础 widget。RtkProvider 充当上下文包装器,用于设置 RealtimeKit 组件所需的设计令牌(design tokens)、客户端配置和 UI Kit 信息。

属性

属性 类型 必填 默认值 描述
child Widget - 组件树中此 widget 下方的 widget
meeting RealtimekitClient - 会议客户端实例
uiKitInfo RealtimeKitUIInfo - UI Kit 配置信息,包括设计令牌和 UI 设置
observers List<ProviderObserver>? null 用于调试的 Riverpod provider 观察器

使用示例

基本用法

import 'package:realtimekit_ui/realtimekit_ui.dart';

RtkProvider(
  meeting: yourMeetingInstance,
  uiKitInfo: yourUiKitInfo,
  child: MaterialApp(
    home: YourAppHome(),
  ),
)

带属性的用法

import 'package:realtimekit_ui/realtimekit_ui.dart';

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return RtkProvider(
      meeting: RealtimekitClient(
        // Client configuration
      ),
      uiKitInfo: RealtimeKitUIInfo(
        // UI Kit information and design tokens
      ),
      observers: [MyProviderObserver()],
      child: MaterialApp(
        home: HomeScreen(),
      ),
    );
  }
}

这篇文档对您有帮助吗?