Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
florianduros merged 2 commits into from
Dec 4, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8287c92
feat(ew-api): add `builtins#RoomViewProps#enableReadReceiptsAndMarker…
florianduros Nov 27, 2025
abe8e16
doc: update api md doc
florianduros Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/element-web-module-api/element-web-module-api.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,7 @@ export interface RoomListStoreApi {

// @alpha
export interface RoomViewProps {
enableReadReceiptsAndMarkersOnActivity?: boolean;
hideComposer?: boolean;
hideHeader?: boolean;
hidePinnedMessageBanner?: boolean;
Expand Down
6 changes: 6 additions & 0 deletions packages/element-web-module-api/src/api/builtins.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

/**
Expand Down