ZBSearch(預設)
以 ZBSearch 為基礎的預設搜尋引擎。
概覽
Fumadocs 預設已設定好 ZBSearch 搜尋引擎,開箱即用。
搜尋會透過伺服器上執行的 API 端點進行;若是靜態網站,則改用靜態快取的 JSON 檔案。
設定
建立搜尋對話方塊。
預設的搜尋對話方塊即使用此用戶端。若要自訂搜尋對話方塊,請重新建立它:
'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>
);
}
替換搜尋對話方塊
請在您的 provider 元件中,將搜尋對話方塊傳入 <RootProvider />:
'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>
);
}How is this guide?
最後更新於
