Commit 996f8766 authored by Robert Knight's avatar Robert Knight

Add a note about why the thread list is virtualized

Several new developers have in the past asked why we use virtualization
since it adds complexity to the thread list implementation. Add a note
to the `ThreadList` docs explaining why it is needed.
parent ebee0db9
...@@ -25,8 +25,13 @@ function getScrollContainer() { ...@@ -25,8 +25,13 @@ function getScrollContainer() {
} }
/** /**
* Render a list of threads, but only render those that are in or near the * Render a list of threads.
* current browser viewport. *
* The thread list is "virtualized", meaning that only threads in or near the
* viewport are rendered. This is critical for performance and memory usage as
* annotations (and replies) are complex interactive components whose
* user-defined content may include rich media such as images, audio clips,
* embedded YouTube videos, rendered math and more.
*/ */
function ThreadList({ thread, $rootScope }) { function ThreadList({ thread, $rootScope }) {
const clearSelection = useStore(store => store.clearSelection); const clearSelection = useStore(store => store.clearSelection);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment