Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
pcx_content_type: navigation
title: Flutter
description: Complete API reference for Flutter library components
sidebar:
group:
hideIndex: true
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
pcx_content_type: navigation
title: RtkAudioIndicatorIconWidget
description: API reference for RtkAudioIndicatorIconWidget component (Flutter Library)
---

A widget that displays the audio status of a participant in a RealtimeKit meeting.

:::note
[`RtkProvider`](/realtime/realtimekit/ui-kit/api-reference/flutter/rtk-provider/) must be an ancestor of this widget in the widget tree.
:::

## Properties

| Property | Type | Required | Default | Description |
| ------------- | ----------------------- | -------- | ------- | --------------------------------------------- |
| `participant` | `RtkMeetingParticipant` | ✅ | - | The participant whose audio status to display |
| `iconSize` | `double?` | ❌ | `24` | Size of the audio indicator icon |

## Usage Examples

### Basic Usage

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';

RtkAudioIndicatorIconWidget(
participant: participant,
)
```

### With Properties

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';

RtkAudioIndicatorIconWidget(
participant: participant,
iconSize: 32.0,
)
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
pcx_content_type: navigation
title: RtkChatIconWidget
description: API reference for RtkChatIconWidget component (Flutter Library)
---

A widget that displays a chat icon, navigates to the chat page when pressed, and marks all messages as read.

:::note
[`RtkProvider`](/realtime/realtimekit/ui-kit/api-reference/flutter/rtk-provider/) must be an ancestor of this widget in the widget tree.
:::

## Properties

This component does not accept any properties. It uses the `RealtimekitClient` from the nearest [`RtkProvider`](/realtime/realtimekit/ui-kit/api-reference/flutter/rtk-provider/) ancestor.

## Usage Examples

### Basic Usage

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';

RtkChatIconWidget()
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
pcx_content_type: navigation
title: RtkJoinButton
description: API reference for RtkJoinButton component (Flutter Library)
---

A button widget for joining a RealtimeKit meeting room. Provides visual feedback during the joining process.

## Properties

| Property | Type | Required | Default | Description |
| ----------------- | ------------------- | -------- | -------------------- | ------------------------------------------- |
| `meeting` | `RealtimekitClient` | ✅ | - | Meeting client instance |
| `onMeetingJoined` | `VoidCallback?` | ❌ | - | Callback invoked when the meeting is joined |
| `rtkDesignToken` | `RtkDesignTokens?` | ❌ | Global design tokens | Design tokens for customization |
| `height` | `double?` | ❌ | - | Height of the button |
| `width` | `double?` | ❌ | - | Width of the button |
| `isDisabled` | `bool` | ❌ | `false` | Whether the button is disabled |

## Usage Examples

### Basic Usage

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';

RtkJoinButton(
meeting: yourMeetingInstance,
)
```

### With Properties

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';

RtkJoinButton(
meeting: yourMeetingInstance,
onMeetingJoined: () {
// Handle successful join
},
height: 50.0,
width: 200.0,
isDisabled: false,
)
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
pcx_content_type: navigation
title: RtkLeaveButton
description: API reference for RtkLeaveButton component (Flutter Library)
---

A button widget for leaving a RealtimeKit meeting. Displays a confirmation dialog to prevent accidental meeting exits.

## Properties

| Property | Type | Required | Default | Description |
| ----------------------- | ------------------- | -------- | -------------------- | ------------------------------- |
| `meeting` | `RealtimekitClient` || - | Meeting client instance |
| `individualDesignToken` | `RtkDesignTokens?` || Global design tokens | Design tokens for customization |
| `height` | `double?` || - | Height of the button |
| `width` | `double?` || - | Width of the button |

## Usage Examples

### Basic Usage

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';
RtkLeaveButton(
meeting: yourMeetingInstance,
)
```

### With Properties

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';
RtkLeaveButton(
meeting: yourMeetingInstance,
individualDesignToken: yourDesignToken,
height: 50.0,
width: 50.0,
)
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
pcx_content_type: navigation
title: RtkLeaveMeetingDialog
description: API reference for RtkLeaveMeetingDialog component (Flutter Library)
---

A dialog widget for confirming the action of leaving a RealtimeKit meeting. Provides a prompt with cancel and leave options, and displays an additional end-meeting option for hosts.

## Properties

| Property | Type | Required | Default | Description |
| ------------- | ------------------- | -------- | -------------------- | ------------------------------- |
| `meeting` | `RealtimekitClient` || - | Meeting client instance |
| `designToken` | `RtkDesignTokens?` || Global design tokens | Design tokens for customization |

## Usage Examples

### Basic Usage

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';
RtkLeaveMeetingDialog(
meeting: yourMeetingInstance,
)
```

