DEV: Expand top_tags to return an array of tag objects instead of tag names #36678
Conversation
This file contains hidden or 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
nattsw
commented
Dec 14, 2025
| get tagClassNames() { | ||
| return this.args.topic.tags?.map((tagName) => `tag-${tagName}`); | ||
| return this.args.topic.tags?.map((tag) => { | ||
| const tagName = typeof tag === "string" ? tag : tag.name; |
Contributor
Author
There was a problem hiding this comment.
Locally, I have this prepended in all the frontend files affected
if (typeof tag === "string") {
// print the trace here so we know who is violating
console.warn(
`Topic tag is a string (${tag}) - this will be deprecated soon. Please pass tag objects instead.`
);
console.warn(new Error().stack);
}
But am thinking of a better way.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently in several endpoints (topic list, sidebar, etc), we return an array of strings for tags, e.g.
topic_list.top_tags = ["tag-name1", "tag-name2"].This PR
[{ id: 123, name: "tag-name1" }, { id:213, name: "tag-name2" }].tagName, when necessary, uses references totagIdThis allows us to return more information for a tag for future features.
At the same time, we keep compatibility in places where an array of strings are used. In time we will retire this backward compatibility.
(need to find best way to add warning)