From 3c98937a4f49e1a875c778c26b29213369202e46 Mon Sep 17 00:00:00 2001 From: Frederico Estrela Gaiva Date: Tue, 28 Nov 2023 09:42:05 +0100 Subject: [PATCH] PF-1391 - Update README with new folder structured --- examples/breakout-rooms/README.md | 25 +++++++++++-------- .../src/components/Avatar/Avatar.tsx | 7 ++---- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/examples/breakout-rooms/README.md b/examples/breakout-rooms/README.md index 3a0e3793f..078977905 100644 --- a/examples/breakout-rooms/README.md +++ b/examples/breakout-rooms/README.md @@ -19,11 +19,10 @@ https://github.com/miroapp/app-examples/assets/7162412/c4c02dde-6680-4970-a51e-2 # ⚙️ Included Features - [Miro Web SDK](https://developers.miro.com/docs/web-sdk-reference) -- [Collaborative sessions](TODO) -- [Attention Management](TODO) +- [Collaborative sessions](https://developers.miro.com/docs/websdk-reference-session) +- [Attention Management](https://developers.miro.com/docs/websdk-reference-collaboration) - [Real-time events](TODO) -- [Real-time storage](TODO) -- [Timer](TODO) +- [Real-time storage](https://developers.miro.com/docs/websdk-reference-storage) # 🛠️ Tools and Technologies @@ -89,13 +88,17 @@ scopes: ``` . -├── src -│ ├── components -│ │ ├── BreakoutManager.tsx <-- Main React component displayed in the panel to facilitators -│ │ ├── ErrorBoundary.tsx <-- React error Boundary -│ │ ├── RoomConfig.tsx <-- React component to allow users to configure the rooms. -│ │ ├── Timer.tsx <-- React component to configure the timer. -│ │ └── WaitingRoom.tsx <-- React component displayed to other users in the board but the facilitator creating breakout rooms. +├── components +│ ├── Avatar +│ │ ├── Avatar.css +│ │ ├── Avatar.tsx +│ │ └── index.tsx +│ ├── BreakoutManager <-- Main React component displayed in the panel to facilitators +│ ├── BreakoutStarter <-- Component displayed when no rooms were configured +│ ├── RoomConfig <-- Component displayed for each configured room +│ ├── Timer <-- Timer controller component +│ ├── WaitingList <-- Component with unassigned users in the sessiin. +│ ├── WaitingRoom <-- Page displayed to participants while facilitator prepares the session. │ ├── app.tsx <-- The app typescript entrypoint used in the panel. │ ├── hooks.tsx <-- React hooks used in the app, including useCurrentUser, useBreakout, useTimer and some others. │ ├── index.ts <-- The app main typescript entrypoint, rendered inside the headless iframe. diff --git a/examples/breakout-rooms/src/components/Avatar/Avatar.tsx b/examples/breakout-rooms/src/components/Avatar/Avatar.tsx index c1b027da1..b6e170d48 100644 --- a/examples/breakout-rooms/src/components/Avatar/Avatar.tsx +++ b/examples/breakout-rooms/src/components/Avatar/Avatar.tsx @@ -39,12 +39,9 @@ const getUserColor = (user: OnlineUserInfo): string => { }; export const Avatar: React.FC = ({ user }) => { + const style = { "--color": getUserColor(user) } as React.CSSProperties; return ( -
+
{initials(user.name)}
);