Skip to content

Commit

Permalink
PF-1391 - Update README with new folder structured
Browse files Browse the repository at this point in the history
  • Loading branch information
fredcido committed Nov 28, 2023
1 parent 383c5b4 commit 3c98937
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
25 changes: 14 additions & 11 deletions examples/breakout-rooms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,10 @@ https://github.com/miroapp/app-examples/assets/7162412/c4c02dde-6680-4970-a51e-2
# βš™οΈ Included Features <a name="features"></a>

- [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 <a name="tools"></a>

Expand Down Expand Up @@ -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.
Expand Down
7 changes: 2 additions & 5 deletions examples/breakout-rooms/src/components/Avatar/Avatar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,9 @@ const getUserColor = (user: OnlineUserInfo): string => {
};

export const Avatar: React.FC<Props> = ({ user }) => {
const style = { "--color": getUserColor(user) } as React.CSSProperties;
return (
<div
className="avatar"
key={user.id}
style={{ "--color": getUserColor(user) }}
>
<div className="avatar" key={user.id} style={style}>
{initials(user.name)}
</div>
);
Expand Down

0 comments on commit 3c98937

Please sign in to comment.