tldraw/apps/docs/components/Search.tsx
Lu Wilson 004787d5bd
[docs] Add feedback when you search (#1633)
This PR adds some immediate feedback when you search on the docs site —
so that you know that your query has been submitted. This is most
noticeable on slower internet connections. But even on fast connections,
search feels a bit untrustworthy because you don't get that immediate
feedback.

We could make a little loading spinner or something. But for now, I just
disabled the search input when you submit it, because it didn't require
any design work!

## Before

No way of telling that the search results are loading. No immediate
feedback:

![2023-06-22 at 12 17 34 - Fuchsia
Fowl](https://github.com/tldraw/tldraw/assets/15892272/da3b3d7f-fc6a-49f9-9352-58949ca917d5)

## After
![2023-06-22 at 13 09 26 - Turquoise
Cat](https://github.com/tldraw/tldraw/assets/15892272/9e44061a-c4b9-43d2-8b8f-e1c4dce60c48)


## Admin

### Change Type
- [x] `documentation` — Changes to the documentation only[^2]

[^1]: publishes a `patch` release, for devDependencies use `internal`
[^2]: will not publish a new version

### Test Plan

1. Throttle your network tab!
2. Search for something on the docs site (eg: Editor)
3. The search input should get disabled when you press the Enter key.

### Release Notes

- Documentation: Added some immediate feedback when you search.
2023-06-23 09:57:57 +00:00

139 lines
3.5 KiB
TypeScript

import { SearchResult } from '@/types/search-types'
import Link from 'next/link'
import { useRouter } from 'next/router'
import { useCallback, useEffect, useRef, useState } from 'react'
import { Icon } from './Icon'
export function Search({ activeId }: { activeId: string | null }) {
const [query, setQuery] = useState('')
const [results, setResults] = useState<SearchResult[]>([])
const rResultsList = useRef<HTMLOListElement>(null)
const [isDisabled, setIsDisabled] = useState(false)
const handleChange = useCallback((e: React.ChangeEvent<HTMLInputElement>) => {
setQuery(e.target.value)
}, [])
// eslint-disable-next-line react-hooks/exhaustive-deps
const sendQuery = useCallback(
throttle(async (query: string) => {
const res = await fetch(`/api/search?q=${query}&s=${activeId}`)
const json = await res.json()
setResults(json.results)
}, 150),
[activeId]
)
useEffect(() => {
const query = rInput.current!.value
if (query.length > 2) {
sendQuery(query)
} else {
setResults([])
}
}, [sendQuery])
const hasQuery = query.length > 0
const hasResults = query.length > 0
useEffect(() => {
function handleKeyUp(e: KeyboardEvent) {
if (e.key === 'Escape' && hasResults) {
setResults([])
}
}
function handleMouseUp(e: MouseEvent) {
if (rResultsList.current && !rResultsList.current.contains(e.target as Node)) {
setResults([])
}
}
document.body.addEventListener('mouseup', handleMouseUp)
document.body.addEventListener('keyup', handleKeyUp)
return () => {
document.body.removeEventListener('mouseup', handleMouseUp)
document.body.removeEventListener('keyup', handleKeyUp)
}
}, [hasResults])
const rInput = useRef<HTMLInputElement>(null)
const router = useRouter()
useEffect(() => {
setQuery('')
setResults([])
setIsDisabled(false)
}, [router.asPath])
const handleFocus = useCallback(() => {
if (hasQuery && !hasResults) {
sendQuery(rInput.current!.value)
}
}, [sendQuery, hasQuery, hasResults])
const handleKeyDown = useCallback(
(e: React.KeyboardEvent) => {
if (e.key === 'Enter') {
setIsDisabled(true)
router.push(`/search-results?q=${rInput.current!.value}`)
}
},
[router]
)
return (
<div className="search__wrapper">
<div className="search">
<Icon className="search__icon" icon="search" />
<input
ref={rInput}
type="text"
className="search__input"
placeholder="Search..."
value={query}
onChange={handleChange}
onFocus={handleFocus}
onKeyDown={handleKeyDown}
autoCapitalize="off"
autoComplete="off"
autoCorrect="off"
disabled={isDisabled}
/>
</div>
{results.length > 0 && (
<div className="search__results__wrapper">
<div className="search__results">
<ol ref={rResultsList} className="search__results__list">
{results.map((result) => (
<Link key={result.id} href={result.url}>
<li className="sidebar__article search__results__article">
<h4>{result.subtitle}</h4>
<h3>{result.title}</h3>
</li>
</Link>
))}
</ol>
</div>
</div>
)}
</div>
)
}
function throttle<T extends (...args: any) => any>(
func: T,
limit: number
): (...args: Parameters<T>) => ReturnType<T> {
let inThrottle: boolean
let lastResult: ReturnType<T>
return function (this: any, ...args: any[]): ReturnType<T> {
if (!inThrottle) {
inThrottle = true
setTimeout(() => (inThrottle = false), limit)
lastResult = func(...args)
}
return lastResult
}
}