aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: f5b6ff620326ff668af70bd1c3a6ff33bb852ae4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# iced_selection

[![builds.sr.ht status](https://builds.sr.ht/~pml68/iced_selection.svg)](https://builds.sr.ht/~pml68/iced_selection)  
[![docs](https://img.shields.io/website?url=https%3A%2F%2Ficed-selection.pml68.dev&label=docs)](https://iced-selection.pml68.dev)


## Text selection API for [`iced`](https://iced.rs), with reference widget implementations.

Check out the examples, or read the [documentation](https://iced-selection.pml68.dev) to get an idea about the crate.

Roughly:
- `selection.rs`: The main selection API, built around iced's [`Paragraph`](https://docs.iced.rs/iced_graphics/text/paragraph/struct.Paragraph.html).
- `text.rs`: Reference implementation for a selectable text widget.
    - `text/rich.rs`: Reference implementation for a selectable rich text widget.
- `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.

## Features

- `default`:
- `markdown`: Provides support for rendering markdown through a custom viewer.