The ThreadList component renders the list of threads created with a given location (see the location property in the Threadcomponent). It provides a quick way for users to view multiple conversations.
If false, when the thread list has no threads, it will show a completely empty container. If set to true, it will instead show a placeholder, containing a description of the types of threads a user will see.
Toggles whether, if there is a FloatingThread component at the same location, opening a thread should highlight that thread in the ThreadList. The color of the highlight is configurable with CSS. The default setting is set to true.
If highlightThreadId is passed in, it will disable
highlightOpenFloatingThread.
Passing a thread id will highlight that thread in the ThreadList if it exists. The color of the highlight is configurable with CSS. If highlightThreadId is used,
it will disable highlightOpenFloatingThread.
A serialized JSON object that can be used to filter the threads in the ThreadList. Currently the only valid key is metadata. The value for a metadata entry should be an object representing the metadata key/value to filter on. For example, to show only threads with the metadata key of "category" set to "sales", set the filter to { metadata: { category: "sales" } }.
Callback invoked when one of the threads in the list is clicked. The callback is passed two arguments: the ID of the thread which was clicked, and the summary of the thread which was clicked. For example, you could use this event to scroll the clicked thread into view.
Callback invoked when one of the threads fires a mouseenter event. For example, you could use this event to highlight the section of a webpage being discussed in the hovered thread.
Callback invoked when the cursor leaves one of the threads. For example, you could use this event to terminate the special behavior initiated with onThreadMouseEnter.