Attach default filters on input

Author: grzegorz-bielski

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

@@ -17,8 +17,6 @@ const attachDOM = (element, html) => {
   }
 };
 
-const startsWith = (str, character) => str.charAt(0) === character;
-
 const htmlToString = (html) => {
   if (Array.isArray(html)) {
     return html.join("");

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

@@ -133,7 +133,8 @@ class List {
 
     function areFiltersFromElementSelected() {
       /** @param str { string } */
-      const haveKeywordData = str => str.startsWith("f")
+      const haveKeywordData = key => key === Filter.KeywordsKey
+      
       /** @type { [key: string, value: string][] } */
       const dataset = Object.entries(elementData.ref.dataset) 
 

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

@@ -1,5 +1,4 @@
 /**
- * @typedef { { selected: boolean; visible: boolean } } FilterItem
  * @typedef { { fKeywords: Record<string, FilterItem> } } Filters
  */
 
@@ -22,6 +21,11 @@ class Filter {
    */
   static defaultFilterKey = 'default'
 
+  /**
+   * HTML data attribute that contains non-default keywords
+   */
+  static KeywordsKey = 'fKeywords'
+
   get value() {
     return this._value;
   }
@@ -60,7 +64,6 @@ class Filter {
 
   /**
   * @param value { string }
-  * @returns { FilterItem }
   */
   onInputValueChange(value) {
     return new Filter(
@@ -76,24 +79,31 @@ class Filter {
   * @returns { Filters }
   */
   _generateFiltersOnTyping(value) {
-    const datasets = this.elementsRefs
-      .filter((elRef) => {
-        const name = getElementTextContent(getElementNameRef(elRef));
-        const description = getElementTextContent(getElementDescription(elRef));
+    const elementsDatasets = this.elementsRefs
+      .filter(element => {
+        const name = getElementTextContent(getElementNameRef(element));
+        const description = getElementTextContent(getElementDescription(element));
 
         return name.includes(value) || description.includes(value);
       })
-      .map((elRef) => this._getDatasetWithKeywordData(elRef.dataset))
-
+      .map(element => this._getDatasetWithKeywordData(element.dataset))
 
-      return dataset.reduce((filtersObject, datasets) => {
+      const newFilters = elementsDatasets.reduce((filtersObject, datasets) => {
         datasets.forEach(([key, value]) => {
           this._splitByComma(value).forEach((val) => {
             filtersObject[key] = { ...filtersObject[key], [val]: { ...filtersObject[key][val], visible: true} };
           });
         });
+
         return filtersObject;
       }, this._allFiltersAreHidden());
+
+      const shouldAddDefaultFilter = elementsDatasets
+        .some(d => d.length === 0 || d.some(([key]) => key !== Filter.KeywordsKey))
+
+      return shouldAddDefaultFilter
+        ? this._attachDefaultFilters(newFilters)
+        : newFilters
   }
 
   /**
@@ -142,26 +152,37 @@ class Filter {
   * @returns { Filters }
   */
   _withNewFilters() {
-    const newFilter = { selected: true, visible: true }
-
     const newFilters = this._elementsRefs.reduce((filtersObject, elementRef) => {
       this._getDatasetWithKeywordData(elementRef.dataset).forEach(([key, value]) =>
         this._splitByComma(value).forEach((val) => {
           filtersObject[key] = filtersObject[key] 
-            ? { ...filtersObject[key], [val]: filtersObject[key][val] ?? newFilter}
-            : { [val]: newFilter }
+            ? { ...filtersObject[key], [val]: filtersObject[key][val] ?? new FilterItem() }
+            : { [val]: new FilterItem()  }
         })
       );
       return filtersObject;
     }, {});
 
-    const shouldAddDefaultFilter = this._elementsRefs.some(ref => !!ref.dataset['fKeywords'])
+    const shouldAddDefaultFilter = this._elementsRefs.some(ref => !!ref.dataset[Filter.KeywordsKey])
 
     return shouldAddDefaultFilter 
-      ? { ...newFilters, fKeywords: { ...newFilters.fKeywords, [Filter.defaultFilterKey]: newFilter } } 
+      ? this._attachDefaultFilters(newFilters)
       : newFilters
   }
 
+  /**
+   * @private
+   * @param {Filters} filters 
+   */
+  _attachDefaultFilters(filters) {
+    return { 
+      ...filters, [Filter.KeywordsKey]: { 
+        ...filters.fKeywords, 
+        [Filter.defaultFilterKey]: new FilterItem() 
+      } 
+    } 
+  }
+
   /**
   * @private
   * @param key { string }
@@ -193,5 +214,12 @@ class Filter {
   * @returns { [key: string, value: string][] }
   */
   _getDatasetWithKeywordData = (dataset) =>
-    Object.entries(dataset).filter(([key]) => startsWith(key, "f"));
+    Object.entries(dataset).filter(([key]) => key === Filter.KeywordsKey);
 }
+
+class FilterItem {
+  constructor(selected = true, visible = true) {
+    this.selected = selected
+    this.visible = visible
+  }
+}

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

@@ -99,7 +99,6 @@ class FilterGroup extends Component {
   }
 
   render({ filter }) {
-    console.log(filter.filters)
     attachDOM(
       this.filterLowerContainerRef,
       Object.entries(filter.filters)