fregante/GhostText

Improve UX expectations for `contentEditable`

Open

#261 opened on Mar 14, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (133 forks)github user discovery
UXbrowserhelp wanted

Repository metrics

Stars
 (3,611 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

contentEditable is sent as raw HTML. This is usually expected (judging by the wording used in feature requests and bug reports)

At a minimum, there should be a (permanent?) notification explaining what's happening. I don't want to introduce a confirmation popup, even if it only appears once (because then that information would be lost)

Maybe this information should just be part of the connection popup:

  • Connected to plain text field
  • Connected to raw HTML field. More info
  • Connected to CodeMirror field

The link would point to: https://ghosttext.fregante.com/troubleshooting/

Often contentEditable appears for unrecognized editors, so the help page should include this, perhaps suggesting to switch to the plain text field if one is available (#249, #219)

Also:

Contributor guide

Research direction
Discuss options for showing a permanent notification or updating the connection popup to indicate whether a field is plain text, raw HTML, or CodeMirror. Consider adding a link to the troubleshooting page.
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.
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitBrowser extension basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90