unstable_HistoryRouter



このAPIは実験的であり、マイナー/パッチリリースで破壊的変更が加えられる可能性があります。ご利用には注意を払い、関連する変更についてはリリースノートに細心の注意を払ってください。

概要

リファレンスドキュメント ↗

事前にインスタンス化された history オブジェクトを受け入れる宣言的な <Router> です。 独自の history オブジェクトを使用することは強く推奨されず、React Router が内部で使用している history ライブラリと同じバージョンを使用しない限り、バンドルに history ライブラリの2つのバージョンが追加される可能性があることに注意することが重要です。

シグネチャ

function HistoryRouter({
  basename,
  children,
  history,
  unstable_useTransitions,
}: HistoryRouterProps)

Props

basename

アプリケーションの basename

children

ルート設定を記述する <Route> コンポーネント

history

router で使用するための History 実装

unstable_useTransitions

router の state 更新が内部的に React.startTransition でラップされるかどうかを制御します。

  • undefined の場合、すべての router state 更新は React.startTransition でラップされます。
  • true に設定されている場合、Link および Form によるナビゲーションは React.startTransition でラップされ、すべての router state 更新は React.startTransition でラップされます。
  • false に設定されている場合、router はナビゲーションや state の変更で React.startTransition を利用しません。

詳細については、ドキュメントを参照してください。