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

[Content]:Does useLocation return a signal or some other reactive data structure? #881

Closed
klequis opened this issue Sep 18, 2024 · 2 comments
Labels
solid-router Related to Solid Router

Comments

@klequis
Copy link
Contributor

klequis commented Sep 18, 2024

📚 Subject area/topic

Router, useLocation

📋 Page(s) affected (or suggested, for new content)

https://docs.solidjs.com/solid-router/reference/primitives/use-location#uselocation

📋 Description of content that is out-of-date or incorrect

Someone in #general today made the assumption that useLocation returned a signal. I implicitly mad the same assumption. However, the doc says

"Retrieves reactive location object useful for getting things like pathname"

One could assume that a "reactive location object" is or is not a signal. I think if it is a signal it should say so. If not a signal then, at least to me, it implies that Solid has a reactive object/data structure that I have not see documented anywhere else.

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

@brenelz
Copy link
Collaborator

brenelz commented Sep 26, 2024

I personally don't see a problem with the wording of "Retrieves reactive location object". This would imply to me that its not a signal and just an object that changes based on the router location. Also I think the types help show its not a function call

Do you have suggestion how to make it more clear?

@LadyBluenotes LadyBluenotes removed their assignment Sep 26, 2024
@LadyBluenotes LadyBluenotes added solid-router Related to Solid Router and removed pending review Awaiting review by team members. labels Sep 26, 2024
@LadyBluenotes
Copy link
Member

I agree with @brenelz - if you have any suggestions on how to reword, please let us know but for now I'm going to close this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
solid-router Related to Solid Router
Projects
None yet
Development

No branches or pull requests

3 participants