Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature]: Add Documentation for Potential Hydration Issues with @use-funnel/browser in App Router #104

Open
L2HYUNN opened this issue Jan 16, 2025 · 1 comment

Comments

@L2HYUNN
Copy link
Contributor

L2HYUNN commented Jan 16, 2025

Package Scope

etc

Description

Hello,

I recently reviewed the list of issues reported for use-funnel and came across a user issue related to hydration problems(#103) when using the App Router.

This appears to be a previously identified problem with an existing solution(#59) however, since it is not documented in the official guide, it may cause confusion for many users.

Possible Solution

image

I’ve created a draft example of how this issue could be addressed in the documentation.

The wording is subject to change, but I’d like to hear your thoughts on adding this information using the approach shown in the image above.


There are two main reasons for highlighting this issue in that location:

  1. This section is one of the first parts users encounter when searching the documentation to use the library. Placing the information here ensures users are adequately informed about the issue before they begin using the library.

  2. While use-funnel does not provide a separate router specifically for the App Router, it is still compatible with browser history. Including this information explicitly demonstrates that the App Router can indeed be used with the library.

etc.

No response

@minuukang
Copy link
Member

Great! This issue was raised a long time ago and is in our backlog. It would be great to be able to use the example you've shown, Thank you for your contributions!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants