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

Add initial chapter titles #2

Open
hgzimmerman opened this issue Aug 12, 2019 · 1 comment
Open

Add initial chapter titles #2

hgzimmerman opened this issue Aug 12, 2019 · 1 comment

Comments

@hgzimmerman
Copy link
Member

I'd like to take a stab at contributing to this project, but would at least like an outline of what content is needed.

I think it would make sense to break apart what is currently in the Readme for Yew into individual chapters and go more in-depth with their content.

Just to get something out there, I think the following chapters covering these subsections could be a good place to start:

  • Intro
  • Getting started
    • links to template projects
    • Minimal template code ("do it" example) currently in Readme.
    • CargoWeb vs wasm-bindgen
  • Component lifecycle
    • Common: Create, Update, Change, View
    • More obscure/ Actor related: On Mount, Destroy
    • Props & Callbacks
  • html! macro
    • Syntax similarities vs normal html vs JSX
      • Explanation of closure -> Callback conversion (??)
      • Comments
    • SVG support
    • Fragments
  • Actors
    • Description of actor pattern, how Yew uses it.
    • Explanation of different Reaches (eg: which thread is this code running on?).
    • Examples for Job, Context, Public.
  • Services
    • Existing services
    • How to wrap JS libs.
    • Serde.
  • Novel Patterns and Examples
    • Sender/Receiver Actor pattern.
    • Actor wrapping a Service.
    • Canvas use.
    • Maybe steal some code from yew/examples/.
    • Encourage people to open PRs with novel uses of Yew.
@hgzimmerman
Copy link
Member Author

  • How to interoperate with JS.
    • How to import and use JS libs
    • How to include the js libs in a build toolchain, so they get minified and tree-shaken

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

1 participant