Skip to content

Add initial chapter titles #2

Description

@hgzimmerman

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions