PrismJS/prism

Feature request - Line Highlight Plugin JS API

Open

#1093 opened on Feb 4, 2017

View on GitHub
 (1 comment) (2 reactions) (0 assignees)JavaScript (11,488 stars) (1,296 forks)batch import
enhancementgood first issueplugins

Description

Hello

Instead of removing the highlighter and changing data-line attr, I would love to have a method in the Line highligth to select lines. It makes sense to me for this plugin to have this kind of method, instead of hashlinking ( don't get me wrong, hashlinking has its uses ).

Thanks :D

Contributor guide

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.
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Knowledge of PrismJS line highlight pluginBasic JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requests adding a JavaScript API method to the Line Highlight plugin for selecting lines instead of manipulating data line attribute. The code for the Line Highlight plugin is likely in `plugins/line highlight/prism line highlight.js`. A new method like `selectLine(lineNumber)` should be added to the plugin's API. Look at existing method `highlightLines` or similar. The method should update the highlighting without removing existing highlights. Consider using the existing `Prism.plugins.lineHighlight` namespace.