-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add flowchart for widgets rendering tree.
- Loading branch information
1 parent
e6de3b9
commit 9b682db
Showing
1 changed file
with
73 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Flowchart for widgets rendering tree | ||
|
||
## Rendering tree for LivekitRoom | ||
|
||
```mermaid | ||
flowchart TD | ||
A[LivekitRoom] --> B[LivekitRoomContext] | ||
style B fill:#f9f | ||
B --> D0[Prejoin] | ||
B --> D1[ChatWidget] | ||
B --> D2[ControlBar] | ||
B --> C1[ParticipantLoop] | ||
C1 --> C2[ParticipantContext] | ||
style C2 fill:#f9f | ||
C2 --> H[ParticipantWidget] | ||
H --> |loop for partcipant| C1 | ||
H --> |partcipant widgets| I[LayoutBuilder] | ||
I --> J[GridLayoutBuilder] | ||
I --> K[CarouselLayoutBuilder] | ||
``` | ||
|
||
## Rendering tree for ControlBar | ||
|
||
```mermaid | ||
flowchart TD | ||
A[ControlBar] --> B[LivekitRoomContext] | ||
style B fill:#f9f | ||
B --> D[MediaDeviceContext] | ||
style D fill:#f9f | ||
D --> E1[MicrophoneSelectButton] | ||
D --> E2[CameraSelectButton] | ||
D --> E3[ScreenShareToggle] | ||
D --> E4[AudioOutputSelectButton] | ||
B --> C2[ChatToggle] | ||
B --> C1[DisconnectButton] | ||
``` | ||
|
||
## Rendering tree for Prejoin | ||
|
||
```mermaid | ||
flowchart TD | ||
A[PrejoinWidget] --> B[LivekitRoomContext] | ||
style B fill:#f9f | ||
B --> C[CameraPreview] | ||
B --> D[MediaDeviceContext] | ||
style D fill:#f9f | ||
D --> E[MicrophoneSelectButton] | ||
D --> F[CameraSelectButton] | ||
A --> G1[URL Input] | ||
A --> G2[Token Input] | ||
B --> G3[JoinButton] | ||
``` | ||
|
||
## Rendering tree for Particpant | ||
|
||
```mermaid | ||
flowchart TD | ||
A[ParticipantWidget] --> B[ParticipantContext] | ||
style B fill:#f9f | ||
B --> C[IsSpeakingIndicator] | ||
C --> D1[AudioTrackWidget] | ||
C --> D2[VideoTrackWidget] | ||
B --> D3[FocusToggle] | ||
B --> D4[TrackStatsWidget] | ||
B --> D5[ParticipantStatusBar] | ||
D2 --> F[NoTrackWidget] | ||
D5 --> G1[ParticipantMutedIndicator] | ||
D5 --> G2[ParticipantName] | ||
D5 --> G3[ConnectionQualityIndicator] | ||
D5 --> G4[E2EEncryptionIndicator] | ||
``` |