From f8cbadaba564cf29e06a81261705882f2783c30f Mon Sep 17 00:00:00 2001
From: Travis Ralston <travpc@gmail.com>
Date: Thu, 14 May 2020 12:53:00 -0600
Subject: [PATCH] Clean up comments in skeleton components

---
 src/components/views/rooms/RoomList2.tsx    | 19 ++++++++++---------
 src/components/views/rooms/RoomSublist2.tsx | 16 +++++++++++++---
 src/components/views/rooms/RoomTile2.tsx    | 20 ++++++++++++++------
 3 files changed, 37 insertions(+), 18 deletions(-)

diff --git a/src/components/views/rooms/RoomList2.tsx b/src/components/views/rooms/RoomList2.tsx
index 402a7af014..12a0117505 100644
--- a/src/components/views/rooms/RoomList2.tsx
+++ b/src/components/views/rooms/RoomList2.tsx
@@ -29,6 +29,15 @@ import { ActionPayload } from "../../../dispatcher-types";
 import dis from "../../../dispatcher";
 import RoomSublist2 from "./RoomSublist2";
 
+/*******************************************************************
+ *   CAUTION                                                       *
+ *******************************************************************
+ * This is a work in progress implementation and isn't complete or *
+ * even useful as a component. Please avoid using it until this    *
+ * warning disappears.                                             *
+ *******************************************************************
+ */
+
 interface IProps {
     onKeyDown: (ev: React.KeyboardEvent) => void;
     onFocus: (ev: React.FocusEvent) => void;
@@ -152,6 +161,7 @@ export default class RoomList2 extends React.Component<IProps, IState> {
     }
 
     private prepareLayouts() {
+        // TODO: Change layout engine for FTUE support
         this.unfilteredLayout = new Layout((tagId: string, height: number) => {
             const sublist = this.sublistRefs[tagId];
             if (sublist) sublist.current.setHeight(height);
@@ -177,15 +187,6 @@ export default class RoomList2 extends React.Component<IProps, IState> {
         });
     }
 
-    private collectSublistRef(tagId: string, ref: React.RefObject<RoomSublist2>) {
-        // TODO: Is this needed?
-        if (!ref) {
-            delete this.sublistRefs[tagId];
-        } else {
-            this.sublistRefs[tagId] = ref;
-        }
-    }
-
     private renderSublists(): React.ReactElement[] {
         const components: React.ReactElement[] = [];
 
diff --git a/src/components/views/rooms/RoomSublist2.tsx b/src/components/views/rooms/RoomSublist2.tsx
index 21e58abd12..4c3f65b323 100644
--- a/src/components/views/rooms/RoomSublist2.tsx
+++ b/src/components/views/rooms/RoomSublist2.tsx
@@ -29,6 +29,15 @@ import AccessibleTooltipButton from "../../views/elements/AccessibleTooltipButto
 import * as FormattingUtils from '../../../utils/FormattingUtils';
 import RoomTile2 from "./RoomTile2";
 
+/*******************************************************************
+ *   CAUTION                                                       *
+ *******************************************************************
+ * This is a work in progress implementation and isn't complete or *
+ * even useful as a component. Please avoid using it until this    *
+ * warning disappears.                                             *
+ *******************************************************************
+ */
+
 interface IProps {
     forRooms: boolean;
     rooms?: Room[];
@@ -50,12 +59,11 @@ interface IProps {
 interface IState {
 }
 
-// TODO: Finish stub
 export default class RoomSublist2 extends React.Component<IProps, IState> {
     private headerButton = createRef();
 
     public setHeight(size: number) {
-        // TODO: Do a thing
+        // TODO: Do a thing (maybe - height changes are different in FTUE)
     }
 
     private hasTiles(): boolean {
@@ -107,8 +115,10 @@ export default class RoomSublist2 extends React.Component<IProps, IState> {
         return (
             <RovingTabIndexWrapper inputRef={this.headerButton}>
                 {({onFocus, isActive, ref}) => {
+                    // TODO: Use onFocus
                     const tabIndex = isActive ? 0 : -1;
 
+                    // TODO: Collapsed state
                     let badge;
                     if (true) { // !isCollapsed
                         const badgeClasses = classNames({
@@ -156,7 +166,7 @@ export default class RoomSublist2 extends React.Component<IProps, IState> {
                         );
                     }
 
-                    // TODO: a11y
+                    // TODO: a11y (see old component)
                     return (
                         <div className={"mx_RoomSubList_labelContainer"}>
                             <AccessibleButton
diff --git a/src/components/views/rooms/RoomTile2.tsx b/src/components/views/rooms/RoomTile2.tsx
index c4025fdb53..8f1b0a3f7a 100644
--- a/src/components/views/rooms/RoomTile2.tsx
+++ b/src/components/views/rooms/RoomTile2.tsx
@@ -31,12 +31,21 @@ import { EffectiveMembership, getEffectiveMembership } from "../../../stores/roo
 import * as Unread from '../../../Unread';
 import * as FormattingUtils from "../../../utils/FormattingUtils";
 
+/*******************************************************************
+ *   CAUTION                                                       *
+ *******************************************************************
+ * This is a work in progress implementation and isn't complete or *
+ * even useful as a component. Please avoid using it until this    *
+ * warning disappears.                                             *
+ *******************************************************************
+ */
+
 interface IProps {
     room: Room;
 
-    // TODO: Allow faslifying counts (for invites and stuff)
-    // TODO: Transparency?
-    // TODO: Incoming call?
+    // TODO: Allow falsifying counts (for invites and stuff)
+    // TODO: Transparency? Was this ever used?
+    // TODO: Incoming call boxes?
 }
 
 interface IBadgeState {
@@ -51,13 +60,11 @@ interface IState extends IBadgeState {
     hover: boolean;
 }
 
-// TODO: Finish stub
 export default class RoomTile2 extends React.Component<IProps, IState> {
     private roomTile = createRef();
 
     // TODO: Custom status
     // TODO: Lock icon
-    // TODO: DM indicator
     // TODO: Presence indicator
     // TODO: e2e shields
     // TODO: Handle changes to room aesthetics (name, join rules, etc)
@@ -78,7 +85,7 @@ export default class RoomTile2 extends React.Component<IProps, IState> {
     }
 
     public componentWillUnmount() {
-
+        // TODO: Listen for changes to the badge count and update as needed
     }
 
     private updateBadgeCount() {
@@ -168,6 +175,7 @@ export default class RoomTile2 extends React.Component<IProps, IState> {
             'mx_RoomTile_badgeShown': this.state.showBadge,
         });
 
+        // TODO: Support collapsed state properly
         let tooltip = null;
         if (false) { // isCollapsed
             if (this.state.hover) {