KeyboardKit 中自定义 Emoji 键盘按钮的实现解析

背景介绍

KeyboardKit 是一个强大的 iOS 键盘开发框架，它提供了丰富的键盘功能定制能力。在实际开发中，很多开发者会遇到需要自定义 Emoji 键盘按钮的需求。本文将深入探讨如何在 KeyboardKit 中实现这一功能。

核心问题分析

在 KeyboardKit 中，默认情况下 Emoji 键盘按钮可能不会自动显示，这主要是因为框架内部做了以下判断：

1. 框架会检查标准 Emoji 键盘是否可用
2. 如果是开源版本，Emoji 键盘视图可能是一个空占位符
3. 开发者需要明确指定是否要显示 Emoji 按钮

解决方案演进

初始实现方式

开发者最初尝试通过扩展 KeyboardLayout 来插入 Emoji 按钮：

mutating func tryInsertEmojiButton() {
    let emojiButton = KeyboardLayout.Item(
        action: .keyboardType(.emojis),
        size: .init(width: KeyboardLayout.ItemWidth.input, height: 40)
    )
    itemRows.insert(emojiButton, before: .space, inRow: 3)
}

这种方式理论上可行，但实际会遇到 isEmojiKeyboardAvailable 属性不可访问的问题，因为该属性被标记为 internal 保护级别。

框架改进方案

KeyboardKit 团队在 9.1 版本中对此进行了优化：

1. KeyboardView 现在会自动检查标准 Emoji 键盘是否被使用
2. 如果检测到是空占位符或使用了自定义 Emoji 视图，默认会显示 Emoji 键
3. 增加了显式设置选项，方便开发者控制 Emoji 键的显示/隐藏

最佳实践建议

自定义 Emoji 键盘实现

开发者可以按照以下方式实现自定义 Emoji 键盘：

KeyboardView(
    state: keyboardController.state,
    services: keyboardController.services,
    emojiKeyboard: { params in
        AIEmojiCategoryKeyboard(
            selection: .smileysAndPeople,
            actionHandler: keyboardController.services.actionHandler,
            keyboardContext: keyboardController.state.keyboardContext,
            calloutContext: nil,
            style: params.style,
            styleProvider: keyboardController.services.styleService
        )
    }
)

布局服务定制

通过自定义 KeyboardLayoutService 可以更灵活地控制键盘布局：

class AIKeyboardLayoutService: KeyboardLayout.StandardLayoutService {
    
    override func keyboardLayout(for context: KeyboardContext) -> KeyboardLayout {
        var layout = super.keyboardLayout(for: context)
        guard !context.isKeyboardFloating else { return layout }
        
        if context.keyboardType != .emojis {
            layout.tryInsertEmojiButton()
        }
        return layout
    }
}

技术要点总结

1. 版本兼容性：此功能在 KeyboardKit 9.1 及更高版本中得到了优化
2. 显示控制：框架现在提供了更直观的方式来控制 Emoji 按钮的显示
3. 自定义能力：开发者可以完全自定义 Emoji 键盘的外观和行为
4. 布局灵活性：通过自定义布局服务可以实现各种复杂的键盘布局需求

扩展思考

除了 Emoji 按钮外，KeyboardKit 还支持多种键盘类型的定制，包括单手键盘模式等。开发者可以基于类似的原理实现各种特殊键盘需求。

通过理解 KeyboardKit 的布局机制和自定义点，开发者可以构建出功能丰富、用户体验优秀的第三方键盘应用。