Skip to content

RtkProvider

A foundational widget that initializes and provides the RealtimeKit environment for a Flutter application. RtkProvider acts as a context wrapper that sets up design tokens, client configurations, and UI Kit information required by RealtimeKit components.

Properties

PropertyTypeRequiredDefaultDescription
childWidget-The widget below this widget in the tree
meetingRealtimekitClient-Meeting client instance
uiKitInfoRealtimeKitUIInfo-UI Kit configuration info including design tokens and UI settings
observersList<ProviderObserver>?nullRiverpod provider observers for debugging

Usage Examples

Basic Usage

Dart
import 'package:realtimekit_ui/realtimekit_ui.dart';
RtkProvider(
meeting: yourMeetingInstance,
uiKitInfo: yourUiKitInfo,
child: MaterialApp(
home: YourAppHome(),
),
)

With Properties

Dart
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(),
),
);
}
}