Yuva roadmap hooks

React hooks over the useyuva headless client for a public roadmap board: the board and its stage counts, the ideas of a stage by top votes or newest with a title search, voting and suggesting an idea. Built on the discussion hooks. Labels with English defaults.

プレビューはサンプルデータで動作します。ネットワークもチャネルも不要です。

tsx

import { YuvaDiscussionsProvider } from "@/hooks/use-yuva-discussions"
import { useIdeas } from "@/hooks/use-yuva-roadmap"

function Planned() {
  const { ideas, loading } = useIdeas("planned", "top")
  if (loading) return null
  return (
    <ul>
      {ideas.map((idea) => (
        <li key={idea.id}>
          {idea.title} ({idea.votes})
        </li>
      ))}
    </ul>
  )
}

export function Roadmap() {
  return (
    <YuvaDiscussionsProvider
      server={process.env.NEXT_PUBLIC_YUVA_SERVER}
      channel={process.env.NEXT_PUBLIC_YUVA_CHANNEL}
    >
      <Planned />
    </YuvaDiscussionsProvider>
  )
}

インストール

shadcn プロジェクトで実行してください。ファイルはあなた自身のコードにコピーされます。

Shell

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

Shell

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

Shell

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

Shell

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

使い方

tsx

import { useIdeas, useRoadmap } from "@/hooks/use-yuva-roadmap"

const { board } = useRoadmap()
const { ideas, vote } = useIdeas("planned", "top")

Props

`RoadmapResult`

Prop	型
`board`	`ClientRoadmap \| null`
`loading`	`boolean`
`error`	`unknown`
`reload`	`() => Promise<void>`

`IdeasResult`

Prop	型
`ideas`	`Discussion[]`
`loading`	`boolean`
`error`	`unknown`
`hasMore`	`boolean`
`loadMore`	`() => Promise<void>`
`reload`	`() => Promise<void>`
`suggest`	`(input: IdeaInput) => Promise<Discussion>`
`vote`	`(idea: Discussion) => Promise<void>`

ラベル

ラベルの一覧は Yuva roadmap にあります。

依存関係

この項目をインストールすると、次のものも追加されます。

その他の Yuva 項目

Yuva discussions hooks

npm パッケージ

useyuva ↗

← 前へYuva help hooks