enable/disable all `Metals › Inlay Hints` using button like IntelliJ's `X-Ray Mode`

[eranmizrahi1]

Is your feature request related to a problem? Please describe.

usually, i dont want to see all Metals › Inlay Hints.
but, sometimes during coding, i would like to enable it, and it is not convenient to go to the Setting and enable it, and than again disable it

Describe the solution you'd like

add a button/toggle which behaves like IntelliJ's X-Ray Mode:

enable/disable all Metals › Inlay Hints

Describe alternatives you've considered

goto the Settings

Additional context

No response

Search terms

x-ray, xray, Inlay Hints

[tgodzik]

Thanks for reporting! We do have a toggle command (in VS Code) that can enable any inlay hints you might want. All of them are available in command palette (search for "Metals: toggle.."). They can also be bound to shortcuts

[eranmizrahi1]

@tgodzik thanks for your reply.
i mean enable/disable all Metals › Inlay Hints at once:

i added a command as you suggested, and i see it enables/disables Metals › Inlay Hints › Hints X Ray Mode,
but i would like to enable/disable all Inlay Hints options as in IntelliJ

[eranmizrahi1]

@tgodzik
i managed to solve it using the extension Settings Cycler,
although i think it is better to have a button out-of-the-box like in IntelliJ when a scala file is opened.

Here are the steps:

Step 1: Configure Settings to Toggle

Press Cmd+Shift+P

Type "Preferences: Open User Settings (JSON)"

Add this configuration:

{
 ...
  
    "settings.cycle": [
        {
            "id": "toggleMetalsInlayHints",
            "overrideWorkspaceSettings": true,
            "values": [
                {
                    "metals.inlayHints.hintsXRayMode.enable": true,
                    "metals.inlayHints.byNameParameters.enable": true,
                    "metals.inlayHints.implicitArguments.enable": true,
                    "metals.inlayHints.implicitConversions.enable": true,
                    "metals.inlayHints.inferredTypes.enable": true,
                    "metals.inlayHints.namedParameters.enable": true,
                    "metals.inlayHints.typeParameters.enable": true,
                    "metals.inlayHints.hintsInPatternMatch.enable": true,
                    "metals.inlayHints.closingLabels.enable": true
                },
                {
                    "metals.inlayHints.hintsXRayMode.enable": false,
                    "metals.inlayHints.byNameParameters.enable": false,
                    "metals.inlayHints.implicitArguments.enable": false,
                    "metals.inlayHints.implicitConversions.enable": false,
                    "metals.inlayHints.inferredTypes.enable": false,
                    "metals.inlayHints.namedParameters.enable": false,
                    "metals.inlayHints.typeParameters.enable": false,
                    "metals.inlayHints.hintsInPatternMatch.enable": false,
                    "metals.inlayHints.closingLabels.enable": false
                }
            ]
        }
    ]
}

Step 2: Add Keybinding

Press Cmd+Shift+P

Type "Preferences: Open Keyboard Shortcuts (JSON)"

Add this keybinding:

{
  "key": "cmd+shift+h",
  "command": "settings.cycle.toggleMetalsInlayHints"
}