Skip to content

/ yew

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

Jump to bottom

Documentation for keys #1263

Open
totorigolo opened this issue May 25, 2020 · 13 comments
Open

Documentation for keys #1263

totorigolo opened this issue May 25, 2020 · 13 comments
Labels
💵 Funded on Issuehunt documentation good first issue
Projects
Pain Point: Performance Pain Point: Documentation

Comments

@totorigolo
Copy link
Contributor

@totorigolo totorigolo commented May 25, 2020 •
edited by issuehunt-app bot

Issuehunt badges

Yew has recently got support for keyed elements, but the documentation lacks any mention of them. A mention should be added in the website, the doc of yew::virtual_dom::key::Key should be improved and an example should be added (could just improve the ergonomics of keyed_list of #1231).

I think that this is a good first issue.

IssueHunt Summary

Backers (Total: $10.00)

Become a backer now!

Or submit a pull request to get the deposits!

Tips
@totorigolo totorigolo added the feature label May 25, 2020
@issuehunt-app
Copy link

@issuehunt-app issuehunt-app bot commented May 26, 2020

@jstarry has funded $5.00 to this issue.
@jstarry jstarry removed the feature label May 26, 2020
@issuehunt-app
Copy link

@issuehunt-app issuehunt-app bot commented May 26, 2020

@siku2 has funded $5.00 to this issue.
@captain-yossarian
Copy link
Contributor

@captain-yossarian captain-yossarian commented May 27, 2020

@jstarry @siku2 I will take it if you don't mind
@jstarry
Copy link
Member

@jstarry jstarry commented May 28, 2020

Go for it!
@captain-yossarian
Copy link
Contributor

@captain-yossarian captain-yossarian commented May 28, 2020

@jstarry

  1. A mention should be added in the website ...

Is this a good place to update docs in the website ?

  1. the doc of yew::virtual_dom:: key::Key should be improved ...

Where can I find the doc of key::Key ?

Thanks
@totorigolo
Copy link
Contributor Author

@totorigolo totorigolo commented May 28, 2020

Actually some code is not in master yet, see: #1231

I am currently working on it and I hope it gets merged soon.
@totorigolo
Copy link
Contributor Author

@totorigolo totorigolo commented May 28, 2020 

1. > A mention should be added in the website ...

Is this a good place to update docs in the website ?

See this page, it's already mentioned: https://yew.rs/docs/advanced-topics/optimizations
IMHO this should have its own page, a bit like with Elm: https://guide.elm-lang.org/optimization/keyed.html
@captain-yossarian
Copy link
Contributor

@captain-yossarian captain-yossarian commented May 29, 2020

@totorigolo thanks!
@captain-yossarian
Copy link
Contributor

@captain-yossarian captain-yossarian commented May 29, 2020

@jstarry @totorigolo Sorry guys, but I can't work on this issue.
@jstarry
Copy link
Member

@jstarry jstarry commented May 30, 2020

No problem, thanks for letting us know!
@tuckerthomas
Copy link

@tuckerthomas tuckerthomas commented Aug 1, 2020

Any chance I can take a look at this?
@jstarry
Copy link
Member

@jstarry jstarry commented Aug 15, 2020

@tuckerthomas yeah, that would be great!
@tuckerthomas
Copy link

@tuckerthomas tuckerthomas commented Aug 15, 2020

Sounds good, I'll see what I can do
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
💵 Funded on Issuehunt documentation good first issue
Projects
Pain Point: Performance
  
To do
Pain Point: Documentation
  
To do
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
@jstarry @totorigolo @tuckerthomas @captain-yossarian
You can’t perform that action at this time.