[Bug] SelectableNavigator - shouldShowMenuForSelection is not disabling "Copy Link with Highlight" and "Writing Tools"

[ThugMike]

Describe the bug

Hey just want to first say I really appreciate Readium and all the support you provide for it!

In iOS 18.2, highlighting a section in the book still shows the "Copy Link with Highlight" and "Writing Tools" even when shouldShowMenuForSelection is set to false:

func navigator(_ navigator: SelectableNavigator, shouldShowMenuForSelection selection: Selection) -> Bool {
    return false
}

Any help would be greatly appreciated.

How to reproduce?

1. Open book
2. Highlight selection

Readium version

3.0.0-beta.1

OS version

18.2

Testing device

iPad Pro (M1)

Environment

macOS: 14.5
platform: arm64
carthage: N/A
Xcode 16.1
Build version 16B40

Additional context

No response

[mickael-menu]

I believe this is an issue in iOS 18.2 beta, as we cannot disable this action by overriding WKWebAction.canPerformAction(). I opened a bug report issue on https://feedbackassistant.apple.com/ and I urge anybody reading to do the same to make sure they address this issue before iOS 18.2 is released.

[ThugMike]

Hi @mickael-menu,
It seems despite the bug reports we submitted, we are still unable to override the actions.
Is there any workaround to disable these actions?
Thanks

[DetachedHeadState]

I got unexpectedly hit with this after updating to the released iOS 18.2. What I found after a day of digging into this is that the problem is that on iOS 18.2, the function buildMenu(with builder: UIMenuBuilder) is straight up not getting called anymore, and this is ultimately what is responsible for supressing these other edit actions. However it seems that if you implement the same method on the WebView itself, it will get called, so simply adding the following to WebView seems to fix the issue for me:

    @available(iOS 13.0, *)
    override func buildMenu(with builder: UIMenuBuilder) {
        editingActions.buildMenu(with: builder)
        super.buildMenu(with: builder)
    }

[ThugMike]

@DetachedHeadState That fixed it for me.
Thank you so much for the insight!

[mickael-menu]

@DetachedHeadState Thanks for investigating that, is it really all you changed? It doesn't work for me, and editingActions.buildMenu() is actually only removing specific actions, so that makes sense.

swift-toolkit/Sources/Navigator/EditingAction.swift

Lines 155 to 165 in 36f4151

	if !canPerformAction(.lookup) {
	builder.remove(menu: .lookup)
	}
	if !canPerformAction(.share) {
	builder.remove(menu: .share)
	}
	// Learn is removed as it seems bugged on iOS 17: it opens a Text
	// Expansion setting which allows to copy the selection.
	// To reproduce, comment out and select Japanese text on a PDF.
	builder.remove(menu: .learn)

It does remove the item if we don't call super.buildMenu(), but that might have other unintended consequences.

[mickael-menu]

I believe that Apple is adding this item with a generated identifier com.apple.menu.dynamic.EF7A91EE-DD02-42FF-A27E-42455C8C2F1A, which is... really unfortunate. Maybe the answer is to really prevent super in this case.

(lldb) po builder.menu(for: .root)?.children
▿ Optional<Array<UIMenuElement>>
  ▿ some : 9 elements
    - 0 : <UIMenu: 0x600001dd1540; identifier = com.apple.menu.standard-edit; options = (Inline); preferredElementSize = medium; children = <NSArray: 0x600003693c80>>
    - 1 : <UIMenu: 0x600001dd19a0; identifier = com.apple.menu.replace; options = (Inline); children = <NSArray: 0x600003692f00>>
    - 2 : <UIMenu: 0x600001dd1a40; identifier = com.apple.menu.open; options = (Inline); children = <NSArray: 0x104392eb0>>
    - 3 : <UIMenu: 0x600001dd1c20; title = Format; identifier = com.apple.menu.format; image = <UIImage: 0x600001e957a0; symbol = (bold.italic.underline)>; children = <NSArray: 0x6000023ca040>>
    - 4 : <UIMenu: 0x600001dd1cc0; identifier = com.apple.menu.lookup; options = (Inline); children = <NSArray: 0x6000023ca100>>
    - 5 : <UIMenu: 0x600001dd1d60; identifier = com.apple.menu.learn; options = (Inline); children = <NSArray: 0x600002e87dc0>>
    - 6 : <UIMenu: 0x600001dd1e00; title = Speech; identifier = com.apple.command.speech; options = (Inline); children = <NSArray: 0x6000023ca0d0>>
    - 7 : <UIMenu: 0x600001d94000; identifier = com.apple.menu.dynamic.EF7A91EE-DD02-42FF-A27E-42455C8C2F1A; options = (Inline); children = <NSArray: 0x600002e9c1e0>>
    - 8 : <UIMenu: 0x600001dd1ea0; identifier = com.apple.menu.share; options = (Inline); children = <NSArray: 0x600002e87ce0>>

[DetachedHeadState]

I do have some other modifications to the EditingActions.buildMenu code but I don't think they're related, if I comment them all out that menu item still doesn't show up. I also built a small sample app that just uses a webview directly and was able to reproduce the behavior there. From what I can see, the line that gets rid of it is builder.remove(menu: .share). I guess if you have other items that you want from that menu then you might still be in trouble. For me at least I don't want any of the built in actions and just want my own actions, so this fix works for me.

[mickael-menu]

Right, I confirm that the "Copy with Highlight" is removed with .share. This is unfortunate as you might want to keep "Share..." but not the "Copy with Highlight" item.

For now, I think I'll add the fix in WebView and indicate that "Share" and "Copy with Highlight" are synonymous.