> ## Documentation Index
> Fetch the complete documentation index at: https://superdoc-caio-pizzol-docs-ai-core-preset.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Search extension

export const SourceCodeLink = ({extension, path}) => {
  const githubPath = path || `packages/super-editor/src/editors/v1/extensions/${extension.toLowerCase()}`;
  const githubUrl = `https://github.com/superdoc-dev/superdoc/tree/main/${githubPath}`;
  return <div>
      <p>
        <a href={githubUrl} target="_blank" rel="noopener noreferrer">
          View on GitHub →
        </a>
      </p>
    </div>;
};

export const SuperDocEditor = ({html = '<p>Start editing...</p>', height = '400px', maxHeight = '400px', onReady = null, showExport = true, customButtons = null}) => {
  const [ready, setReady] = useState(false);
  const editorRef = useRef(null);
  const containerIdRef = useRef(`editor-${Math.random().toString(36).substr(2, 9)}`);
  const DEV_DIST_URL = 'http://localhost:9094/dist';
  const UNPKG_DIST_URL = 'https://unpkg.com/superdoc@latest/dist';
  const getBaseUrl = async () => {
    const isDev = typeof window !== 'undefined' && window.location.hostname === 'localhost';
    if (isDev) {
      try {
        const res = await fetch(`${DEV_DIST_URL}/superdoc.min.js`, {
          method: 'HEAD'
        });
        if (res.ok) {
          console.info('[SuperDoc Docs] Using local build from', DEV_DIST_URL);
          return DEV_DIST_URL;
        }
        console.warn('[SuperDoc Docs] Local dev server returned', res.status, '- falling back to unpkg');
      } catch (err) {
        console.warn('[SuperDoc Docs] Local dev server not reachable: falling back to unpkg.', 'Run `pnpm dev:docs` from the repo root to use your local build.', err.message);
      }
    }
    return UNPKG_DIST_URL;
  };
  const ensureStyle = baseUrl => {
    const styleHref = `${baseUrl}/style.css`;
    if (document.querySelector(`link[href="${styleHref}"]`)) return;
    const link = document.createElement('link');
    link.rel = 'stylesheet';
    link.href = styleHref;
    document.head.appendChild(link);
  };
  const loadSuperDoc = baseUrl => {
    if (window.SuperDoc) return Promise.resolve();
    const scriptSrc = `${baseUrl}/superdoc.min.js`;
    const existingScript = document.querySelector(`script[src="${scriptSrc}"]`);
    if (existingScript) {
      if (window.SuperDoc) return Promise.resolve();
      return new Promise((resolve, reject) => {
        existingScript.addEventListener('load', resolve, {
          once: true
        });
        existingScript.addEventListener('error', reject, {
          once: true
        });
      });
    }
    return new Promise((resolve, reject) => {
      const script = document.createElement('script');
      script.src = scriptSrc;
      script.onload = resolve;
      script.onerror = reject;
      document.body.appendChild(script);
    });
  };
  const initEditor = () => {
    setTimeout(() => {
      if (!window.SuperDoc) return;
      if (!document.getElementById(containerIdRef.current)) return;
      if (editorRef.current) return;
      editorRef.current = new window.SuperDoc({
        selector: `#${containerIdRef.current}`,
        html,
        rulers: true,
        contained: true,
        onReady: () => {
          setReady(true);
          if (onReady) onReady(editorRef.current);
        }
      });
    }, 100);
  };
  useEffect(() => {
    let cancelled = false;
    const boot = async () => {
      try {
        const baseUrl = await getBaseUrl();
        ensureStyle(baseUrl);
        await loadSuperDoc(baseUrl);
        if (!cancelled) initEditor();
      } catch (error) {
        console.error('Failed to boot SuperDoc:', error);
      }
    };
    boot();
    return () => {
      cancelled = true;
      editorRef.current?.destroy?.();
      editorRef.current = null;
    };
  }, []);
  const exportDocx = () => {
    if (editorRef.current?.export) {
      editorRef.current.export();
    }
  };
  return <div className="border rounded-lg bg-white overflow-hidden">
      {ready && (showExport || customButtons) && <div className="px-3 py-2 bg-gray-50 border-b">
          {customButtons && <div className="space-y-1 mb-2">
              {customButtons.map((row, rowIndex) => <div key={rowIndex} className="flex gap-1">
                  {row.map((btn, i) => <button key={i} onClick={() => btn.onClick(editorRef.current)} className={btn.className || 'flex-1 px-2 py-1 bg-gray-100 text-gray-700 text-xs rounded hover:bg-gray-200'}>
                      {btn.label}
                    </button>)}
                </div>)}
            </div>}
          {showExport && <div className="text-right">
              <button onClick={exportDocx} className="px-3 py-1 bg-blue-500 text-white text-xs rounded hover:bg-blue-600">
                Export DOCX
              </button>
            </div>}
        </div>}
      <div id={containerIdRef.current} style={{
    height,
    maxHeight,
    paddingLeft: '5px'
  }} />
      <style jsx>{`
        #${containerIdRef.current} .superdoc__layers {
          max-width: 660px !important;
        }
        #${containerIdRef.current} .super-editor {
          max-width: 100% !important;
          width: 100% !important;
          color: #000;
        }
        #${containerIdRef.current} .editor-element {
          width: 100% !important;
          min-width: unset !important;
          transform: none !important;
        }
        #${containerIdRef.current} .editor-element {
          h1,
          h2,
          h3,
          h4,
          h5,
          strong {
            color: #000;
          }
        }
      `}</style>
    </div>;
};

