Yuva help search

A search field over the help center with live results: the matched words highlighted in the title and excerpt, and the click counted for the report.

预览使用示例数据运行，不需要网络，也不需要渠道。

tsx

import { YuvaHelpSearch } from "@/components/yuva-help-search"

export function Search() {
  return (
    <YuvaHelpSearch
      server={process.env.NEXT_PUBLIC_YUVA_SERVER}
      channel={process.env.NEXT_PUBLIC_YUVA_CHANNEL}
      onSelect={(article, query) => console.log(article.title, query)}
    />
  )
}

安装

在 shadcn 项目中运行。文件会复制到你自己的代码里。

Shell

npx shadcn@latest add https://useyuva.com/r/yuva-help-search.json

Shell

pnpm dlx shadcn@latest add https://useyuva.com/r/yuva-help-search.json

Shell

yarn dlx shadcn@latest add https://useyuva.com/r/yuva-help-search.json

Shell

bunx --bun shadcn@latest add https://useyuva.com/r/yuva-help-search.json

用法

tsx

import { YuvaHelpSearch } from "@/components/yuva-help-search"

<YuvaHelpSearch server={server} channel={channel} onSelect={(article) => setId(article.id)} />

Props

`YuvaHelpSearchProps`

Prop	类型
`server?`	`string`
`channel?`	`string`
`client?`	`YuvaClient`
`identityToken?`	`IdentityTokenSource \| null`
`locale?`	`string`
`help?`	`YuvaHelpState`
`query?`	`string`
`onQueryChange?`	`(query: string) => void`
`onSelect?`	`(article: ClientHelpArticleSummary, query: string) => void`
`labels?`	`Partial<YuvaHelpLabels>`
`className?`	`string`

依赖

安装此项时还会添加以下内容。

Yuva help search

安装

用法

Props

YuvaHelpSearchProps

标签

依赖

来自 shadcn/ui 的组件

其他 Yuva 项

npm 包

`YuvaHelpSearchProps`