blockly > Tooltip > setCustomTooltip
Sets a custom function that will be called if present instead of the default tooltip UI.
Signature:
export declare function setCustomTooltip(customFn: CustomTooltip): void;
Parameters
| Parameter |
Type |
Description |
| customFn |
CustomTooltip |
A custom tooltip used to render an alternate tooltip UI. |
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.
[null,null,["Last updated 2024-09-18 UTC."],[[["Enables the use of a custom function to display tooltips instead of the default Blockly tooltip UI."],["Accepts a single argument: a `CustomTooltip` function that defines the alternative tooltip rendering logic."],["Replaces the standard tooltip behavior with the provided custom implementation."],["Does not return any value, simply updates the tooltip handling mechanism."]]],["The `Tooltip.setCustomTooltip()` function allows users to replace the default tooltip UI with a custom one. It takes a single parameter, `customFn`, of the type `CustomTooltip`. This `customFn` is the custom function that will be called to render the alternate tooltip UI. The function doesn't return any value. The function is used to change the tooltip UI.\n"]]
