跳到内容
Yuva discussions hooks菜单

Yuva discussions hooks

A React provider and hooks over the useyuva headless client: discussions of a page, one thread, reader sign-in, the channel's discussion mode and page ratings. Labels with English defaults.

readersigned out

Loading

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

安装

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

Shell
npx shadcn@latest add https://useyuva.com/r/use-yuva-discussions.json

用法

tsx
import { useDiscussions, YuvaDiscussionsProvider } from "@/hooks/use-yuva-discussions"

const { discussions, loading } = useDiscussions(page, "top")

Props

YuvaDiscussionsProviderProps

Prop类型
server?string
channel?string
identityToken?IdentityTokenSource | null
client?YuvaClient
labels?Partial<YuvaDiscussionsLabels>
locale?string
children?React.ReactNode

DiscussionsResult

Prop类型
discussionsDiscussion[]
loadingboolean
errorunknown
hasMoreboolean
loadMore() => Promise<void>
reload() => Promise<void>
start(input: Omit<ClientDiscussionCreate, "page_url"> & { page_url?: string }) => Promise<Discussion>

DiscussionResult

Prop类型
discussionDiscussion | null
openingDiscussionPost | null
postsDiscussionPost[]
loadingboolean
errorunknown
reload() => Promise<void>
reply(body: string, parentPostId?: string) => Promise<DiscussionPost>
vote(post: DiscussionPost) => Promise<void>
follow(following: boolean) => Promise<void>
accept(postId: string | null) => Promise<void>
edit(postId: string, input: ClientDiscussionPostUpdate) => Promise<void>
remove(postId: string) => Promise<boolean>

YuvaReaderState

Prop类型
readerReaderSession | null
writerYuvaWriter
readyboolean
signIn() => Promise<ReaderSession>
signOut() => Promise<void>

标签

每个标签都有英文默认值。传入部分 labels 对象即可修改或翻译。

标签默认值
heading"Discussions"
sortNew"New"
sortTop"Top"
sortUnanswered"Unanswered"
newDiscussion"New discussion"
empty"No discussions on this page yet. Start the first one."
emptyUnanswered"Every discussion on this page has an answer."
loadMore"Load more"
loadError"Discussions could not be loaded."
retry"Try again"
back"All discussions"
replies(count) => (count === 1 ? "1 reply" : `${count} replies`)
votes(count) => (count === 1 ? "1 vote" : `${count} votes`)
answered"Answered"
acceptedAnswer"Accepted answer"
markAnswer"Mark as answer"
unmarkAnswer"Unmark as answer"
locked"Locked"
lockedNote"This discussion is locked. It takes no new replies."
pending"Awaiting approval"
pendingNote"Only you can see this until a moderator approves it."
upvote"Upvote"
removeUpvote"Remove upvote"
reply"Reply"
follow"Follow"
unfollow"Unfollow"
edit"Edit"
save"Save"
cancel"Cancel"
delete"Delete"
deleteConfirm"Delete this post?"
edited"edited"
deletedPost"This post was deleted."
deletedAuthor"Deleted reader"
deletedMember"Deleted member"
anonymous"Anonymous"
team"Team"
signIn"Sign in"
signInHint"Sign in to start a discussion, reply and vote."
signOut"Sign out"
signedInAs(name) => `Signed in as ${name}`
titleLabel"Title"
titlePlaceholder"What is your question or idea?"
bodyLabel"Message"
bodyPlaceholder"Add the details. Markdown works."
replyPlaceholder"Write a reply. Markdown works."
write"Write"
preview"Preview"
previewEmpty"Nothing to preview."
markdownHint"Markdown is supported."
startDiscussion"Start discussion"
postReply"Reply"
errorSignIn"Sign in to post."
errorLocked"This discussion is locked."
errorEditWindow"Posts can be edited for 30 minutes after posting."
errorRateLimited"Too many posts. Wait a minute and try again."
errorPopupBlocked"Allow pop-ups for this site to sign in."
errorOff"Discussions are turned off."
errorGeneric"Something went wrong. Try again."
feedbackQuestion"Was this page helpful?"
feedbackYes"Yes"
feedbackNo"No"
feedbackThanks"Thanks for your feedback."

依赖

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

npm 包