追記: 2021年6月8日
SWR公式日本語訳ページが追加されたので、そちらをご覧ください
全ページの目次
- はじめに - Introduction
- 入門 - Getting Started
- ドキュメンテーション - Documentation
- 発展 - Advanced
- 例 - Examples
- 変更履歴 - Change Log
このページはSWRドキュメントの翻訳ではなく、翻訳についての目次・経緯・目的・構成・注意事項に関するページになります
経緯と目的
Webクライアントで Next.js が流行ると共に、同じ開発元のSWRも名前がでてきたように思います。いくつかの記事で紹介されていましたが、日本語のいくつかの記事を見るだけで機能の全容を把握するのは難しいように思いました。
そこで英語のドキュメントをざっくりと読み、基本的な使い方を理解し実際のアプリケーションに組み込んでいきました。開発しながらドキュメントの詳細を読んでいくごとに見落としていた機能やオプションを見つけたので、一度全ての機能を把握しようとドキュメント全てを読むようにしました。この際、私のように英語が苦手で日本語で網羅的にSWRの機能を把握したい人がいるのではないかと思ったのでドキュメントを全て翻訳することにしました。機能の把握や理解の助けになれば幸いです。
構成
本家のドキュメントのページは全てで20ページ程度ありますが、例(Examples)と変更履歴(Change Log)に関しての翻訳はなく本家のドキュメントにリンクしています。
翻訳記事内のリンクに関しては、ドキュメント内のリンクは翻訳記事のリンクに置き換え、その他は原文と同じリンクになっています。ただし、React・MDNのドキュメントにリンクされている箇所で日本語版が存在している箇所のみ日本語版に置き換えいます。
注意事項
翻訳に関して本家ドキュメントとズレがないよう出来るだけ直訳していますが、一部表現が変更されている箇所等あるかと思います。あくまで、SWRの機能を網羅的把握することを補助する目的なので実際の開発の際などは最新の本家ドキュメントを参照ください。(更新リクエストなどは歓迎です！)
公式ドキュメント: SWR公式サイト
Github: vercel/swr