Merge pull request #3688 from ilandikov/feat-show-hide-toolbar

feat: show/hide toolbar instruction

Author: claremacrae

src/Layout/QueryLayoutOptions.ts

@@ -4,6 +4,7 @@
  * @see LayoutOptions
  */
 export class QueryLayoutOptions {
+    hideToolbar: boolean = false;
     hidePostponeButton: boolean = false;
     hideTaskCount: boolean = false;
     hideBacklinks: boolean = false;
@@ -29,6 +30,7 @@ export function parseQueryShowHideOptions(queryLayoutOptions: QueryLayoutOptions
         ['edit button', 'hideEditButton'],
         ['postpone button', 'hidePostponeButton'],
         ['task count', 'hideTaskCount'],
+        ['toolbar', 'hideToolbar'],
         ['tree', 'hideTree'],
         ['urgency', 'hideUrgency'],
     ]);

src/Renderer/HtmlQueryResultsRenderer.ts

@@ -80,7 +80,7 @@ export class HtmlQueryResultsRenderer extends QueryResultsRendererBase {
     }
 
     protected renderSearchResultsHeader(queryResult: QueryResult): void {
-        this.addCopyButton(queryResult);
+        this.addToolbar(queryResult);
     }
 
     protected renderSearchResultsFooter(queryResult: QueryResult): void {
@@ -102,9 +102,17 @@ export class HtmlQueryResultsRenderer extends QueryResultsRendererBase {
         explanationsBlock.textContent = explanation;
     }
 
-    private addCopyButton(_queryResult: QueryResult) {
+    private addToolbar(_queryResult: QueryResult) {
+        if (this.getters.query().queryLayoutOptions.hideToolbar) {
+            return;
+        }
+
         const toolbar = createAndAppendElement('div', this.content);
         toolbar.classList.add('plugin-tasks-toolbar');
+        this.addCopyButton(toolbar);
+    }
+
+    private addCopyButton(toolbar: HTMLDivElement): void {
         const copyButton = createAndAppendElement('button', toolbar);
         setIcon(copyButton, 'lucide-copy');
         setTooltip(copyButton, 'Copy results');

tests/Layout/QueryLayoutOptions.test.ts

@@ -12,10 +12,16 @@ describe('parsing query show/hide layout options', () => {
         ['edit button', 'hideEditButton', false],
         ['postpone button', 'hidePostponeButton', false],
         ['task count', 'hideTaskCount', false],
+        ['toolbar', 'hideToolbar', false],
         ['tree', 'hideTree', true],
         ['urgency', 'hideUrgency', true],
     ];
 
+    it('should have tests for all show/hide instructions', () => {
+        const testedKeys = Object.keys(new QueryLayoutOptions()).filter((key) => key.startsWith('hide'));
+        expect(testedKeys.length).toBe(testCases.length);
+    });
+
     it.each(testCases)('should parse "%s" option', (option, property, hiddenByDefault) => {
         const options = new QueryLayoutOptions();
         expect(options[property]).toBe(hiddenByDefault);

tests/Query/Query.test.ts

@@ -514,6 +514,7 @@ description includes \
             'hide start date',
             'hide tags',
             'hide task count',
+            'hide toolbar',
             'hide tree',
             'hide urgency',
             'ignore global query',
@@ -539,6 +540,7 @@ description includes \
             'show start date',
             'show tags',
             'show task count',
+            'show toolbar',
             'show tree',
             'show urgency',
         ];