feat(helper/toc): specify maximum number of items to output #5487
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,6 +3,7 @@ import { tocObj, escapeHTML, encodeURL } from 'hexo-util'; | |
| interface Options { | ||
| min_depth?: number; | ||
| max_depth?: number; | ||
| max_items?: number; | ||
| class?: string; | ||
| class_item?: string; | ||
| class_link?: string; | ||
|
|
@@ -17,6 +18,7 @@ function tocHelper(str: string, options: Options = {}) { | |
| options = Object.assign({ | ||
| min_depth: 1, | ||
| max_depth: 6, | ||
| max_items: Infinity, | ||
| class: 'toc', | ||
| class_item: '', | ||
| class_link: '', | ||
|
|
@@ -27,7 +29,7 @@ function tocHelper(str: string, options: Options = {}) { | |
| list_number: true | ||
| }, options); | ||
|
|
||
| const data = getAndTruncateTocObj(str, { min_depth: options.min_depth, max_depth: options.max_depth }, options.max_items); | ||
|
|
||
| if (!data.length) return ''; | ||
|
|
||
|
|
@@ -102,4 +104,26 @@ function tocHelper(str: string, options: Options = {}) { | |
| return result; | ||
| } | ||
|
|
||
| function getAndTruncateTocObj(str: string, options: {min_depth: number, max_depth: number}, max_items: number) { | ||
| let data = tocObj(str, { min_depth: options.min_depth, max_depth: options.max_depth }); | ||
|
|
||
| if (data.length === 0) { | ||
| return data; | ||
| } | ||
| if (max_items < 1) { | ||
| return data; | ||
| } | ||
|
|
||
| const min = Math.min(...data.map(item => item.level)); | ||
| const max = Math.max(...data.map(item => item.level)); | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. fixed: f8d04a6 |
||
|
|
||
| for (let currentLevel = max; data.length > max_items && currentLevel > min; currentLevel--) { | ||
| data = data.filter(item => item.level < currentLevel); | ||
| } | ||
|
Comment on lines
+121
to
+123
There was a problem hiding this comment. This might be inefficient (iterating data over and over again). But I don't have any better idea for now. |
||
|
|
||
| data = data.slice(0, max_items); | ||
SukkaW marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| return data; | ||
| } | ||
|
|
||
| export = tocHelper; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If the user does not need
max_items, then there is no need to perform this operation everytime.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed: c17db64
I thought it was necessary to avoid
tocObj()appearing multiple times in different places, so I wrote the skip judgment at the beginning ofgetAndTruncateTocObj()instead of where you gave the example.