bevy_simple_text_input 0.13.0

Bevy plugin for a simple single-line text input widget.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

# bevy_simple_text_input

[![crates.io](https://img.shields.io/crates/v/bevy_simple_text_input.svg)](https://crates.io/crates/bevy_simple_text_input)
[![docs](https://docs.rs/bevy_simple_text_input/badge.svg)](https://docs.rs/bevy_simple_text_input)
[![Following released Bevy versions](https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue)](https://bevyengine.org/learn/book/plugin-development/#main-branch-tracking)

An unambitious single-line text input widget for `bevy_ui`.

![animated screenshot of text input widget gaining focus and text typed and submitted](assets/screenshot.gif)

## Usage

> [!IMPORTANT]
> Code and examples in the main branch are under development and may not be compatible with the released version on crates.io. The [`latest`](https://github.com/rparrett/bevy_simple_text_input/tree/latest) branch will contain the code from the most recent release.

See [`examples/basic.rs`](https://github.com/rparrett/bevy_simple_text_input/blob/latest/examples/basic.rs).

## Features

I am not trying to build and maintain an enterprise-grade text input, just something that is good enough to be useful in small projects.

- [X] Scrolling
- [X] Keyboard cursor movement (char, word, start/end)
- [X] Disable / focus
- [X] Placeholders
- [X] Doesn't *completely* choke on unicode
- [X] Password masking
- [X] "Submit" events

### Maybe

- [ ] Input filtering
- [ ] Length limit
- [ ] Mouse cursor movement
- [ ] Proper unicode grapheme support
- [ ] IME support

### Probably not

I *might* consider very high quality contributions in these areas, but probably won't be working on them myself. These would likely involve adding dependencies or adding lots of code that I don't want to commit to maintaining.

- [ ] Multi-line
- [ ] Copy / paste
- [ ] Selection
- [ ] Mobile

### Definitely not

- [ ] Rich text

## Compatibility

| `bevy_simple_text_input` | `bevy` |
| :--                      | :--    |
| `0.13`                   | `0.18` |
| `0.12`                   | `0.17` |
| `0.11`                   | `0.16` |
| `0.10`                   | `0.15` |
| `0.8`-`0.9`              | `0.14` |
| `0.4`-`0.7`              | `0.13` |
| `0.3`                    | `0.12` |
| `0.1`-`0.2`              | `0.11` |

## Contributing

Please feel free to open a PR!

The code should be simple enough for users to quickly understand and modify for their own purposes. Any new dependencies must not also depend on Bevy. Ideally, we should not add *any* new dependencies.

Please keep PRs small and scoped to a single feature or fix.

## Alternatives

If you need more features, check out [`bevy_ui_text_input`](https://github.com/ickshonpe/bevy_ui_text_input) or [`bevy_egui`](https://github.com/mvlabat/bevy_egui).