Add URL Parameter to Show Block IDs in Tooltip #9803
Merged
Conversation
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
…lock ids to the tooltip text for each block. I'm doubtful that an exported bool directly inside pxt.blocks is the best way to store this. Will need to run that by the team to get feedback.
srietkerk
reviewed
Dec 21, 2023
| @@ -716,7 +716,8 @@ namespace pxt.blocks { | |||
| block.setPreviousStatement(!(hasHandlers && !fn.attributes.handlerStatement) && fn.retType == "void"); | |||
| block.setNextStatement(!(hasHandlers && !fn.attributes.handlerStatement) && fn.retType == "void"); | |||
|
|
|||
| block.setTooltip(/^__/.test(fn.namespace) ? "" : fn.attributes.jsDoc); | |||
| block.setTooltip((/^__/.test(fn.namespace) ? "" : fn.attributes.jsDoc) + (pxt.blocks.showBlockIdInTooltip ? " (id: '" + fn.attributes.blockId + "')" : "")); | |||
There was a problem hiding this comment.
This is a question about validation since I know that this tooltip and the flag are largely for help with investigation/debugging there. For our blocks exist validation currently, are we only looking at block id? Just wanted to make sure that there weren't other identifiers that we were using to look for blocks because I remember in some docs work that I did early on, that qName was used, but I might be misremembering it's significance.
There was a problem hiding this comment.
I believe we check against the id and nothing else, though we could potentially change that in the future if needed.
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.
This adds the tooltipBlockIds URL parameter. When set to 1 in the URL (?tooltipBlockIds=1), blocks will include their block id in the tooltip when you hover over them.
I'm doubtful that an exported bool directly inside pxt.blocks is the best way to store this, but I figured I'd send the PR anyway and get feedback. If anyone has thoughts on a better approach, please let me know!