kazupon/vue-i18n

Docs idea: Make HTML binding with v-html less prevalent

Open

#594 opened on Jun 6, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (886 forks)batch import
good first issuehelp wanted

Repository metrics

Stars
 (7,181 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Being a newer user to vue-i18n, I accidentally was using the unsafe v-html binding solution after reading the docs on HTML Formatting. Going back through the docs, I now noticed the big warning at the top suggesting using component interpolation.

What do you think about showing an example of component interpolation under the HTML formatting section (https://kazupon.github.io/vue-i18n/guide/formatting.html#html-formatting) and de-emphasizing the v-html binding option, calling it out as an unsafe solution again before the example?

I think my eyes usually jump right to code examples and I skipped right over the big warning blocks that suggest component interpolation.

I'm happy to create a PR to improve the docs, but wanted feedback on the idea before I took the time to put together a PR.

Contributor guide

Research direction
Review the HTML formatting documentation at https://kazupon.github.io/vue i18n/guide/formatting.html#html formatting and propose changes to de emphasize the v html binding, adding a warning and promoting component interpolation with an example.
Tech stack
vuejavascript
Domain
frontend
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90