### With Properties

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';
RtkLeaveMeetingDialog(
meeting: yourMeetingInstance,
designToken: yourDesignToken,
)
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
pcx_content_type: navigation
title: RtkMeetingTitle
description: API reference for RtkMeetingTitle component (Flutter Library)
---

A widget that displays the title of a RealtimeKit meeting. Integrates with the RealtimeKit design system for consistent styling.

## Properties

| Property | Type | Required | Default | Description |
| ----------------------- | ------------------- | -------- | -------------------- | ------------------------------- |
| `meeting` | `RealtimekitClient` | ✅ | - | Meeting client instance |
| `individualDesignToken` | `RtkDesignTokens?` | ❌ | Global design tokens | Design tokens for customization |

## Usage Examples

### Basic Usage

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';

RtkMeetingTitle(
meeting: yourMeetingInstance,
)
```

### With Properties

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';

RtkMeetingTitle(
meeting: yourMeetingInstance,
individualDesignToken: yourDesignToken,
)
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
pcx_content_type: navigation
title: RtkNameTag
description: API reference for RtkNameTag component (Flutter Library)
---

A widget that displays the name tag of a participant within a participant tile.

:::note
[`RtkProvider`](/realtime/realtimekit/ui-kit/api-reference/flutter/rtk-provider/) must be an ancestor of this widget in the widget tree.
:::

## Properties

| Property | Type | Required | Default | Description |
| ------------- | ----------------------- | -------- | ------- | ------------------------------------------- |
| `participant` | `RtkMeetingParticipant` | ✅ | - | The participant whose name to display |
| `size` | `double` | ✅ | - | Size constraint for the name tag |
| `color` | `Color` | ✅ | - | Color of the name tag text |
| `factor` | `double` | ❌ | `7` | Font size factor (fontSize = size / factor) |

## Usage Examples

### Basic Usage

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';

RtkNameTag(
participant: participant,
size: 14.0,
color: Colors.white,
)
```

### With Properties

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';

RtkNameTag(
participant: participant,
size: 20.0,
color: Colors.white,
factor: 5,
)
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
pcx_content_type: navigation
title: RtkParticipantTile
description: API reference for RtkParticipantTile component (Flutter Library)
---

A widget that displays a participant's video or avatar within a meeting environment. Automatically shows the video feed when available and falls back to the participant's avatar.

:::note
[`RtkProvider`](/realtime/realtimekit/ui-kit/api-reference/flutter/rtk-provider/) must be an ancestor of this widget in the widget tree.
:::

## Properties

| Property | Type | Required | Default | Description |
| ------------- | ----------------------- | -------- | -------------------- | ------------------------------------------------- |
| `participant` | `RtkMeetingParticipant` | ✅ | - | The participant to display (positional parameter) |
| `designToken` | `RtkDesignTokens?` | ❌ | Global design tokens | Design tokens for customization |
| `height` | `double` | ❌ | `240` | Height of the tile |
| `width` | `double` | ❌ | `180` | Width of the tile |

:::note
The `participant` parameter is positional. Pass it without a named argument: `RtkParticipantTile(participant)`.
:::

## Usage Examples

### Basic Usage

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';

RtkParticipantTile(
participant,
)
```

### With Properties

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';

RtkParticipantTile(
participant,
designToken: yourDesignToken,
height: 300,
width: 200,
)
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
pcx_content_type: navigation
title: RtkParticipantsIconWidget
description: API reference for RtkParticipantsIconWidget component (Flutter Library)
---

A widget that displays a participants icon and navigates to the participants list when pressed.

:::note
[`RtkProvider`](/realtime/realtimekit/ui-kit/api-reference/flutter/rtk-provider/) must be an ancestor of this widget in the widget tree.
:::

## Properties

This component does not accept any properties. It uses the `RealtimekitClient` from the nearest [`RtkProvider`](/realtime/realtimekit/ui-kit/api-reference/flutter/rtk-provider/) ancestor.

## Usage Examples

### Basic Usage

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';

RtkParticipantsIconWidget()
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
pcx_content_type: navigation
title: RtkPluginIconWidget
description: API reference for RtkPluginIconWidget component (Flutter Library)
---

A widget that displays a plugins icon and navigates to the plugins list when pressed.

:::note
[`RtkProvider`](/realtime/realtimekit/ui-kit/api-reference/flutter/rtk-provider/) must be an ancestor of this widget in the widget tree.
:::

## Properties

This component does not accept any properties. It uses the `RealtimekitClient` from the nearest [`RtkProvider`](/realtime/realtimekit/ui-kit/api-reference/flutter/rtk-provider/) ancestor.

## Usage Examples

### Basic Usage

```dart
import 'package:realtimekit_ui/realtimekit_ui.dart';

RtkPluginIconWidget()
```
Loading
Loading