Alternate description for disabled filters

gderocher · Feb 23, 2024 · 059fb7e · 059fb7e
1 parent 2d68127
commit 059fb7e
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/packages/documentsearch/src/searchview.tsx b/packages/documentsearch/src/searchview.tsx
@@ -646,15 +646,21 @@ class SearchOverlay extends React.Component<ISearchOverlayProps> {
       <div className={SEARCH_OPTIONS_CLASS}>
         {Object.keys(filters).map(name => {
           const filter = filters[name];
+
+          const isEnabled = !showReplace || filter.supportReplace;
+          // Show an alternate description, if one exists, when a filter is disabled in replace mode.
+          const description = isEnabled
+            ? filter.description
+            : (filter.disabledDescription ?? filter.description);
           return (
             <FilterSelection
               key={name}
               title={filter.title}
               description={
-                filter.description +
+                description +
                 (name == 'selection' ? selectionKeyHint : '')
               }
-              isEnabled={!showReplace || filter.supportReplace}
+              isEnabled={isEnabled}
               onToggle={async () => {
                 await this.props.onFilterChanged(
                   name,

diff --git a/packages/documentsearch/src/tokens.ts b/packages/documentsearch/src/tokens.ts
@@ -29,6 +29,10 @@ export interface IFilter {
    * Filter description
    */
   description: string;
+  /**
+   * Filter description to be used when the filter is disabled in replace mode.
+   */
+  disabledDescription?: string;
   /**
    * Default value
    */

diff --git a/packages/notebook/src/searchprovider.ts b/packages/notebook/src/searchprovider.ts
@@ -236,6 +236,7 @@ export class NotebookSearchProvider extends SearchProvider<NotebookPanel> {
       output: {
         title: trans.__('Search Cell Outputs'),
         description: trans.__('Search in the cell outputs.'),
+        disabledDescription: trans.__('Search in the cell outputs. (Not available in find and replace mode.)'),
         default: false,
         supportReplace: false
       },