自定义NSMenu子类及MenuItemView不响应鼠标点击问题排查

核心原因 #

重写willOpenMenu时若未调用父类实现，会破坏NSMenu原生的事件绑定、状态同步机制——原生菜单打开时会自动为菜单项视图配置鼠标追踪、高亮触发、点击响应的关联逻辑，跳过这一步会导致自定义视图无法与菜单状态联动。

具体问题修复 #

1. 高亮状态异常、点击无法关闭菜单 #

• 必须在重写的willOpenMenu中先调用父类方法，保留原生逻辑：

  class CustomMenu: NSMenu {
      override func willOpenMenu() {
          super.willOpenMenu() // 关键：不能省略父类调用
          // 你的自定义视图设置逻辑
      }
  }
  

• 自定义CustomMenuItemView需主动同步NSMenuItem状态，实现鼠标事件响应：

  class CustomMenuItemView: NSView {
      weak var menuItem: NSMenuItem?
      
      override init(frame frameRect: NSRect) {
          super.init(frame: frameRect)
          // 开启鼠标追踪
          let trackingArea = NSTrackingArea(rect: bounds, options: [.mouseEnteredAndExited, .activeInKeyWindow], owner: self, userInfo: nil)
          addTrackingArea(trackingArea)
      }
      
      required init?(coder: NSCoder) {
          super.init(coder: coder)
      }
      
      override func mouseEntered(with event: NSEvent) {
          super.mouseEntered(with: event)
          menuItem?.highlight(true)
          menuItem?.menu?.update()
      }
      
      override func mouseExited(with event: NSEvent) {
          super.mouseExited(with: event)
          menuItem?.highlight(false)
          menuItem?.menu?.update()
      }
      
      override func mouseUp(with event: NSEvent) {
          super.mouseUp(with: event)
          guard let item = menuItem, let menu = item.menu else { return }
          // 模拟原生点击逻辑：触发选中、关闭菜单
          menu.performActionForItem(at: menu.index(of: item))
          menu.cancelTracking()
      }
      
      // 确保视图能接收鼠标事件
      override var acceptsFirstMouse: Bool { true }
      override func acceptsFirstResponder() -> Bool { true }
  }
  

• 给菜单项绑定视图时，必须关联menuItem属性：

  // 在CustomMenu的willOpenMenu中
  for item in items {
      let customView = CustomMenuItemView(frame: NSRect(x: 0, y: 0, width: 200, height: 22))
      customView.menuItem = item
      item.view = customView
      // 你的自定义绘制配置
  }
  

2. 首个菜单项无法选中 #

• 在willOpenMenu末尾主动初始化首个菜单项的高亮状态：

  override func willOpenMenu() {
      super.willOpenMenu()
      // ... 其他设置代码 ...
      if let firstItem = items.first {
          firstItem.highlight(true)
          update()
      }
  }
  

• 自定义绘制时依赖NSMenuItem的isHighlighted状态，不要自行维护：

  override func draw(_ dirtyRect: NSRect) {
      super.draw(dirtyRect)
      // 根据菜单项状态绘制高亮
      if menuItem?.isHighlighted == true {
          NSColor.selectedMenuItemColor.setFill()
          dirtyRect.fill()
      }
      // 绘制菜单项文本
      menuItem?.title.draw(at: NSPoint(x: 8, y: 4), withAttributes: [NSAttributedString.Key.font: NSFont.systemFont(ofSize: 13)])
  }
  

关键注意事项 #

• 重写NSMenu生命周期方法时，绝不能省略父类调用，原生方法包含事件注册、状态初始化等核心逻辑。
• 自定义菜单项视图必须与NSMenuItem的状态绑定，不能完全脱离原生highlight、performActionForItem机制，否则会打破菜单的事件闭环。

内容的提问来源于stack exchange，提问作者MassMover