developit/htm

Ampersand escapes in text content handled differently to JSX

Open

#76 opened on Mar 15, 2019

View on GitHub
 (11 comments) (5 reactions) (0 assignees)JavaScript (181 forks)batch import
discussionhelp wanted

Repository metrics

Stars
 (8,453 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Reproduction

With the following code:

import htm from "https://unpkg.com/htm@2.1.1/dist/htm.mjs";
import { h } from "https://unpkg.com/preact@8.4.2/dist/preact.mjs";
const html = htm.bind(h);

console.log(html`<div>&lt;</div>`)

I get a VNode with .children = ["&lt;"] — i.e. what I mean to render as < gets rendered as &lt; instead.

Expected results

Testing this in JSX via say https://jsx.egoist.moe/?mode=vue, <div>&lt;</div> gets transformed into h("div", ["<"]); as I originally expected.

I haven't poked into how they are doing this… seems like something that ultimately relies on a lookup table.

Workaround

I am able to escape via string interpolation (e.g. ${'<'} instead of &lt;). Changing the last line in my sample code to:

// …

console.log(html`<div>${'<'}</div>`)

Results in a VNode with .children = ["<"] as I need. Is this the recommended style?

Contributor guide

Research direction
Examine the htm source code to understand how it currently handles HTML entity escapes in template literals, compare with JSX behavior, and determine if a lookup table or replacement mechanism is needed.
Tech stack
javascript
Domain
frontend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
JavaScripthtm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60