solidjs / solidjs/solid-docs

[Content]: Component Lifecycle diagram and more details

Open
#542 3 comments 0 reactions 1 assignee View on GitHub

Nobody has claimed this yet.

pending review
Dominant language
MDX
Stars
292
Forks
361
Avg merge
7h 51m
Merged PRs (30d)
1

Description

📚 Subject area/topic

Component Lifecycle

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

https://docs.solidjs.com/concepts/components/basics#component-lifecycles

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

The component lifecycle section is fairly short and only gives a high-level understanding of the topic. With Solid's lifecycle being pretty different from other frameworks and an important concept to understand I think there should be more content dedicated to this that goes more in depth.

  • Diagram of the component lifecycle
  • Include the lifecycle functions onMount, onCleanup
  • When elements are created
  • Explanation of how solid schedules updates
  • Include when the various effects are run (createEffect, createRenderEffect, createComputed)
  • When child components are created
  • Refs lifecycle (maybe just when they are attached)
🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

These are both just an initial attempt, more work would need to be done ideally from someone who understands these details way better than myself

Excalidraw diagram: https://excalidraw.com/#json=HGJ-iskfFERCO7F1AnRKd,G7Yv0q6qtHM2m12EcObpjw

SolidJS Playground: https://playground.solidjs.com/anonymous/0ed6a0ea-c7a8-4a14-a271-bbf1f446df2e

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.