Add support for list view parameters

Author: BurntimeX

com.woltlab.wcf/templates/shared_listView.tpl

@@ -83,7 +83,12 @@
 			{$view->getPageNo()},
 			'{unsafe:$view->getBaseUrl()|encodeJS}',
 			'{unsafe:$view->getSortField()|encodeJS}',
-			'{unsafe:$view->getSortOrder()|encodeJS}'
+			'{unsafe:$view->getSortOrder()|encodeJS}',
+			new Map([
+				{foreach from=$view->getParameters() key='name' item='value'}
+					['{unsafe:$name|encodeJS}', '{unsafe:$value|encodeJS}'],
+				{/foreach}
+			]),
 		);
 	});
 </script>

ts/WoltLabSuite/Core/Api/ListViews/GetItems.ts

@@ -37,7 +37,7 @@ export async function getItems(
   }
   if (listViewParameters) {
     listViewParameters.forEach((value, key) => {
-      url.searchParams.set(`gridViewParameters[${key}]`, value);
+      url.searchParams.set(`listViewParameters[${key}]`, value);
     });
   }
 

ts/WoltLabSuite/Core/Component/ListView.ts

@@ -12,6 +12,7 @@ export class ListView {
   readonly #viewElement: HTMLElement;
   readonly #state: State;
   readonly #noItemsNotice: HTMLElement;
+  #listViewParameters?: Map<string, string>;
 
   constructor(
     viewId: string,
@@ -20,10 +21,12 @@ export class ListView {
     baseUrl: string = "",
     sortField = "",
     sortOrder = "ASC",
+    listViewParameters?: Map<string, string>,
   ) {
     this.#viewClassName = viewClassName;
     this.#viewElement = document.getElementById(`${viewId}_items`) as HTMLTableElement;
     this.#noItemsNotice = document.getElementById(`${viewId}_noItemsNotice`) as HTMLElement;
+    this.#listViewParameters = listViewParameters;
 
     this.#initInteractions();
     this.#state = this.#setupState(viewId, pageNo, baseUrl, sortField, sortOrder);
@@ -50,7 +53,7 @@ export class ListView {
         this.#state.getSortField(),
         this.#state.getSortOrder(),
         this.#state.getActiveFilters(),
-        //this.#gridViewParameters,
+        this.#listViewParameters,
       )
     ).unwrap();
     setInnerHtml(this.#viewElement, response.template);
@@ -66,9 +69,7 @@ export class ListView {
   }
 
   async #refreshItem(item: HTMLElement): Promise<void> {
-    const response = (
-      await getItem(this.#viewClassName, item.dataset.objectId! /*, this.#gridViewParameters*/)
-    ).unwrap();
+    const response = (await getItem(this.#viewClassName, item.dataset.objectId!, this.#listViewParameters)).unwrap();
     item.replaceWith(createFragmentFromHtml(response.template));
     this.#state.refreshSelection();
     triggerDomChange();
@@ -107,11 +108,19 @@ export class ListView {
 
     this.#viewElement.addEventListener("interaction:remove", (event) => {
       (event.target as HTMLElement).remove();
-      //  this.#checkEmptyTable();
+      this.#checkEmptyList();
     });
 
     this.#viewElement.addEventListener("interaction:reset-selection", () => {
       this.#state.resetSelection();
     });
   }
+
+  #checkEmptyList(): void {
+    if (this.#viewElement.querySelectorAll(".listView__item").length > 0) {
+      return;
+    }
+
+    void this.#loadItems(StateChangeCause.Change);
+  }
 }

wcfsetup/install/files/js/WoltLabSuite/Core/Api/ListViews/GetItems.js

@@ -6,6 +6,7 @@
 use wcf\system\exception\IllegalLinkException;
 use wcf\system\exception\PermissionDeniedException;
 use wcf\system\listView\user\ArticleListView;
+use wcf\system\listView\user\CategoryArticleListView;
 use wcf\system\MetaTagHandler;
 use wcf\system\page\PageLocationManager;
 use wcf\system\WCF;
@@ -48,7 +49,7 @@ public function readParameters()
     #[\Override]
     protected function createListView(): ArticleListView
     {
-        return new ArticleListView();
+        return new CategoryArticleListView($this->category->categoryID);
     }
 
     #[\Override]

wcfsetup/install/files/js/WoltLabSuite/Core/Component/ListView.js

@@ -8,15 +8,15 @@
 
 class CategoryArticleListView extends ArticleListView
 {
-    public function __construct(public readonly ArticleCategory $category)
+    public function __construct(public readonly int $categoryID)
     {
         parent::__construct();
     }
 
     #[\Override]
     protected function createObjectList(): CategoryArticleList
     {
-        $list = new CategoryArticleList($this->category->categoryID, true);
+        $list = new CategoryArticleList($this->categoryID, true);
         if ($list->sqlSelects !== '') {
             $list->sqlSelects .= ',';
         }
@@ -37,18 +37,18 @@ protected function createObjectList(): CategoryArticleList
     #[\Override]
     public function isAccessible(): bool
     {
-        return parent::isAccessible() && $this->category->isAccessible();
+        return parent::isAccessible() && ArticleCategory::getCategory($this->categoryID)->isAccessible();
     }
 
     #[\Override]
-    public function renderItems(): string
+    protected function getAccessibleLabelGroups(): array
     {
-        return WCF::getTPL()->render('wcf', 'articleListItems', ['view' => $this]);
+        return ArticleCategory::getCategory($this->categoryID)->getLabelGroups('canViewLabel');
     }
 
     #[\Override]
-    protected function getAccessibleLabelGroups(): array
+    public function getParameters(): array
     {
-        return $this->category->getLabelGroups('canViewLabel');
+        return ['categoryID' => $this->categoryID];
     }
 }