Merge pull request #144 from element-hq/florianduros/ew-api/read-receipt

EW api: add option to enable read receipt and marker to be cleared on user activity

Author: florianduros

packages/element-web-module-api/element-web-module-api.api.md

@@ -357,6 +357,7 @@ export interface RoomListStoreApi {
 
 // @alpha
 export interface RoomViewProps {
+    enableReadReceiptsAndMarkersOnActivity?: boolean;
     hideComposer?: boolean;
     hideHeader?: boolean;
     hidePinnedMessageBanner?: boolean;

packages/element-web-module-api/src/api/builtins.ts

@@ -30,6 +30,12 @@ export interface RoomViewProps {
      * If true, the widgets will be hidden.
      */
     hideWidgets?: boolean;
+    /**
+     * If true, enable sending read receipts and markers on user activity in the room view. When the user interacts with the room view, read receipts and markers are sent.
+     * If false, the read receipts and markers are only send when the room view is focused. The user has to focus the room view in order to clear any unreads and to move the unread marker to the bottom of the view.
+     * @defaultValue true
+     */
+    enableReadReceiptsAndMarkersOnActivity?: boolean;
 }
 
 /**