add package's docs #6
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
koichik
reviewed
Sep 5, 2023
|
|
||
| TBW | ||
| - [@location-state/core](./packages/location-state-core/README.md) | ||
| - [@location-state/next](./packages/location-state-next/README.md) |
There was a problem hiding this comment.
リポジトリを見に来る人が最初に見るのがこのREADMEなのでライブラリの概要はここだけで見れるようにしたいお気持ち
APIリファレンス的なのはそれぞれのパッケージに誘導で十分だけど
| @@ -0,0 +1,124 @@ | |||
| # @location-state/core | |||
|
|
|||
| `@location-state/core` provides the features to save and restore state based on a specified `syncer`. | |||
There was a problem hiding this comment.
ここでsyncerとか書いても何も伝わらないような？
こことpackage.jsonのdescriptionを揃えるなら、これ単独でなんのライブラリか分かる説明が必要ですね
npmjs.orgのサーチ結果等で見れるのはこれなので
つまりこのライブラリのことを何も知らない人にこれが何なのかをわかるようにしたい
とすると絶対に伝えたいのは
- React向けの
- 状態管理ライブラリで
- 履歴エントリと同期して
- Next.js App Routerをサポート
辺りじゃないかなぁと
たとえば上を適当にDeepLすると:
State management library for React that synchronizes with history entries supporting Next.js App Router
|
|
||
| ## Usage | ||
|
|
||
| Specify the syncer props in Provider that based on the navigation API. |
There was a problem hiding this comment.
ここというかトップレベルのREADMEに書きたいことだけど、最初のUsageでいきなりsyncerとか出したくないかな
最小限のデフォルト構成を紹介したい
| ``` | ||
|
|
||
| > [!WARNING] | ||
| > Please note that the navigation API is not yet supported by some browsers as of 2023. |
There was a problem hiding this comment.
ここはもっとストレートにChromiumベースのブラウザでしか使えないと明記したいかな
|
|
||
| > [!WARNING] | ||
| > Please note that the navigation API is not yet supported by some browsers as of 2023. | ||
| > If you want, you can use `import { unsafeNavigation } from "@location-state/core/unsafe-navigation";` at your own risk. |
| > If you want, you can use `import { unsafeNavigation } from "@location-state/core/unsafe-navigation";` at your own risk. | ||
| > However, this is not a perfect complement to the Navigation API. | ||
|
|
||
| If you are using Next.js pages router, use [@location-state/next](../location-state-next/README.md). |
| You can store history-based information in session storage by specifying `store: 'session'`, name, and default value in hooks. | ||
|
|
||
| ```tsx | ||
| import { useLocationState, StoreName } from "@location-state/core"; |
| ```tsx | ||
| import { useLocationState, StoreName } from "@location-state/core"; | ||
|
|
||
| export function Counter({ storeName }: { storeName: StoreName }) { |
|
一旦このPRは閉じて別ブランチにて構成から出し直します🙇♂️ |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.