preactjs/preact-www

Add list of APIs used by Preact

Open

#108 opened on Mar 14, 2017

View on GitHub
 (3 comments) (2 reactions) (0 assignees)JavaScript (519 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (380 stars)
PR merge metrics
 (PR metrics pending)

Description

As suggested in developit/preact#585. Here's the list I came up with:

Browser APIs Preact Uses

  • It will use Promise only if available, falling back to setTimeout(0)
  • DOM APIs used are very minimal DOM core 1 / 2:
    • document.createElement() and document.createTextNode()
    • Text.prototype.nodeValue
    • Text.prototype.splitText - simply needs to exist (used as fast "is text node" check)
    • From Element.prototype:
      • .attributes NodeList
      • .setAttribute(), .getAttribute(), .removeAttribute()
      • .appendChild(), .insertBefore(), .replaceChild()

If you use SVG, createElementNS() and (get|set|remove)AttributeNS() are used.

Contributor guide

Research direction
Review the list of APIs provided in the issue and add them to the Preact documentation website, likely in a 'Browser APIs' section.
Tech stack
javascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90