fumadocs-ui/dist/contexts/search.js

The framework for building a documentation website in Next.js

'use client';
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
import { useEffect, useMemo, useState, } from 'react';
import { createContext } from 'fumadocs-core/framework';
const SearchContext = createContext('SearchContext', {
    enabled: false,
    hotKey: [],
    setOpenSearch: () => undefined,
});
export function useSearchContext() {
    return SearchContext.use();
}
function MetaOrControl() {
    const [key, setKey] = useState('⌘');
    useEffect(() => {
        const isWindows = window.navigator.userAgent.includes('Windows');
        if (isWindows)
            setKey('Ctrl');
    }, []);
    return key;
}
export function SearchProvider({ SearchDialog, children, preload = true, options, hotKey = [
    {
        key: (e) => e.metaKey || e.ctrlKey,
        display: _jsx(MetaOrControl, {}),
    },
    {
        key: 'k',
        display: 'K',
    },
], links, }) {
    const [isOpen, setIsOpen] = useState(preload ? false : undefined);
    useEffect(() => {
        const handler = (e) => {
            if (hotKey.every((v) => typeof v.key === 'string' ? e.key === v.key : v.key(e))) {
                setIsOpen(true);
                e.preventDefault();
            }
        };
        window.addEventListener('keydown', handler);
        return () => {
            window.removeEventListener('keydown', handler);
        };
    }, [hotKey]);
    return (_jsxs(SearchContext.Provider, { value: useMemo(() => ({
            enabled: true,
            hotKey,
            setOpenSearch: setIsOpen,
        }), [hotKey]), children: [isOpen !== undefined && (_jsx(SearchDialog, { open: isOpen, onOpenChange: setIsOpen, 
                // @ts-expect-error -- insert prop for official UIs
                links: links, ...options })), children] }));
}
/**
 * Show children only when search is enabled via React Context
 */
export function SearchOnly({ children }) {
    const search = useSearchContext();
    if (search.enabled)
        return children;
}