Files
outline/app/scenes/Shared/Document.tsx
Tom Moor b73bd2a621 feat: Highlight search results when navigating to document from search (#11262)
* feat: Highlight search term on docs from search results

closes #8251

* Use query string instead

* Search highlight on public shares
2026-01-24 19:19:56 +00:00

70 lines
2.1 KiB
TypeScript

import { observer } from "mobx-react";
import type { PublicTeam } from "@shared/types";
import { TOCPosition } from "@shared/types";
import type DocumentModel from "~/models/Document";
import DocumentComponent from "~/scenes/Document/components/Document";
import { useDocumentContext } from "~/components/DocumentContext";
import { useTeamContext } from "~/components/TeamContext";
import { useEffect, useMemo, useRef } from "react";
import { parseDomain } from "@shared/utils/domains";
import useCurrentUser from "~/hooks/useCurrentUser";
import Branding from "~/components/Branding";
import useShare from "@shared/hooks/useShare";
import useQuery from "~/hooks/useQuery";
type Props = {
document: DocumentModel;
};
function SharedDocument({ document }: Props) {
const { shareId } = useShare();
const query = useQuery();
const searchTerm = query.get("q") || undefined;
const team = useTeamContext() as PublicTeam | undefined;
const user = useCurrentUser({ rejectOnEmpty: false });
const { hasHeadings, setDocument, isEditorInitialized, editor } =
useDocumentContext();
const abilities = useMemo(() => ({}), []);
const isCustomDomain = useMemo(
() => parseDomain(window.location.origin).custom,
[]
);
const showBranding = !isCustomDomain && !user;
const searchTermProcessed = useRef<string | null>(null);
const tocPosition = hasHeadings
? (team?.tocPosition ?? TOCPosition.Left)
: false;
setDocument(document);
// Highlight search term when navigating from search results
useEffect(() => {
if (
isEditorInitialized &&
editor &&
searchTerm &&
searchTermProcessed.current !== searchTerm
) {
searchTermProcessed.current = searchTerm;
editor.commands.find({ text: searchTerm });
}
}, [isEditorInitialized, editor, searchTerm]);
return (
<>
<DocumentComponent
abilities={abilities}
document={document}
shareId={shareId}
tocPosition={tocPosition}
readOnly
/>
{showBranding ? (
<Branding href="//www.getoutline.com?ref=sharelink" />
) : null}
</>
);
}
export const Document = observer(SharedDocument);