tui-realm-textarea

~ tui-realm 的 textarea 组件 ~

tui-textarea · tui-realm · 文档

由 @veeso 开发

当前版本：1.1.2 (29/08/2023)

• tui-realm-textarea
  • 关于 tui-realm-textarea ✏️
  • 入门 🏁
    • 将 tui-realm-textarea 添加到您的 Cargo.toml 🦀
      • 功能 ⚙️
    • 示例 📋
  • 组件 API
    • 页脚和状态格式
  • 文档 📚
  • 贡献和问题 🤝🏻
  • 变更日志 ⏳
  • 支持开发者 ☕
  • 许可证 📃

关于 tui-realm-textarea ✏️

tui-realm-textarea 是 tui-realm 的 textarea 组件实现。它基于 tui-textarea 组件，由 rhysd 开发。

入门 🏁

将 tui-realm-textarea 添加到您的 Cargo.toml 🦀

tui-realm-textarea = "^1.1.0"

如果不使用 Crossterm，则按 tui-realm 的方式定义后端

tui-realm-textarea = { version = "^1.1.0", default-features = false, features = [ "with-termion" ] }

功能 ⚙️

这些功能可以在 tui-realm-textarea 中启用

• clipboard 启用系统剪贴板支持
• search 启用 textarea 中的字符串搜索

示例 📋

在 示例 中查看如何使用 textarea 组件。示例包含一个简单的文本编辑器。

cargo run --example demo --features clipboard,search

按 ESC 退出

组件 API

命令:

❗ 仅当启用 clipboard 功能时才支持粘贴命令

状态：返回的状态是一个包含文本区域中行数的 Vec(String)。

属性:

• Borders(Borders)：设置组件的边框属性
• Custom($TREE_IDENT_SIZE, Size)：设置渲染每个深度级别的空间
• Custom($TEXTAREA_MAX_HISTORY, Payload(One(Usize)))：设置要记录的历史步骤
• Custom($TEXTAREA_CURSOR_STYLE, Style)：设置光标样式
• Custom($TEXTAREA_CURSOR_LINE_STYLE, Style)：设置当前行样式
• Custom($TEXTAREA_FOOTER_FMT, Payload(Tup2(Str, Style)))：设置底部栏的格式和样式
• Custom($TEXTAREA_LINE_NUMBER_STYLE, Style)：设置行号的样式
• Custom($TEXTAREA_STATUS_FMT, Payload(Tup2(Str, Style)))：设置状态栏的格式和样式
• Custom($TEXTAREA_SEARCH_PATTERN, String：设置搜索模式
• Custom($TEXTAREA_SEARCH_STYLE, Style：设置搜索样式
• Style(Style)：设置 textarea 的一般样式
• Custom($TEXTAREA_TAB_SIZE, Size)：设置要显示的制表符大小
• FocusStyle(Style)：非活动样式
• ScrollStep(Length)：定义可滚动的最大行数
• 标题(标题)：设置框标题

页脚和状态格式

状态栏和页脚栏支持特殊语法。以下键可以插入到字符串中

• {ROW}：当前行
• {COL}：当前列

文档 📚

开发者文档可在Rust Docs上找到：https://docs.rs/tui-realm-textarea

贡献和问题 🤝🏻

欢迎贡献、错误报告、新功能和提问！😉 如果您有任何问题或疑虑，或者想建议一个新功能，或者只是想改进 tui-realm，请随意打开一个 issue 或 PR。

请遵循我们的贡献指南

变更日志 ⏳

查看 tui-realm-textarea 的变更日志这里

支持开发者 ☕

如果您喜欢 tui-realm 并对我的工作表示感激，请考虑进行一小笔捐赠 🥳

您可以使用以下平台之一进行捐赠

许可证 📃

tui-realm-textarea 采用 MIT 许可证。

您可以在这里阅读整个许可证