guardian/scribe

Feature request: don't ever touch `innerHTML`

Open

#209 opened on Jun 25, 2014

View on GitHub
 (20 comments) (0 reactions) (0 assignees)JavaScript (3,516 stars) (265 forks)batch import
discussionhelp wantedpatch needed

Description

There's currently a very frustrating fundamental limitation in Scribe, which is that the "normalization" logic operates on raw HTML, rather then DOM nodes. This means plugins that get JavaScript references to DOM nodes end up becoming invalid because Scribe rewrites the DOM inside the editor and thus new nodes are created.

I'm currently having to do very hacky things like setting an id immediately before I know that the editor will be "normalized" and then getting a fresh DOM reference based off of the id. We've had to resort to hacks like this a few times already, and I'm trying to think of what a more compatible solution would be.

Contributor guide

Tech stack
javascript
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaScriptDOM manipulationScribe architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
15
Research direction
The issue involves replacing the innerHTML based normalization with DOM node manipulation. Research should start by examining the existing normalization logic in the Scribe source code, likely in files like './scribe.js' or './normalize.js'. Reviewing the comment history in issue #209 will provide insights into previous attempts and maintainer feedback. A concrete solution would involve using DOM APIs such as insertBefore or replaceChild instead of resetting innerHTML, ensuring plugins maintain valid references.