Stay organized with collections
Save and categorize content based on your preferences.
blockly > Block > setHelpUrl
Block.setHelpUrl() method
Set the URL of this block's help page.
Signature:
setHelpUrl(url: string | Function): void;
Parameters
| Parameter |
Type |
Description |
| url |
string | Function |
URL string for block help, or function that returns a URL. Null for no help. |
Returns:
void
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["The `setHelpUrl` method allows you to assign a help URL to a Blockly block, providing users with additional information or guidance."],["You can provide a URL string directly or use a function that returns a URL string to dynamically generate the help URL."],["Setting the URL to null will effectively remove any existing help link for that specific block."]]],["The `Block.setHelpUrl()` method sets the help page URL for a block. It accepts a `url` parameter, which can be either a string representing the URL or a function that returns a URL. Passing `null` disables the help link. The method's return type is void, meaning it does not return any value. The primary action is assigning a help URL to a block for user guidance.\n"]]
