Skip to content

Add generic solution for 'mark as read' in list views #6420

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
BurntimeX merged 1 commit into from
Aug 7, 2025
Merged

Add generic solution for 'mark as read' in list views #6420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions ts/WoltLabSuite/Core/Component/ListView/State.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,12 @@
* @since 6.2
*/

import { wheneverFirstSeen } from "WoltLabSuite/Core/Helper/Selector";
import Filter from "./Filter";
import Selection from "./Selection";
import Sorting from "./Sorting";
import { postObject } from "WoltLabSuite/Core/Api/PostObject";
import { promiseMutex } from "WoltLabSuite/Core/Helper/PromiseMutex";

export const enum StateChangeCause {
Change,
Expand Down Expand Up @@ -71,6 +74,18 @@ export class State extends EventTarget {
this.#handlePopState();
});

wheneverFirstSeen(`#${viewId}_items .listView__item__markAsRead`, (button: HTMLButtonElement) => {
button.addEventListener(
"click",
promiseMutex(async () => {
await postObject(button.dataset.endpoint!);
button
.closest(".listView__item")
?.dispatchEvent(new CustomEvent("interaction:invalidate", { bubbles: true }));
}),
);
});

this.#updatePaginationUrl();
this.#updateListViewFooter();
}
Expand Down
10 changes: 9 additions & 1 deletion wcfsetup/install/files/js/WoltLabSuite/Core/Component/ListView/State.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 32 additions & 0 deletions wcfsetup/install/files/lib/system/listView/AbstractListView.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace wcf\system\listView;

use wcf\action\ApiAction;
use wcf\action\ListViewFilterAction;
use wcf\data\DatabaseObject;
use wcf\data\DatabaseObjectDecorator;
Expand All @@ -16,6 +17,7 @@
use wcf\system\listView\filter\exception\InvalidFilterValue;
use wcf\system\request\LinkHandler;
use wcf\system\WCF;
use wcf\util\StringUtil;

/**
* Abstract implementation of a list view.
Expand Down Expand Up @@ -48,6 +50,7 @@ abstract class AbstractListView
private bool $allowInteractions = true;
private bool $allowBulkInteractions = true;
private int $fixedNumberOfItems = 0;
private string $markAsReadEndpoint = '';

/**
* @var array<string, string>
Expand Down Expand Up @@ -673,6 +676,35 @@ public function getContainerCssClassName(): string
return $this->containerCssClassName;
}

public function setMarkAsReadEndpoints(string $endpoint): void
{
$this->markAsReadEndpoint = $endpoint;
}

public function renderMarkAsReadButton(DatabaseObject $object): string
{
if (!$this->markAsReadEndpoint) {
throw new \BadMethodCallException("No mark as read endpoint has been specified.");
}

$endpoint = StringUtil::encodeHTML(
LinkHandler::getInstance()->getControllerLink(ApiAction::class, ['id' => 'rpc']) .
\sprintf($this->markAsReadEndpoint, $object->getObjectID())
);
$title = WCF::getLanguage()->get('wcf.global.button.markAsRead');

return <<<HTML
<button
type="button"
class="listView__item__markAsRead jsTooltip"
title="{$title}"
data-endpoint="{$endpoint}"
>
<span class="listView__item__unread__indicator" aria-hidden="true"></span>
</button>
HTML;
}

/**
* @return TDatabaseObjectList
*/
Expand Down
19 changes: 1 addition & 18 deletions wcfsetup/install/files/style/ui/discussionList.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,29 +140,12 @@
grid-template-rows: min-content min-content 1fr;
}

.discussionList__item__markAsRead {
align-items: center;
.discussionList__item .listView__item__markAsRead {
grid-area: markAsRead;
display: flex;
padding: 0 5px;
margin-right: 5px;
z-index: 1;
}

.discussionList__item__unread__indicator {
background-color: var(--wcfButtonPrimaryBackground);
border-radius: 50%;
display: inline-block;
height: 10px;
width: 10px;
}

@media (hover: hover) {
.discussionList__item__markAsRead:hover .discussionList__item__unread__indicator {
background-color: var(--wcfButtonPrimaryBackgroundActive);
}
}

.discussionList__item__title {
grid-area: title;

Expand Down
20 changes: 20 additions & 0 deletions wcfsetup/install/files/style/ui/listView.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,3 +114,23 @@
display: flex;
padding: 0 6px;
}

.listView__item__markAsRead {
align-items: center;
display: flex;
padding: 0 5px;
}

.listView__item__unread__indicator {
background-color: var(--wcfButtonPrimaryBackground);
border-radius: 50%;
display: inline-block;
height: 10px;
width: 10px;
}

@media (hover: hover) {
.listView__item__markAsRead:hover .listView__item__unread__indicator {
background-color: var(--wcfButtonPrimaryBackgroundActive);
}
}