mapbox / mapbox/mapbox-gl-js

Print console warning for maps that use RTL text without RTL text plugin

Open
#6,136 0 comments 0 reactions 1 assignee View on GitHub

@ChrisLoer is already working on this.

Since Feb 12, 2018.

api :memo:
Dominant language
TypeScript
Stars
12.4k
Forks
2.4k
PR merge metrics
No merged PRs in 30d

Description

When we added the RTL text plugin, we wanted to make it have no overhead/configuration complexity for people who didn't need it, on the assumption that motivated users would find the plugin and turn it on. However, if a developer wants to make a map that uses local language labels around the world, they may not even realize that RTL text isn't displaying correctly.

As a stop-gap, I think we should just add a console warning whenever we render text that requires the RTL plugin and it's not enabled. The warning should be minimally disruptive/almost invisible to users, but a map developer is pretty likely to see it and it's an easily actionable error message.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.