English / 日本語
Table of Contents:
This extension allows you to highlight selected text in the editor.
The highlights persist until explicitly removed, making this extension useful for temporarily marking words you want to keep in mind.
It was developed with functionality similar to the SublimeText plugin HighlightWords.
This extension is designed to be used with keyboard shortcuts. Please set up shortcuts first:
- Open "Preferences" > "Keyboard Shortcuts" (Win:
ctrl
+k
,ctrl
+s
/ Mac:cmd
+k
,cmd
+s
) - Search for the command by ID or name:
tettekete.toggle-highlight-word
orQuickHighlight: Toggle highlight
- Assign a key binding
You can highlight or remove highlights of selected text in the editor by:
- Entering the configured shortcut key
- Running
QuickHighlight: Toggle highlight
from the command palette - Selecting
Quick Highlight
>Toggle highlight
from the context menu
You can also remove highlights through the Quick Highlight
panel, as detailed below.
You can remove all highlights using one of the following methods:
- Open the context menu on highlighted text and select
Remove all highlight
- Execute
QuickHighlight: Remove all highlight
from the command palette - Remove highlights via the
Quick Highlight
panel
To navigate through highlighted words, it is essential that the text is either selected or the cursor is positioned within the highlighted text. You can then use one of the following methods to navigate:
- Select
QuickHighlight: Go to next highlight
orQuickHighlight: Go to previous highlight
from the command palette - Choose
Go to next highlight
orGo to previous highlight
from theQuick Highlight
submenu in the context menu
Additionally, you can navigate by clicking the target word in the Quick Highlight
panel or by using the respective commands from the context menu.
Note: Navigating through highlighted words requires that the text be highlighted or the cursor be within the highlighted text.
In the Quick Highlight
tab in the bottom panel of VSCode, you can manage highlighted words.
- Removing Highlights
- Click the × button that appears on the right end when you hover over the target text
- Right-click on the target text line and execute
Remove highlight
from the context menu
- Removing All Highlights
- Click the trash can icon that appears on the right end when you hover over the root node
- Navigating Highlights
- Click on the target word (
Go to next highlight
) - Select
Go to ...
from the context menu
- Click on the target word (
Command ID: tettekete.toggle-highlight-word
Toggles the highlight of the selected text: it removes the highlight if the text is currently highlighted, or highlights it if not.
Command ID: tettekete.remove-all-highlight
Removes all highlights.
Command ID: tettekete.goto-next-highlight
Moves to the next highlighted word when the cursor is on or selecting a highlighted text.
Command ID: tettekete.goto-prev-highlight
Moves to the previous highlighted word when the cursor is on or selecting a highlighted text.
Command ID: tettekete.toggle-config-case-sensitive
Toggles the Case Insensitivity setting in the config.
Note: This will not affect already highlighted texts and might make it harder to remove existing highlights. In such cases, use the Quick Highlight panel to remove them.
Command ID: tettekete.toggle-config-automatic-word-boundary-handling
Toggles the Automatic Word Boundary Handling setting in the config.
Note: This will not affect already highlighted texts and might make it harder to remove existing highlights. In such cases, use the Quick Highlight panel to remove them.
Config ID: quick-highlight.borderOnly
Default is OFF.
When enabled, only a border line will highlight the text without changing the background color.
Config ID: quick-highlight.caseInsensitive
Default is OFF.
When enabled, highlights words regardless of case.
Config ID: quick-highlight.automaticWordBoundaryHandling
Default is ON. If enabled, for example, when the word moon
surrounded by spaces or word boundaries is highlighted, it treats moon
as a separate word, so moon
in moonlight
will not be highlighted. However, if you select moon
in moonlight
, both instances will be highlighted.