Search for text/pattern in SuperEditor content.

Select text and apply different sizes. Supports pt, px, em, and rem units with automatic min/max clamping.

<SuperDocEditor
  html={`
<p>The editor is where your ideas take shape.</p>
<p>You can type freely, format your text, and structure content the way you need.</p>
<p>But once the document grows larger, it becomes harder to find what you are looking for.  </p>
<p>That is where the search feature helps.</p>
<br/>
<p>With search, you can jump directly to a word or phrase without scrolling line by line.  </p>
<p>Imagine you are reviewing a long draft and want to find every place the word "editor" appears. </p>
<p>Instead of scanning manually, the search function highlights each match.  </p>
<p>From there, you can quickly navigate through results or replace the text with a new term.  </p>
<br/>
<p>This makes editing faster and more reliable.  </p>
<p>Writers use search to replace names across a story.  </p>
<p>Developers use search to verify that a technical term is consistent.  </p>
<p>All of these tasks become easier when the editor supports search and replace.  </p>
`}
  maxHeight="300px"
  customButtons={[
[
  {
    label: 'Search',
    onClick: (superdoc) => {
      const editor = superdoc?.activeEditor || superdoc?.editor
      if (!editor?.commands) return

      editor.commands.search('search');
    }
  },
  {
    label: 'Go to match',
    onClick: (superdoc) => {
      const editor = superdoc?.activeEditor || superdoc?.editor
      if (!editor?.commands) return

      const result = editor.commands.search('search');
      editor.commands.goToSearchResult(result[5]);
    }
  }
]
]}
/>

## Use case

* Find and replace: quickly locate words or phrases and replace them.
* Content navigation: jump to the next or previous match without scrolling manually.
* Highlighting: visually emphasize search results for the user.
* Custom workflows: integrate search into toolbars, command palettes, or keyboard shortcuts.

## Commands

### `goToFirstMatch`

Navigate to the first search match

<Note>
  Scrolls editor to the first match from previous search
</Note>

**Example:**

<CodeGroup>
  ```javascript Usage theme={null}
  editor.commands.goToFirstMatch()
  ```

  ```javascript Full Example theme={null}
  import { SuperDoc } from 'superdoc';
  import 'superdoc/style.css';

  const superdoc = new SuperDoc({
    selector: '#editor',
    document: yourFile,
    onReady: (superdoc) => {
      const editor = superdoc.activeEditor;
      editor.commands.goToFirstMatch()
    },
  });
  ```
</CodeGroup>

### `search`

Search for string matches in editor content

<Note>
  Returns array of SearchMatch objects with positions and IDs
</Note>

**Example:**

<CodeGroup>
  ```javascript Usage theme={null}
  const matches = editor.commands.search('test string')
  const regexMatches = editor.commands.search(/test/i)
  ```

  ```javascript Full Example theme={null}
  import { SuperDoc } from 'superdoc';
  import 'superdoc/style.css';

  const superdoc = new SuperDoc({
    selector: '#editor',
    document: yourFile,
    onReady: (superdoc) => {
      const editor = superdoc.activeEditor;
      const matches = editor.commands.search('test string')
      const regexMatches = editor.commands.search(/test/i)
    },
  });
  ```
</CodeGroup>

**Parameters:**

<ParamField path="patternInput" type="String | RegExp" required>
  Search string, regex, or regex shorthand (e.g., `'/pattern/flags'`)
</ParamField>

<ParamField path="options" type="Object">
  Optional settings
</ParamField>

<ParamField path="options.highlight" type="boolean" default="true">
  Apply CSS highlight classes to matches
</ParamField>

<ParamField path="options.maxMatches" type="number" default="1000">
  Maximum number of matches to return
</ParamField>

### `goToSearchResult`

Navigate to a specific search match

<Note>
  Scrolls to match and selects it
</Note>

**Example:**

<CodeGroup>
  ```javascript Usage theme={null}
  const searchResults = editor.commands.search('test string')
  editor.commands.goToSearchResult(searchResults[3])
  ```

  ```javascript Full Example theme={null}
  import { SuperDoc } from 'superdoc';
  import 'superdoc/style.css';

  const superdoc = new SuperDoc({
    selector: '#editor',
    document: yourFile,
    onReady: (superdoc) => {
      const editor = superdoc.activeEditor;
      const searchResults = editor.commands.search('test string')
      editor.commands.goToSearchResult(searchResults[3])
    },
  });
  ```
</CodeGroup>

**Parameters:**

<ParamField path="match" type="SearchMatch" required>
  Match object to navigate to
</ParamField>

## Types

### `SearchMatch`

Search match object

<Expandable title="Properties">
  <ResponseField name="text" type="string" required>
    Found text
  </ResponseField>

  <ResponseField name="from" type="number" required>
    From position
  </ResponseField>

  <ResponseField name="to" type="number" required>
    To position
  </ResponseField>

  <ResponseField name="id" type="string" required>
    ID of the search match
  </ResponseField>
</Expandable>

## Source code

<SourceCodeLink path="packages/super-editor/src/editors/v1/extensions/search/search.js" />