一个用 Swift 编写的可扩展文本编辑器/渲染器,构建于 TextKit 之上,并与 Lexical JavaScript 共享理念和 API。
Lexical iOS 已在 Meta 的多个应用中使用,包括在 Workplace iOS 中渲染包含内联图片的 Feed 帖子。
Lexical iOS 处于预发布阶段,不保证提供支持。
有关版本之间的更改,请参阅 Lexical iOS 更新日志。
我们有一个示例 Playground 应用程序,演示了 Lexical 的一些功能。
Playground 应用程序包含一个富文本工具栏的代码。虽然这并非一个可以直接放入您项目中的可重用工具栏,但其代码应该为您自定义工具栏提供一个良好的起点。
这个 Playground 应用程序非常新,随着时间的推移,将会添加更多功能!
Lexical iOS 使用 Swift 编写,目标平台为 iOS 13 及以上版本。(请注意,由于使用了 UIKit 的功能,例如 UIMenu,Playground 应用程序至少需要 iOS 14。)
我们提供了一个 Swift 包文件,足以构建 Lexical 核心。将其作为您应用程序的依赖项添加,即可使用 Lexical。
此存储库中包含的一些插件尚未提供包文件。(这是因为我们在 Meta 内部使用不同的构建系统。如果您想开始为 Lexical 做出贡献,添加这些文件将是一个简单的 PR!)
对于使用 Lexical 的可编辑文本,请实例化一个 LexicalView
。要使用插件和主题对其进行配置,您可以创建一个 EditorConfig
,并将其传递给 LexicalView
的初始化器。
要以编程方式处理 LexicalView
中的数据,您需要访问 Editor
。然后您可以调用 editor.update {}
,并在该闭包中使用 Lexical API。
有关更多信息,请参阅文档。
阅读 Lexical iOS 文档。
加入我们的 Discord 服务器,您可以在那里与 Lexical 团队和其他用户交流。
请参阅 CONTRIBUTING 文件,了解如何提供帮助。
Lexical 拥有一套 XCTest 格式的单元测试,可以在 Xcode 中运行。我们目前没有任何端到端测试。
Lexical 使用 MIT 许可证。