VSCode button or command to toggle inlay hints

[DrSensor]

I notice that changing inlay hints in the settings will directly enable/disable it which reflect on the editor.

It would be nice if there is a button in the statusbar (or at least a command) to toggle Inlay Hints 😉

[tigregalis]

@DrSensor I figured that this idea of changing settings on demand (e.g. from a keybinding) had to have a more general solution, so I did some searching, and I've come up with this workaround to change it via a keybinding*:

1. Install the extension Settings Cycler by Cody Hoover

2. Add the below to your keybindings.json:

  {
    "key": "F4", // key to press to activate command
    "command": "settings.cycle", // `settings.cycle` is the command that's actually being run, from the extension `hoovercj.vscode-settings-cycler`
    "when": "editorTextFocus && editorLangId == 'rust'", // this keybinding is only active when (editor is in focus) and (the language is `rust`)
    "args": { // these are the arguments passed to `settings.cycle`
      "id": "rust-toggle-inlay-hints", // must be unique
      "overrideWorkspaceSettings": true,
      "values": [ // Note: use the same settings in each values object
        {
          "rust-analyzer.displayInlayHints": false // sets the inlay hints off
        },
        {
          "rust-analyzer.displayInlayHints": true // sets the inlay hints on
        }
      ]
    }
  },

*It doesn't technically give you a statusbar button or a command, but imo a keybinding is even easier than those two.

[DrSensor]

Woah, just tested and it works! I think someday there will be a similar extension but with a bunch of buttons in the activity bar 😎

Maybe those tips should be documented on ./docs/user/recipes.md 🤔

[IcanDivideBy0]

Rust analyser setting name changed to:

rust-analyzer.inlayHints.enable

Otherwise, thanks for the tip, works like a charm!

[matklad]

Actually, I think it still will be useful to have a "toggle inlay hints" command in rust-analyzer, if just for discoverability.

[jknight]

This is great ! I mapped it to option+f

The copy and paste version from @tigregalis + @IcanDivideBy0 is

{
    "key": "alt+f", // key to press to activate command
    "command": "settings.cycle", // `settings.cycle` is the command that's actually being run, from the extension `hoovercj.vscode-settings-cycler`
    "when": "editorTextFocus && editorLangId == 'rust'", // this keybinding is only active when (editor is in focus) and (the language is `rust`)
    "args": { // these are the arguments passed to `settings.cycle`
      "id": "rust-toggle-inlay-hints", // must be unique
      "overrideWorkspaceSettings": true,
      "values": [ // Note: use the same settings in each values object
        {
          "rust-analyzer.inlayHints.enable": false // sets the inlay hints off
        },
        {
          "rust-analyzer.inlayHints.enable": true // sets the inlay hints on
        }
      ]
    }
  },

[JennDahm]

Just for others' awareness, #4601 introduced an official "toggle inlay hints" command that you can bind to a key combination or run in the quick command menu!

(This issue is pretty old, but it was the top result when I was searching for ways to modify when inlay hints are displayed, so I figured I should leave a comment for anyone else stumbling across it in their searches!)

[hima77]

I modified like the below.
and it works

{
"key": "F4", // key to press to activate command
"command": "settings.cycle", // settings.cycle is the command that's actually being run, from the extension hoovercj.vscode-settings-cycler
"when": "editorTextFocus && editorLangId == 'rust'", // this keybinding is only active when (editor is in focus) and (the language is rust)
"args": { // these are the arguments passed to settings.cycle
"id": "rust-analyzer.inlayHints.typeHints", // must be unique
"overrideWorkspaceSettings": true,
"values": [ // Note: use the same settings in each values object
{
"rust-analyzer.inlayHints.typeHints.enable": false // sets the inlay hints off
},
{
"rust-analyzer.inlayHints.typeHints.enable": true // sets the inlay hints on
}
]
}
},