ZBSearch(デフォルト)

概要

Fumadocs では、ZBSearch 検索エンジンが標準で設定されています。

検索は、サーバー上で動作する API エンドポイント経由で行われます。静的サイトの場合は、静的にキャッシュされた JSON ファイルを利用して検索します。

セットアップ

検索ダイアログを作成します。

デフォルトの検索ダイアログはこのクライアントを使用しています。ダイアログをカスタマイズするには、次のように作り直してください。

components/search.tsx

'use client';
import { useFetchSearch } from 'fumadocs-core/search/client';
import {
  SearchDialog,
  SearchDialogClose,
  SearchDialogContent,
  SearchDialogHeader,
  SearchDialogIcon,
  SearchDialogInput,
  SearchDialogList,
  SearchDialogOverlay,
  type SharedProps,
} from 'fumadocs-ui/components/dialog/search';
import { useI18n } from 'fumadocs-ui/contexts/i18n';

export default function DefaultSearchDialog(props: SharedProps) {
  const { locale } = useI18n(); // (optional) for i18n
  const search = useFetchSearch({
    locale,
  });

  return (
    <SearchDialog {...search} {...props}>
      <SearchDialogOverlay />
      <SearchDialogContent>
        <SearchDialogHeader>
          <SearchDialogIcon />
          <SearchDialogInput />
          <SearchDialogClose />
        </SearchDialogHeader>
        <SearchDialogList />
      </SearchDialogContent>
    </SearchDialog>
  );
}

検索ダイアログを置き換える

プロバイダーコンポーネントで、独自の検索ダイアログを <RootProvider /> に渡します。

src/components/provider.tsx

'use client';
import type { ReactNode } from 'react';
import { RootProvider } from 'fumadocs-ui/provider/waku';
import SearchDialog from '@/components/search';

export function Provider({ children }: { children: ReactNode }) {
  return <RootProvider search={{ SearchDialog }}>{children}</RootProvider>;
}

タグフィルター

必要に応じて、検索結果をタグで絞り込むためのUIを追加できます。検索サーバーでタグフィルターを設定したうえで、以下を追加してください。

'use client';

import {
  SearchDialog,
  SearchDialogContent,
  SearchDialogFooter,
  SearchDialogOverlay,
  type SharedProps,
  TagsList,
  TagsListItem,
} from 'fumadocs-ui/components/dialog/search';
import { useState } from 'react';
import { useFetchSearch } from 'fumadocs-core/search/client';

export default function CustomSearchDialog(props: SharedProps) {
  const [tag, setTag] = useState<string | undefined>();
  const search = useFetchSearch({
    tag, 
  });

  return (
    <SearchDialog {...search} {...props}>
      <SearchDialogOverlay />
      <SearchDialogContent>
        ...
        <SearchDialogFooter className="flex flex-row">
          <TagsList tag={tag} onTagChange={setTag}>
            <TagsListItem value="my-value">My Value</TagsListItem>
          </TagsList>
        </SearchDialogFooter>
      </SearchDialogContent>
    </SearchDialog>
  );
}

ZBSearch(デフォルト)

概要アンカーリンクをコピー

セットアップアンカーリンクをコピー

検索ダイアログを置き換えるアンカーリンクをコピー

タグフィルターアンカーリンクをコピー

このページの内容

概要

セットアップ

検索ダイアログを置き換える

タグフィルター