feat: allow starting linenumbers from set value #19
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
For some use-cases, users might want to use code-view to display a snippet of a bigger file (e.g. in a documentation website for a software library or in something like a diff-view). For this use-case, it can be confusing if the line numbers shown in code-view don't match the corresponding line numbers in the bigger file.
This change adds a
lineNumbersStart
property to the API to set the number the line numbers start counting from. A different option to add this to the API could be to allowlineNumbers
to be either aboolean
or anumber
and, when set to anumber
, have the value oflineNumbers
be the value that sets the starting point of the line numbers.This feature is similar to the
data-start
attribute in Prism.js, users migrating from prism to code-view might expect this behavior to be possible.Visual regression tests in the PR actions are failing because this PR makes visual changes.
Related links, issue #, if available: n/a
How has this been tested?
Review checklist
The following items are to be evaluated by the author(s) and the reviewer(s).
Correctness
CONTRIBUTING.md
.CONTRIBUTING.md
.Testing
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.