Listen to browser clipboard events and bind them with Compose TextFieldSelectionManager and SelectionManager #1206
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| /* | ||
| * Copyright 2024 The Android Open Source Project | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package androidx.compose.foundation.text | ||
|
|
||
| import androidx.compose.foundation.text.selection.TextFieldSelectionManager | ||
| import androidx.compose.runtime.Composable | ||
| import androidx.compose.runtime.DisposableEffect | ||
| import androidx.compose.runtime.NonRestartableComposable | ||
| import androidx.compose.ui.text.AnnotatedString | ||
| import kotlinx.browser.document | ||
| import org.w3c.dom.clipboard.ClipboardEvent | ||
| import org.w3c.dom.events.Event | ||
| import org.w3c.dom.events.EventListener | ||
|
|
||
| @Composable | ||
| @NonRestartableComposable | ||
| internal actual inline fun rememberClipboardEventsHandler( | ||
| textFieldSelectionManager: TextFieldSelectionManager, | ||
| isFocused: Boolean | ||
| ) { | ||
| if (isFocused) { | ||
| DisposableEffect(textFieldSelectionManager) { | ||
|
|
||
| val onCopy = EventListenerWrapper { event -> | ||
| val textToCopy = textFieldSelectionManager.onCopyWithResult() | ||
| if (textToCopy != null && event is ClipboardEvent) { | ||
| event.clipboardData?.setData("text/plain", textToCopy) | ||
| event.preventDefault() | ||
| } | ||
| } | ||
|
|
||
| val onPaste = EventListenerWrapper { event -> | ||
| if (event is ClipboardEvent) { | ||
| val textToPaste = event.clipboardData?.getData("text/plain") ?: "" | ||
| event.preventDefault() | ||
| textFieldSelectionManager.paste(AnnotatedString(textToPaste)) | ||
| } | ||
| } | ||
|
|
||
| val onCut = EventListenerWrapper { event -> | ||
| if (event is ClipboardEvent) { | ||
| val cutText = textFieldSelectionManager.onCutWithResult() | ||
| event.clipboardData?.setData("text/plain", cutText ?: "") | ||
| event.preventDefault() | ||
| } | ||
| } | ||
|
|
||
| document.addEventListener("copy", onCopy) | ||
| document.addEventListener("paste", onPaste) | ||
| document.addEventListener("cut", onCut) | ||
|
|
||
| return@DisposableEffect onDispose { | ||
| document.removeEventListener("copy", onCopy) | ||
| document.removeEventListener("paste", onPaste) | ||
| document.removeEventListener("cut", onCut) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun EventListenerWrapper(handler: (Event) -> Unit): EventListener = | ||
| EventListener { handler(it) } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| /* | ||
|
There was a problem hiding this comment. This is not a new file. It was renamed from |
||
| * Copyright 2023 The Android Open Source Project | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package androidx.compose.foundation.text | ||
|
|
||
| import androidx.compose.ui.input.key.Key | ||
| import androidx.compose.ui.input.key.KeyEvent | ||
| import androidx.compose.ui.input.key.isCtrlPressed | ||
| import androidx.compose.ui.input.key.isMetaPressed | ||
| import androidx.compose.ui.input.key.key | ||
| import org.jetbrains.skiko.OS | ||
| import org.jetbrains.skiko.hostOs | ||
|
|
||
| internal actual val platformDefaultKeyMapping: KeyMapping = createPlatformDefaultKeyMapping(hostOs) | ||
|
|
||
| internal fun createPlatformDefaultKeyMapping(platform: OS): KeyMapping { | ||
| val keyMapping = when (platform) { | ||
| OS.MacOS -> createMacosDefaultKeyMapping() | ||
| else -> defaultKeyMapping | ||
| } | ||
| return object : KeyMapping { | ||
| private val clipboardKeys = setOf(Key.C, Key.V, Key.X) | ||
|
|
||
| override fun map(event: KeyEvent): KeyCommand? { | ||
| val isCtrlOrCmd = if (hostOs.isMacOS) event.isMetaPressed else event.isCtrlPressed | ||
| if (isCtrlOrCmd && event.key in clipboardKeys) { | ||
| // we let a browser dispatch a clipboard event | ||
| return null | ||
| } | ||
| return keyMapping.map(event) | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| /* | ||
| * Copyright 2024 The Android Open Source Project | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package androidx.compose.foundation.text | ||
|
|
||
| import androidx.compose.foundation.text.selection.TextFieldSelectionManager | ||
| import androidx.compose.runtime.Composable | ||
|
|
||
| @Composable | ||
| internal actual inline fun rememberClipboardEventsHandler( | ||
| textFieldSelectionManager: TextFieldSelectionManager, | ||
| isFocused: Boolean | ||
| ) { | ||
| // nothing to do | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| /* | ||
| * Copyright 2024 The Android Open Source Project | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package androidx.compose.foundation.text | ||
|
|
||
| import androidx.compose.foundation.text.selection.TextFieldSelectionManager | ||
| import androidx.compose.runtime.Composable | ||
| import androidx.compose.runtime.DisposableEffect | ||
| import androidx.compose.runtime.NonRestartableComposable | ||
| import androidx.compose.ui.text.AnnotatedString | ||
| import kotlinx.browser.document | ||
| import org.w3c.dom.clipboard.ClipboardEvent | ||
| import org.w3c.dom.events.Event | ||
| import org.w3c.dom.events.EventListener | ||
|
|
||
| @Composable | ||
| @NonRestartableComposable | ||
| internal actual inline fun rememberClipboardEventsHandler( | ||
| textFieldSelectionManager: TextFieldSelectionManager, | ||
| isFocused: Boolean | ||
| ) { | ||
| if (isFocused) { | ||
| DisposableEffect(textFieldSelectionManager) { | ||
|
|
||
| val onCopy = EventListenerWrapper { event -> | ||
| val textToCopy = textFieldSelectionManager.onCopyWithResult() | ||
| if (textToCopy != null && event is ClipboardEvent) { | ||
| event.clipboardData?.setData("text/plain", textToCopy) | ||
| event.preventDefault() | ||
| } | ||
| } | ||
|
|
||
| val onPaste = EventListenerWrapper { event -> | ||
| if (event is ClipboardEvent) { | ||
| val textToPaste = event.clipboardData?.getData("text/plain") ?: "" | ||
| event.preventDefault() | ||
| textFieldSelectionManager.paste(AnnotatedString(textToPaste)) | ||
| } | ||
| } | ||
|
|
||
| val onCut = EventListenerWrapper { event -> | ||
| if (event is ClipboardEvent) { | ||
| val cutText = textFieldSelectionManager.onCutWithResult() | ||
| event.clipboardData?.setData("text/plain", cutText ?: "") | ||
| event.preventDefault() | ||
| } | ||
| } | ||
|
|
||
| document.addEventListener("copy", onCopy) | ||
| document.addEventListener("paste", onPaste) | ||
| document.addEventListener("cut", onCut) | ||
|
|
||
| return@DisposableEffect onDispose { | ||
| document.removeEventListener("copy", onCopy) | ||
| document.removeEventListener("paste", onPaste) | ||
| document.removeEventListener("cut", onCut) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun EventListenerWrapper(handler: (Event) -> Unit): EventListener = | ||
| js("(event) => { handler(event) }") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what worries me that we are introducing a platform-specific hook to the common so that we do something on one platform. I do realise that this is sometimes unavoidable, all I'm trying to say that before it's unavoidable it worth to invest into investigating any non-invasiva alternative/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I looked once again and I reach a conclusion that to implement this feature, we can't avoid changing common. Here is what I base my conclusion on:
There're similar cases when one platform has a feature/function implemented, while all other platfroms have just empty function body.
The fact that we change the common code here, doesn't require us to urgently upstream this change, because it's an internal implementation detail which doesn't affect android behaviour.