Add default filters for the rest of filter types

Author: grzegorz-bielski

scala3doc/resources/dotty_res/scripts/common/utils.js

@@ -24,6 +24,10 @@ const htmlToString = (html) => {
   return html;
 };
 
+const isFilterData = key => key.startsWith("f")
+
+const getFilterKey = key => `f${key.charAt(0).toUpperCase()}${key.slice(1)}`
+
 const attachListeners = (elementsRefs, type, callback) =>
   elementsRefs.map((elRef) => withEvent(elRef, type, callback));
 

scala3doc/resources/dotty_res/scripts/components/DocumentableList.js

@@ -132,35 +132,36 @@ class List {
     }
 
     function areFiltersFromElementSelected() {
-      /** @param str { string } */
-      const haveKeywordData = key => key === Filter.KeywordsKey
-      
       /** @type { [key: string, value: string][] } */
       const dataset = Object.entries(elementData.ref.dataset) 
 
-      const datasetWithDefaultData =  dataset.filter(([key]) => !haveKeywordData(key));
-      const datasetWithKeywordData =  dataset.filter(([key]) => haveKeywordData(key));
+      const datasetWithFilterData = dataset.filter(([key]) => isFilterData(key));
 
-      return datasetWithKeywordData.length > 0 
-        ? hasCorrespondingFilters() 
-        : haveDefaultFilters()
+      return hasCorrespondingFilters() || haveDefaultFilters()
 
       function haveDefaultFilters() {
         return (
-          filter.filters.fKeywords[Filter.defaultFilterKey] && 
-          filter.filters.fKeywords[Filter.defaultFilterKey].selected &&
-          datasetWithDefaultData.length >= 1
+          Object.entries(Filter.defaultFilters).some(([key, value]) => {
+            const filterKey = getFilterKey(key)
+      
+            return (
+              filter.filters[filterKey] && 
+              filter.filters[filterKey][value].selected && 
+              !dataset.some(([k]) => k === filterKey)
+            )
+           }
+          )
         )
       }
-        
+       
+      // check if any selected filter is on data attr
       function hasCorrespondingFilters() {
-        return (
-          datasetWithKeywordData
-            .every(([key, value]) => {
-              const filterGroup = filter.filters[key];
-              return value.split(",").every(val => filterGroup && filterGroup[val].selected);
-            })
-        )
+        return datasetWithFilterData
+          .some(([filterKey, value]) => 
+            value.split(",").some(val => 
+              filter.filters[filterKey] && filter.filters[filterKey][val].selected
+            )
+          )
       }
     }
   }

scala3doc/resources/dotty_res/scripts/components/Filter.js

@@ -1,5 +1,7 @@
 /**
- * @typedef { { fKeywords: Record<string, FilterItem> } } Filters
+ * @typedef { Record<string, FilterItem> } FilterMap
+ * @typedef { "fKeywords" | "fInherited" | "fImplicitly" | "fExtension" | "fVisibility" } FilterAttributes
+ * @typedef { Record<FilterAttributes, FilterMap> } Filters
  */
 
 class Filter {
@@ -16,15 +18,9 @@ class Filter {
     this._filters = this._init ? this._withNewFilters() : filters;
   }
 
-  /**
-   * Key for filters without the `fKeywords`
-   */
-  static defaultFilterKey = 'default'
-
-  /**
-   * HTML data attribute that contains non-default keywords
-   */
-  static KeywordsKey = 'fKeywords'
+  static get defaultFilters() {
+    return scala3DocData.filterDefaults
+  }
 
   get value() {
     return this._value;
@@ -98,12 +94,8 @@ class Filter {
         return filtersObject;
       }, this._allFiltersAreHidden());
 
-      const shouldAddDefaultFilter = elementsDatasets
-        .some(d => d.length === 0 || d.some(([key]) => key !== Filter.KeywordsKey))
+      return this._attachDefaultFilters(newFilters)
 
-      return shouldAddDefaultFilter
-        ? this._attachDefaultFilters(newFilters)
-        : newFilters
   }
 
   /**
@@ -163,24 +155,29 @@ class Filter {
       return filtersObject;
     }, {});
 
-    const shouldAddDefaultFilter = this._elementsRefs.some(ref => !!ref.dataset[Filter.KeywordsKey])
-
-    return shouldAddDefaultFilter 
-      ? this._attachDefaultFilters(newFilters)
-      : newFilters
+    return this._attachDefaultFilters(newFilters)
   }
 
   /**
    * @private
-   * @param {Filters} filters 
+   * @param {Filters} newFilters
+   * @returns {Filters} 
    */
-  _attachDefaultFilters(filters) {
-    return { 
-      ...filters, [Filter.KeywordsKey]: { 
-        ...filters.fKeywords, 
-        [Filter.defaultFilterKey]: new FilterItem() 
-      } 
-    } 
+  _attachDefaultFilters(newFilters) {
+    return Object.entries(Filter.defaultFilters).reduce((acc, [key, defaultFilter]) => {
+      const filterKey = getFilterKey(key)
+      const shouldAddDefaultKeywordFilter = this._elementsRefs.some(ref => !!ref.dataset[filterKey])
+      
+      return shouldAddDefaultKeywordFilter 
+        ? { 
+          ...acc, 
+          [filterKey]: { 
+            ...acc[filterKey], 
+            [defaultFilter]: new FilterItem() 
+          } 
+        } 
+        : acc
+    }, newFilters)
   }
 
   /**
@@ -214,7 +211,7 @@ class Filter {
   * @returns { [key: string, value: string][] }
   */
   _getDatasetWithKeywordData = (dataset) =>
-    Object.entries(dataset).filter(([key]) => key === Filter.KeywordsKey);
+    Object.entries(dataset).filter(([key]) => isFilterData(key));
 }
 
 class FilterItem {