Disable list of other declarations in minimized mode (#778) 121218746

* Disable list of other declarations in minimized mode 121218746

Disable list of other declarations in minimized mode

* clean up `hasOtherDeclarations` logic

clean up `hasOtherDeclarations` logic

Author: hqhhuang

bin/check-source

@@ -18,7 +18,7 @@ here="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
 function replace_acceptable_years() {
     # this needs to replace all acceptable forms with 'YEARS'
-    sed -e 's/20[12][789012]-20[12][890123]/YEARS/' -e 's/20[12][890123]/YEARS/'
+    sed -e 's/20[12][78901234]-20[12][8901234]/YEARS/' -e 's/20[12][8901234]/YEARS/'
 }
 
 printf "=> Checking license headers… "

src/components/DocumentationTopic.vue

@@ -1,7 +1,7 @@
 <!--
   This source file is part of the Swift.org open source project
 
-  Copyright (c) 2021-2023 Apple Inc. and the Swift project authors
+  Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
   Licensed under Apache License v2.0 with Runtime Library Exception
 
   See https://swift.org/LICENSE.txt for license information
@@ -539,9 +539,11 @@ export default {
     declarations({ primaryContentSections = [] }) {
       return primaryContentSections.filter(({ kind }) => kind === SectionKind.declarations);
     },
-    hasOtherDeclarations({ declarations = [] }) {
-      // there's always only 1 `declaration` at this level
-      return declarations.length ? declarations[0].declarations.some(decl => Object.prototype.hasOwnProperty.call(decl, 'otherDeclarations')) : false;
+    hasOtherDeclarations({ declarations = [], enableMinimized }) {
+      // disable otherDeclarations in minimized mode
+      return !enableMinimized && declarations.length
+        // there's always only 1 `declaration` at this level
+        && declarations[0].declarations.some(decl => Object.prototype.hasOwnProperty.call(decl, 'otherDeclarations'));
     },
     declListToggleText({ declListExpanded }) {
       return declListExpanded ? this.$t('declarations.hide-other-declarations')

tests/unit/components/DocumentationTopic.spec.js

@@ -1,7 +1,7 @@
 /**
  * This source file is part of the Swift.org open source project
  *
- * Copyright (c) 2021-2023 Apple Inc. and the Swift project authors
+ * Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
  * Licensed under Apache License v2.0 with Runtime Library Exception
  *
  * See https://swift.org/LICENSE.txt for license information
@@ -673,7 +673,7 @@ describe('DocumentationTopic', () => {
     });
   });
 
-  it('render an declaration list menu if has other declarations', () => {
+  it('render a declaration list menu if has other declarations', () => {
     let declListMenu = wrapper.find('.declaration-list-menu');
     expect(declListMenu.exists()).toBe(false);
 
@@ -687,6 +687,22 @@ describe('DocumentationTopic', () => {
     expect(declListMenu.exists()).toBe(true);
   });
 
+  it('does not render a declaration list menu in minimized mode', () => {
+    wrapper.setProps({
+      primaryContentSections: [
+        ...propsData.primaryContentSections,
+        hasOtherDeclSection,
+      ],
+    });
+    let declListMenu = wrapper.find('.declaration-list-menu');
+    expect(declListMenu.exists()).toBe(true);
+
+    wrapper.setProps({ enableMinimized: true });
+
+    declListMenu = wrapper.find('.declaration-list-menu');
+    expect(declListMenu.exists()).toBe(false);
+  });
+
   it('renders correct declaration list toggle, text, and icon', () => {
     wrapper.setProps({
       primaryContentSections: [