From 3da23c89ecd039de310e46b2367302ff1b007581 Mon Sep 17 00:00:00 2001 From: Lucas Meurer Date: Tue, 14 May 2024 18:41:10 +0200 Subject: [PATCH] Update crate list in readme --- README.md | 71 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 42 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index afe499d..b5c81f8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Hello Egui! + This project contains a collection of egui tools I've created during development of the native app for (still unreleased, stay tuned!). @@ -8,60 +9,72 @@ If you're interested in using one of the experimental crates, open an issue, and release it on crates.io. ## Example app + An example using most of the crates is available [here](https://lucasmerlin.github.io/hello_egui/). Source code in [fancy-example](fancy-example). ## [**hello_egui**](https://crates.io/crates/hello_egui), this crate + A collection of reexports for the other crates, if you want to use all or most of them. You can toggle individual features to only include the crates you need. By default, all crates are included. Only includes crates that have been released on [crates.io](https://crates.io/). ## **Mature** Crates + - [egui_dnd](crates/egui_dnd) - - Drag & drop sorting library for egui - - released on [crates.io](https://crates.io/crates/egui_dnd) + - Drag & drop sorting library for egui + - released on [crates.io](https://crates.io/crates/egui_dnd) - [egui_inbox](crates/egui_inbox) - - Simple utility for sending messages to egui uis from other threads / async functions - - released on [crates.io](https://crates.io/crates/egui_inbox) - -- [egui_pull_to_refresh](crates/egui_pull_to_refresh) - - Adds pull to refresh functionality to egui. - - released on [crates.io](https://crates.io/crates/egui_pull_to_refresh) - -- [egui_suspense](crates/egui_suspense) - - A helper to display loading, error and retry uis when waiting for asynchronous data. - - released on [crates.io](https://crates.io/crates/egui_suspense) + - Simple utility for sending messages to egui uis from other threads / async functions + - released on [crates.io](https://crates.io/crates/egui_inbox) - [egui_virtual_list](crates/egui_virtual_list) - - Flexible virtual scroll widget for egui with support for dynamic heights and complex layouts - - Compatible with [egui_dnd](crates/egui_dnd) (let me know if you need an example) - - released on [crates.io](https://crates.io/crates/egui_virtual_list) + - Flexible virtual scroll widget for egui with support for dynamic heights and complex layouts + - Compatible with [egui_dnd](crates/egui_dnd) (let me know if you need an example) + - released on [crates.io](https://crates.io/crates/egui_virtual_list) - [egui_infinite_scroll](crates/egui_infinite_scroll) - - Infinite scroll based on [egui_virtual_list](crates/egui_virtual_list) - - released on [crates.io](https://crates.io/crates/egui_infinite_scroll) + - Infinite scroll based on [egui_virtual_list](crates/egui_virtual_list) + - released on [crates.io](https://crates.io/crates/egui_infinite_scroll) + +- [egui_form](crates/egui_form) + - Form validation for egui + - released on [crates.io](https://crates.io/crates/egui_form) + +- [egui_pull_to_refresh](crates/egui_pull_to_refresh) + - Adds pull to refresh functionality to egui. + - released on [crates.io](https://crates.io/crates/egui_pull_to_refresh) + +- [egui_suspense](crates/egui_suspense) + - A helper to display loading, error and retry uis when waiting for asynchronous data. + - released on [crates.io](https://crates.io/crates/egui_suspense) - [egui_thumbhash](crates/egui_thumbhash) - - Easily use [thumbhashes](https://evanw.github.io/thumbhash/) in egui. - - For a showcase, check the [gallery example](https://lucasmerlin.github.io/hello_egui/). - - released on [crates.io](https://crates.io/crates/egui_thumbhash) + - Easily use [thumbhashes](https://evanw.github.io/thumbhash/) in egui. + - For a showcase, check the [gallery example](https://lucasmerlin.github.io/hello_egui/). + - released on [crates.io](https://crates.io/crates/egui_thumbhash) ## **Experimental** Crates - [egui_animation](crates/egui_animation) - - Animation utilities for egui - - Experimental, released on [crates.io](https://crates.io/crates/egui_animation), used internally by [egui_dnd](crates/egui_dnd) + - Animation utilities for egui + - Experimental, released on [crates.io](https://crates.io/crates/egui_animation), used internally + by [egui_dnd](crates/egui_dnd) - [egui_taffy](crates/egui_taffy) - - Adds flexbox layout to egui using [taffy](https://github.com/DioxusLabs/taffy) - - Highly experimental, unreleased + - Adds flexbox layout to egui using [taffy](https://github.com/DioxusLabs/taffy) + - Highly experimental, unreleased - [egui_webview](crates/egui_webview) - - WebView widget for egui, based on wry - - Experimental, unreleased - - Warning: Currently uses some unsafe to get around Send / Sync limitations, - so it probably has some safety issues. + - WebView widget for egui, based on wry + - Experimental, unreleased + - Warning: Currently uses some unsafe to get around Send / Sync limitations, + so it probably has some safety issues. + +- [perfect_cursors](crates/perfect_cursors) + - A port of steve ruiz's [perfect cursors](https://github.com/steveruizok/perfect-cursors) to rust + - independent of egui, but there is a egui example - [hello_egui_utils](crates/hello_egui_utils) - - Collection of utilities used by the other crates + - Collection of utilities used by the other crates