Microsoft/monaco-editor

Prevent formatDocument to steal focus

Open

#1245 opened on Dec 22, 2018

View on GitHub
 (2 comments) (1 reaction) (0 assignees)JavaScript (14,836 stars) (1,283 forks)batch import
feature-requesthelp wantedopen for PR

Description

monaco-editor version: 0.15.6 Browser: chrome OS: linux

I use this.editor.getAction('editor.action.formatDocument').run() to format a document. This works, but it also set's the focus to the the editor. Is that intended behaviour? Is there a way to disable the change of focus?

Contributor guide

Tech stack
javascripttypescript
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of Monaco Editor API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
The issue reports that calling `editor.getAction('editor.action.formatDocument').run()` steals focus to the editor. The fix likely involves ensuring that formatting does not change focus. Start by examining the Monaco Editor source code in `vs/editor/contrib/format/formatActions.ts` or similar files to see how the format action is implemented and where focus is set. Check the `run()` method of the action to identify if focus is explicitly set. Consider passing an option to suppress focus change or modifying the action to not focus conditionally. Look at related issues or PRs in the repository for similar focus related fixes.