diff options
| author | Polesznyák Márk <contact@pml68.dev> | 2025-10-21 10:23:54 +0200 |
|---|---|---|
| committer | Polesznyák Márk <contact@pml68.dev> | 2025-10-21 10:26:37 +0200 |
| commit | 2c90f9e4fd48b9bd8a6fe428ac9e97114e235efe (patch) | |
| tree | acbfdc4781eb0044fc807233fcf01d7ee0b072b3 /README.md | |
| parent | docs: fix broken links pointing to iced stuff (diff) | |
| download | iced_selection-2c90f9e4fd48b9bd8a6fe428ac9e97114e235efe.tar.gz | |
docs(README): add some new sections, extend existing ones
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 17 insertions, 1 deletions
@@ -3,9 +3,10 @@ [](https://builds.sr.ht/~pml68/iced_selection) [](https://iced-selection.pml68.dev) - ## Text selection API for [`iced`](https://iced.rs), with reference widget implementations. +Text in iced currently isn't selectable except for `TextEditor` and `TextInput`. This is my solution, but others exist as well (see [Special thanks](#special-thanks)). + Check out the examples, or read the [documentation](https://iced-selection.pml68.dev) to get an idea about the crate. Roughly: @@ -15,7 +16,22 @@ 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. +## Installation +Simply add it to under your `Cargo.toml`'s `dependencies` section. +```toml +# ... + +[dependencies] +iced = { git = "https://github.com/iced-rs/iced", branch = "master" } +iced_selection = { git = "https://git.sr.ht/~pml68/iced_selection" } +``` + ## Features - `default`: - `markdown`: Provides support for rendering markdown through a custom viewer. + +## 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)). +- [`Halloy`](https://halloy.chat), for its amazing selectable text implementation (check it out, but mind the GPLv3!). |
