filipriec/komp_ac
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme updated

Browse Source
This commit is contained in:
Priec
2025-08-19 01:12:59 +02:00
parent 8ed2fbbe34
commit 49b31c6e92
2 changed files with 30 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
canvas/Cargo.toml
View File

@@ -2,9 +2,9 @@
name = "canvas" name = "canvas"
version.workspace = true version.workspace = true
edition.workspace = true edition.workspace = true
license.workspace = true license = "MIT OR Apache-2.0"
authors.workspace = true authors.workspace = true
description.workspace = true description = "Form/textarea for TUI"
readme.workspace = true readme.workspace = true
repository.workspace = true repository.workspace = true
categories.workspace = true categories.workspace = true

8
canvas/README.md
View File

@@ -20,6 +20,7 @@ It provides:
- Suggestions (asynchronous dropdowns) - Suggestions (asynchronous dropdowns)
- Computed fields (derived values) - Computed fields (derived values)
- Textarea widget with cursor management - Textarea widget with cursor management
- Syntax highlighting (via syntect)
- Extensible architecture for custom behaviors - Extensible architecture for custom behaviors
--- ---
@@ -29,7 +30,7 @@ It provides:
Add the dependency to your `Cargo.toml`: Add the dependency to your `Cargo.toml`:
```toml ```toml
[dependedsncies] [dependencies]
canvas = { version = "0.x", features = ["gui", "cursor-style", "textarea", "validation"] } canvas = { version = "0.x", features = ["gui", "cursor-style", "textarea", "validation"] }
``` ```
@@ -45,6 +46,7 @@ The library is feature‑gated. Enable only what you need:
- `suggestions` – asynchronous suggestions dropdowns - `suggestions` – asynchronous suggestions dropdowns
- `computed` – derived fields - `computed` – derived fields
- `textarea` – textarea widget - `textarea` – textarea widget
- `syntect` – syntax highlighting support
- `textmode-vim` – Vim‑like editing (default) - `textmode-vim` – Vim‑like editing (default)
- `textmode-normal` – normal editing mode - `textmode-normal` – normal editing mode
@@ -66,6 +68,9 @@ cargo run --example textarea_vim --features "gui cursor-style textarea textmode-
# Textarea with Normal mode # Textarea with Normal mode
cargo run --example textarea_normal --features "gui cursor-style textarea textmode-normal" cargo run --example textarea_normal --features "gui cursor-style textarea textmode-normal"
# Textarea with syntax highlighting
cargo run --example textarea_syntax --features "gui cursor-style textarea syntect textmode-normal"
# Validation examples # Validation examples
cargo run --example validation_1 --features "gui validation cursor-style" cargo run --example validation_1 --features "gui validation cursor-style"
cargo run --example validation_2 --features "gui validation cursor-style" cargo run --example validation_2 --features "gui validation cursor-style"
@@ -106,4 +111,3 @@ at your option.
## Contributing ## Contributing
Contributions are welcome. Please follow the existing code structure and feature‑gating conventions. Contributions are welcome. Please follow the existing code structure and feature‑gating conventions.