mapbox / mapbox/jazzy-theme

Stylesheet hardcodes abstract class names

Open
#2 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
2
Forks
3
PR merge metrics
No merged PRs in 30d

Description

The stylesheet currently hardcodes the names of abstract classes in the iOS map SDK in order to gloss them with “(Abstract Class)”. It would be awkward for another library like MapboxGeocoder.swift or MapboxDirections.swift to adopt this stylesheet; we’d need to add those libraries’ abstract classes, which could get out of control fast.

Ideally we’d find a way to insert that gloss as plain text instead of as CSS generated content, but at the least, we should factor out this list of abstract classes. SCSS allows for variables; it might also be possible to specify the variables at compile time.

https://github.com/mapbox/jazzy-theme/blob/22c2edaa33a17255f9b99ff28748a788211ab74c/assets/css/jazzy.css.scss#L387-L394

/ref mapbox/mapbox-gl-native#7478
/cc @friedbunny @captainbarbosa

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.

Research direction

Start in assets/css/jazzy.css.scss at lines 387-394, where the abstract class names are hardcoded. Examine how the stylesheet adds the “(Abstract Class)” gloss and consider the issue’s SCSS-variable or plain-text alternatives. Done means the theme can support other Mapbox SDKs without editing a growing list of class names.

Written by the indexing model from the issue text.

Assessment

Tech stack
scss
Domain
documentation
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.