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

[📖] Docs/tutorials expect extra renders - signals are too efficient! #2591

Closed
4 tasks
cmbartschat opened this issue Jan 8, 2023 · 7 comments
Closed
4 tasks
Labels
COMMUNITY: good first issue Good for newcomers COMMUNITY: PR is welcomed We think it's a good feature to have but would love for the community to help with the PR for it COMP: docs Improvements or additions to documentation

Comments

@cmbartschat
Copy link
Contributor

Suggestion

If a component inserts store values directly into the JSX for example, Qwik can propagate signal updates directly into the DOM without re-running the component's render function. This seems to have made a number of tutorials/docs out of date.

Discussed a bit on discord: https://discord.com/channels/842438759945601056/1060999298671718540/1060999298671718540

These are the sorts of inaccuracies noticed (please feel free to add more)

Additionally, is there anything we can to to assist the mental model when describing this behavior - is there a word for the "rerender without rerender"?

If there is appetite here to make some changes I can read through all the docs/tutorials and make sure we have the exhaustive list.

@RaghavBhat02
Copy link

I think it'd be a good idea

@manucorporat manucorporat added this to the BACKLOG: Post v1.0 milestone Mar 21, 2023
@zanettin zanettin added the COMP: docs Improvements or additions to documentation label Apr 26, 2023
@gioboa
Copy link
Member

gioboa commented Aug 26, 2023

@cmbartschat Thanks for your report. Would you like fix the docs for this particular topic?

@cmbartschat
Copy link
Contributor Author

Happy to! I just need a little bit of direction from a terminology standpoint. Is there a word the core team uses to describe the "rerender without rerender"?

How would these two processes be labelled?

  1. A component's render function gets run again in response to a signal change
  2. The DOM structure receives targeted updates in response to a signal change, without invoking component code

@mhevery mhevery added COMMUNITY: good first issue Good for newcomers COMMUNITY: PR is welcomed We think it's a good feature to have but would love for the community to help with the PR for it labels Aug 28, 2023
@mhevery
Copy link
Contributor

mhevery commented Aug 28, 2023

Thanks, this would make a significant community issue. Is anyone up for a PR?

@wtlin1228
Copy link
Contributor

@mhevery I'm working on it ✏️

@gioboa
Copy link
Member

gioboa commented Sep 3, 2023

Thanks @wtlin1228 💪

@mhevery
Copy link
Contributor

mhevery commented Sep 5, 2023

Closing this issue as PRs have landed...

@mhevery mhevery closed this as completed Sep 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
COMMUNITY: good first issue Good for newcomers COMMUNITY: PR is welcomed We think it's a good feature to have but would love for the community to help with the PR for it COMP: docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

7 participants