Improve context menu

One unified context menu, simpler way to provide new items

Author: Wavesonics

ComposeTextEditor/src/androidMain/kotlin/com/darkrockstudios/texteditor/contextmenu/TextEditorContextMenuProvider.android.kt

@@ -22,6 +22,7 @@ actual fun TextEditorContextMenuProvider(
 				actions = actions,
 				strings = strings,
 				enabled = enabled,
+				extraItems = menuState.extraItems.value,
 				onDismiss = menuState::dismissMenu
 			)
 		}

ComposeTextEditor/src/commonMain/kotlin/com/darkrockstudios/texteditor/BasicTextEditor.kt

@@ -44,6 +44,7 @@ fun BasicTextEditor(
 	autoFocus: Boolean = false,
 	style: TextEditorStyle = rememberTextEditorStyle(),
 	contextMenuStrings: ContextMenuStrings = ContextMenuStrings.Default,
+	contextMenuState: TextEditorContextMenuState? = null,
 	onRichSpanClick: RichSpanClickListener? = null,
 	decorateLine: LineDecorator? = null,
 ) {
@@ -58,7 +59,10 @@ fun BasicTextEditor(
 		TextEditorInputModifierElement(state, clipboard, enabled)
 	}
 
-	val contextMenuState = remember { TextEditorContextMenuState() }
+	// Use provided context menu state or create internal one
+	val internalContextMenuState = remember { TextEditorContextMenuState() }
+	val effectiveContextMenuState = contextMenuState ?: internalContextMenuState
+
 	val contextMenuActions = remember(state, clipboard) {
 		ContextMenuActions(state, clipboard, state.scope)
 	}
@@ -84,7 +88,7 @@ fun BasicTextEditor(
 	}
 
 	TextEditorContextMenuProvider(
-		menuState = contextMenuState,
+		menuState = effectiveContextMenuState,
 		actions = contextMenuActions,
 		strings = contextMenuStrings,
 		enabled = enabled,
@@ -118,9 +122,7 @@ fun BasicTextEditor(
 						.textEditorPointerInputHandling(
 							state = state,
 							onSpanClick = onRichSpanClick,
-							onContextMenuRequest = { offset ->
-								contextMenuState.showMenu(offset)
-							}
+							onContextMenuRequest = { offset -> effectiveContextMenuState.showMenu(offset) }
 						)
 						.size(
 							width = state.viewportSize.width.dp,

ComposeTextEditor/src/commonMain/kotlin/com/darkrockstudios/texteditor/contextmenu/TextEditorContextMenu.kt

@@ -4,6 +4,7 @@ import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.offset
 import androidx.compose.material3.DropdownMenu
 import androidx.compose.material3.DropdownMenuItem
+import androidx.compose.material3.HorizontalDivider
 import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
@@ -13,11 +14,13 @@ import kotlin.math.roundToInt
 
 /**
  * Context menu dropdown for Cut, Copy, Paste, and Select All operations.
+ * Supports extra items that appear before the standard items.
  *
  * @param position The position where the menu should appear
  * @param actions The context menu actions handler
  * @param strings Localizable strings for menu items
  * @param enabled Whether editing operations (cut, paste) are enabled
+ * @param extraItems Extra menu items to display before standard items
  * @param onDismiss Callback when the menu should be dismissed
  */
 @Composable
@@ -26,6 +29,7 @@ internal fun TextEditorContextMenu(
 	actions: ContextMenuActions,
 	strings: ContextMenuStrings,
 	enabled: Boolean,
+	extraItems: List<ContextMenuItem> = emptyList(),
 	onDismiss: () -> Unit,
 ) {
 	Box(modifier = Modifier.offset {
@@ -38,6 +42,23 @@ internal fun TextEditorContextMenu(
 			expanded = true,
 			onDismissRequest = onDismiss,
 		) {
+			// Extra items first (e.g., spell check suggestions)
+			extraItems.forEach { item ->
+				DropdownMenuItem(
+					text = { Text(item.label) },
+					enabled = item.enabled,
+					onClick = {
+						item.onClick()
+						onDismiss()
+					},
+				)
+			}
+
+			// Divider between extra items and standard items
+			if (extraItems.isNotEmpty()) {
+				HorizontalDivider()
+			}
+
 			// Cut - requires selection and enabled
 			if (actions.canCut() && enabled) {
 				DropdownMenuItem(

ComposeTextEditor/src/commonMain/kotlin/com/darkrockstudios/texteditor/contextmenu/TextEditorContextMenuState.kt

@@ -4,16 +4,31 @@ import androidx.compose.runtime.MutableState
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.ui.geometry.Offset
 
+/**
+ * Represents a custom menu item that can be added to the context menu.
+ */
+data class ContextMenuItem(
+	val label: String,
+	val enabled: Boolean = true,
+	val onClick: () -> Unit
+)
+
 /**
  * State holder for the text editor context menu.
- * Tracks whether the menu is visible and its position.
+ * Tracks whether the menu is visible, its position, and any extra menu items.
  */
 class TextEditorContextMenuState {
 	/**
 	 * The position where the menu should be displayed, or null if hidden.
 	 */
 	val menuPosition: MutableState<Offset?> = mutableStateOf(null)
 
+	/**
+	 * Extra menu items to display before the standard items (Cut, Copy, Paste, Select All).
+	 * These are rendered first, followed by a divider if non-empty.
+	 */
+	val extraItems: MutableState<List<ContextMenuItem>> = mutableStateOf(emptyList())
+
 	/**
 	 * Whether the menu is currently visible.
 	 */
@@ -28,9 +43,18 @@ class TextEditorContextMenuState {
 	}
 
 	/**
-	 * Dismiss the context menu.
+	 * Show the context menu at the specified position with extra items.
+	 */
+	fun showMenu(position: Offset, items: List<ContextMenuItem>) {
+		extraItems.value = items
+		menuPosition.value = position
+	}
+
+	/**
+	 * Dismiss the context menu and clear extra items.
 	 */
 	fun dismissMenu() {
 		menuPosition.value = null
+		extraItems.value = emptyList()
 	}
 }

ComposeTextEditor/src/desktopMain/kotlin/com/darkrockstudios/texteditor/contextmenu/TextEditorContextMenuProvider.desktop.kt

@@ -22,6 +22,7 @@ actual fun TextEditorContextMenuProvider(
 				actions = actions,
 				strings = strings,
 				enabled = enabled,
+				extraItems = menuState.extraItems.value,
 				onDismiss = menuState::dismissMenu
 			)
 		}

ComposeTextEditor/src/iosMain/kotlin/com/darkrockstudios/texteditor/contextmenu/TextEditorContextMenuProvider.ios.kt

@@ -22,6 +22,7 @@ actual fun TextEditorContextMenuProvider(
 				actions = actions,
 				strings = strings,
 				enabled = enabled,
+				extraItems = menuState.extraItems.value,
 				onDismiss = menuState::dismissMenu
 			)
 		}

ComposeTextEditor/src/wasmJsMain/kotlin/com/darkrockstudios/texteditor/contextmenu/TextEditorContextMenuProvider.wasmJs.kt

@@ -22,6 +22,7 @@ actual fun TextEditorContextMenuProvider(
 				actions = actions,
 				strings = strings,
 				enabled = enabled,
+				extraItems = menuState.extraItems.value,
 				onDismiss = menuState::dismissMenu
 			)
 		}

ComposeTextEditorSpellCheck/src/androidMain/kotlin/com/darkrockstudios/texteditor/spellcheck/SpellCheckTextContextMenuProvider.android.kt

@@ -0,0 +1,12 @@
+package com.darkrockstudios.texteditor.spellcheck
+
+import com.darkrockstudios.texteditor.spellcheck.api.Correction
+import com.darkrockstudios.texteditor.state.WordSegment
+
+/**
+ * Represents a spell check item that can be either a word-level misspelling or a sentence-level correction.
+ */
+sealed class SpellCheckItem {
+	data class MisspelledWord(val segment: WordSegment) : SpellCheckItem()
+	data class SentenceIssue(val correction: Correction) : SpellCheckItem()
+}