aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPolesznyák Márk <contact@pml68.dev>2025-10-26 20:22:20 +0100
committerPolesznyák Márk <contact@pml68.dev>2025-10-26 20:22:20 +0100
commit0dcf63d06e17aa64caa64d26392d3187f9b730ea (patch)
tree1800e235cb33167fedc270742c16eef2ffb0c926 /README.md
parentfix(wip): multi line text selection box drawing (works for non-wrapped) (diff)
downloadiced_selection-0dcf63d06e17aa64caa64d26392d3187f9b730ea.tar.gz
feat: clean up debugging code, add multi-line fix to `Rich`
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index a828598..0321630 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,9 @@ Roughly:
- `markdown.rs`: A custom [`Viewer`](https://docs.iced.rs/iced/widget/markdown/trait.Viewer.html) and its corresponding custom methods.
- `lib.rs`: Helper methods, macros and re-exports.
+## Wrapped text support
+Wrapped text currently isn't supported. Although single-click mouse selection and most keyboard shortcuts will select text correctly, the selection box(es) drawn will be incorrect for wrapped segments and by-line selection (`Shift + Up Arrow` / `Shift + Down Arrow` & triple-click mouse selection) will treat all wrapped segments as part of the same line.
+
## Installation
Simply add it to under your `Cargo.toml`'s `dependencies` section.
```toml
@@ -31,6 +34,14 @@ iced_selection = { git = "https://git.sr.ht/~pml68/iced_selection" }
- `default`:
- `markdown`: Provides support for rendering markdown through a custom viewer.
+## TODO
+
+- [ ] allow out-of-bounds selection dragging
+- [X] custom markdown `Viewer`
+- [ ] double-click + drag for by-word selection
+- [X] triple-click + drag for by-line selection
+- [ ] support wrapped lines
+
## Special thanks
- [`iced`](https://iced.rs), for making this possible in the first place, and for the modified source code of `Text`, `Rich` and `Selection` (based on [`text_input/cursor.rs`](https://github.com/iced-rs/iced/blob/master/widget/src/text_input/cursor.rs)).