Skip to content

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

feat: Accept suggestion on Enter (frontend-only localStorage pref) (#9016)

Chandan3ed090f5e26c
diff --git a/frontend/src/components/app-config/user-config-form.tsx b/frontend/src/components/app-config/user-config-form.tsx
index d075685428..777cd42f70 100644
--- a/frontend/src/components/app-config/user-config-form.tsx
+++ b/frontend/src/components/app-config/user-config-form.tsx
@@ -19,6 +19,7 @@ import { useForm } from "react-hook-form";
import type z from "zod";
import { Button } from "@/components/ui/button";
import { Checkbox } from "@/components/ui/checkbox";
+import { acceptCompletionOnEnterAtom } from "@/core/codemirror/completion/accept-on-enter-atom";
import {
Form,
FormControl,
@@ -118,6 +119,9 @@ const LOCALE_SYSTEM_VALUE = "__system__";
export const UserConfigForm: React.FC = () => {
const [config, setConfig] = useUserConfig();
+ const [acceptOnEnter, setAcceptOnEnter] = useAtom(
+ acceptCompletionOnEnterAtom,
+ );
const formElement = useRef<HTMLFormElement>(null);
const setKeyboardShortcutsOpen = useSetAtom(keyboardShortcutsAtom);
const [activeCategory, setActiveCategory] = useAtom(
@@ -446,6 +450,27 @@ export const UserConfigForm: React.FC = () => {
</div>
)}
/>
+ <div className="flex flex-col space-y-1">
+ <FormItem className={formItemClasses}>
+ <FormLabel className="font-normal">
+ Accept suggestion on Enter
+ </FormLabel>
+ <FormControl>
+ <Checkbox
+ data-testid="accept-completion-on-enter-checkbox"
+ checked={acceptOnEnter}
+ onCheckedChange={(checked) =>
+ setAcceptOnEnter(Boolean(checked))
+ }
+ />
+ </FormControl>
+ </FormItem>
+ <FormDescription>
+ When unchecked, pressing Enter inserts a new line instead of
+ accepting an autocomplete suggestion. Use Tab to accept
+ suggestions.
+ </FormDescription>
+ </div>
<FormField
control={form.control}
name="completion.signature_hint_on_typing"
diff --git a/frontend/src/components/editor/cell/code/cell-editor.tsx b/frontend/src/components/editor/cell/code/cell-editor.tsx
index 6388bb36bb..837d3666e5 100644
--- a/frontend/src/components/editor/cell/code/cell-editor.tsx
+++ b/frontend/src/components/editor/cell/code/cell-editor.tsx
@@ -13,6 +13,7 @@ import { useCellActions } from "@/core/cells/cells";
import { usePendingDeleteService } from "@/core/cells/pending-delete-service";
import type { CellData, CellRuntimeState } from "@/core/cells/types";
import { setupCodeMirror } from "@/core/codemirror/cm";
+import { acceptCompletionOnEnterAtom } from "@/core/codemirror/completion/accept-on-enter-atom";
import {
getInitialLanguageAdapter,
languageAdapterState,
@@ -146,6 +147,7 @@ const CellEditorInternal = ({
});
const autoInstantiate = useAtomValue(autoInstantiateAtom);
+ const acceptCompletionOnEnter = useAtomValue(acceptCompletionOnEnterAtom);
const afterToggleMarkdown = useEvent(() => {
maybeAddMarimoImport({
autoInstantiate,
@@ -212,6 +214,7 @@ const CellEditorInternal = ({
},
},
completionConfig: userConfig.completion,
+ acceptCompletionOnEnter,
keymapConfig: userConfig.keymap,
lspConfig: userConfig.language_servers,
theme,
@@ -261,6 +264,7 @@ const CellEditorInternal = ({
return extensions;
}, [
cellId,
+ acceptCompletionOnEnter,
userConfig.keymap,
userConfig.completion,
userConfig.language_servers,
diff --git a/frontend/src/core/codemirror/cm.ts b/frontend/src/core/codemirror/cm.ts
index 8ec91eb252..82cf2722ca 100644
--- a/frontend/src/core/codemirror/cm.ts
+++ b/frontend/src/core/codemirror/cm.ts
@@ -73,6 +73,7 @@ export interface CodeMirrorSetupOpts {
cellId: CellId;
showPlaceholder: boolean;
enableAI: boolean;
+ acceptCompletionOnEnter?: boolean;
cellActions: CodemirrorCellActions;
completionConfig: CompletionConfig;
keymapConfig: KeymapConfig;
@@ -175,6 +176,7 @@ export const basicBundle = (opts: CodeMirrorSetupOpts): Extension[] => {
theme,
hotkeys,
completionConfig,
+ acceptCompletionOnEnter,
cellId,
lspConfig,
diagnosticsConfig,
@@ -207,7 +209,7 @@ export const basicBundle = (opts: CodeMirrorSetupOpts): Extension[] => {
foldGutter(),
stringsAutoCloseBraces(),
closeBrackets(),
- completionKeymap(),
+ completionKeymap(acceptCompletionOnEnter),
// to avoid clash with charDeleteBackward keymap
Prec.high(keymap.of(closeBracketsKeymap)),
bracketMatching(),
diff --git a/frontend/src/core/codemirror/completion/__tests__/keymap.test.ts b/frontend/src/core/codemirror/completion/__tests__/keymap.test.ts
index 0366e6222e..219f52a881 100644
--- a/frontend/src/core/codemirror/completion/__tests__/keymap.test.ts
+++ b/frontend/src/core/codemirror/completion/__tests__/keymap.test.ts
@@ -1,8 +1,21 @@
/* Copyright 2026 Marimo. All rights reserved. */
import { completionKeymap as defaultCompletionKeymap } from "@codemirror/autocomplete";
+import { EditorState } from "@codemirror/state";
+import { keymap } from "@codemirror/view";
import { describe, expect, it } from "vitest";
-import { filterCompletionBindings } from "../keymap";
+import { completionKeymap, filterCompletionBindings } from "../keymap";
+
+function hasEnterBinding(acceptOnEnter: boolean): boolean {
+ const state = EditorState.create({
+ extensions: [completionKeymap(acceptOnEnter)],
+ });
+
+ return state
+ .facet(keymap)
+ .flat()
+ .some((binding) => binding.key === "Enter");
+}
describe("completionKeymap", () => {
it("upstream includes the macOS-only completion bindings we care about", () => {
@@ -21,4 +34,30 @@ describe("completionKeymap", () => {
expect(filtered.some((binding) => binding.key === "Escape")).toBe(false);
expect(filtered.some((binding) => binding.mac === "Alt-i")).toBe(true);
});
+
+ it("includes Enter by default", () => {
+ const filtered = filterCompletionBindings(defaultCompletionKeymap);
+ expect(filtered.some((binding) => binding.key === "Enter")).toBe(true);
+ });
+
+ it("removes Enter when passed a keysToRemove set containing Enter", () => {
+ const keysToRemove = new Set<string | undefined>([
+ "Escape",
+ "Alt-`",
+ "Enter",
+ ]);
+ const filtered = filterCompletionBindings(
+ defaultCompletionKeymap,
+ keysToRemove,
+ );
+ expect(filtered.some((binding) => binding.key === "Enter")).toBe(false);
+ });
+
+ it("completionKeymap includes Enter when acceptOnEnter is true", () => {
+ expect(hasEnterBinding(true)).toBe(true);
+ });
+
+ it("completionKeymap removes Enter when acceptOnEnter is false", () => {
+ expect(hasEnterBinding(false)).toBe(false);
+ });
});
diff --git a/frontend/src/core/codemirror/completion/accept-on-enter-atom.ts b/frontend/src/core/codemirror/completion/accept-on-enter-atom.ts
new file mode 100644
index 0000000000..2a4ed28aee
--- /dev/null
+++ b/frontend/src/core/codemirror/completion/accept-on-enter-atom.ts
@@ -0,0 +1,10 @@
+/* Copyright 2026 Marimo. All rights reserved. */
+import { atomWithStorage } from "jotai/utils";
+import { jotaiJsonStorage } from "@/utils/storage/jotai";
+// Default: true (Enter accepts suggestion, matching VS Code default)
+export const acceptCompletionOnEnterAtom = atomWithStorage<boolean>(
+ "marimo:accept-completion-on-enter",
+ true,
+ jotaiJsonStorage,
+ { getOnInit: true },
+);
diff --git a/frontend/src/core/codemirror/completion/keymap.ts b/frontend/src/core/codemirror/completion/keymap.ts
index 7c22f45727..d785bef75f 100644
--- a/frontend/src/core/codemirror/completion/keymap.ts
+++ b/frontend/src/core/codemirror/completion/keymap.ts
@@ -22,20 +22,27 @@ const KEYS_TO_REMOVE = new Set<string | undefined>([
"Alt-`",
]);
-function hasRemovedKeybinding(binding: KeyBinding): boolean {
- return [binding.key, binding.mac, binding.linux, binding.win].some((key) =>
- KEYS_TO_REMOVE.has(key),
- );
-}
-
export function filterCompletionBindings(
bindings: readonly KeyBinding[],
+ keysToRemove: Set<string | undefined> = KEYS_TO_REMOVE,
): readonly KeyBinding[] {
- return bindings.filter((binding) => !hasRemovedKeybinding(binding));
+ return bindings.filter(
+ (binding) =>
+ ![binding.key, binding.mac, binding.linux, binding.win].some((key) =>
+ keysToRemove.has(key),
+ ),
+ );
}
-export function completionKeymap(): Extension {
- const withoutKeysToRemove = filterCompletionBindings(defaultCompletionKeymap);
+export function completionKeymap(acceptOnEnter = true): Extension {
+ const keysToRemove = new Set(KEYS_TO_REMOVE);
+ if (!acceptOnEnter) {
+ keysToRemove.add("Enter");
+ }
+ const withoutKeysToRemove = filterCompletionBindings(
+ defaultCompletionKeymap,
+ keysToRemove,
+ );
return Prec.highest(
keymap.of([