[BUG] press enter when using IME causes unwanted file open in vault search command palette

[reorx]

Problem description:

When typing by input method editor (IME) in a modal input (e.g. triggered by a Capture command), if enter is hit, the text is submitted immediately.

To Reproduce

1. Open omnisearch vault search command palette
2. Switch to an IME (most of them are CJK language)
3. Type something
4. Press enter, and the first file is opened

obsidian-omnisearch.mov

Here you can see I typed test in the IME, then I pressed enter, I intended to insert test in the input and continue typing, but the input was submitted and the file is opened.

Additional context

In CJK IME, when enter is hit, it means to insert the text without converting it to the CJK character, this is a common trick to insert English words without turning off the IME.

By listening to Element: compositionstart event - Web APIs | MDN,
we can determine whether the enter key means to insert text or submit.
Here's a snippet I used in my projects:

interface CompositionState {
	lock: boolean
}

export function lockInputMethodComposition(el: HTMLInputElement): CompositionState {
	const state: CompositionState = {
		lock: false,
	}
	el.addEventListener('compositionstart', () => {
		state.lock = true
	})
	el.addEventListener('compositionend', () => {
		state.lock = false
	})
	return state
}

const nameInputState = lockInputMethodComposition(nameInputEl)
nameInputEl.addEventListener('keydown', async (e) => {
	if (e.key === 'Enter' && !nameInputState.lock) {
		e.preventDefault()
		// do things like submit the input here
	}
})

Reference: dom events - What is JavaScript's CompositionEvent? Please give examples - Stack Overflow

Your environment:

• Omnisearch version: 1.2.1
• Obsidian version: v0.14.6
• Operating system: Darwin Kernel Version 21.4.0: Mon Feb 21 20:36:53 PST 2022; root:xnu-
• Number of notes in your vault (approx.): 500
• Other plugins that may be related to the issue:

[scambier]

Thanks for that detailled issue! Would you mind trying this fix and tell me if it's working?

omnisearch composition.zip

[reorx]

Work as expected, thank you for the quick response and agile fix!