Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mythitorium/egui-grid
Create dynamic grid-based layouts for egui
https://github.com/mythitorium/egui-grid
egui gui rust ui
Last synced: 3 months ago
JSON representation
Create dynamic grid-based layouts for egui
- Host: GitHub
- URL: https://github.com/mythitorium/egui-grid
- Owner: mythitorium
- License: mit
- Created: 2023-04-11T08:40:38.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-25T20:27:41.000Z (about 1 year ago)
- Last Synced: 2024-03-14T16:23:44.668Z (11 months ago)
- Topics: egui, gui, rust, ui
- Language: Rust
- Homepage:
- Size: 39.1 KB
- Stars: 23
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-egui - egui-grid
README
# egui_grid
[](https://crates.io/crates/egui_grid)
[](https://docs.rs/egui_grid)
Create dynamic grid layouts for [`egui`](https://github.com/emilk/egui).
Grids are flexible, easy to create, with behavior similar to egui_extra's strip creation. They're compact and allow for more complex layouts using less indentation,
with functionalities like nesting grids and aligning cells within a row.
## Installing
Add this to your `Cargo.toml`:
```toml
[dependencies]
egui_grid = "0.5.2"
```
## Example
``` rust
// Quick example, by no means does it fully demo
// how flexible building grids can be.
use egui_grid::GridBuilder;
use egui_extras::Size;
GridBuilder::new()
// Allocate a new row
.new_row(Size::exact(200.0))
// Give this row a couple cells
.cell(Size::exact(85.0))
.cell(Size::remainder())
// Allocate another row
.new_row(Size::remainder())
// Batch method, allocate multiple cells at once
.cells(Size::remainder(), 3)
.show(ui, |mut grid| {
// Cells are represented as they were allocated
grid.cell(|ui| {
ui.label("Top row, left cell");
});
grid.cell(|ui| {
ui.label("Top row, right cell");
});
grid.cell(|ui| {
ui.label("Bottom row, left cell");
});
grid.empty();
grid.cell(|ui| {
ui.label("Bottom row, right cell");
});
});
```
### Grid Nesting Example
```rust
// You can nest grids, allowing for complex layouts without much indentation
use egui_grid::GridBuilder;
use egui_extras::Size;
// The grid which will be nested
let nested_grid = GridBuilder::new()
// 2 rows, with 1 cell each
.new_row(Size::remainder()).cell(Size::remainder())
.new_row(Size::remainder()).cell(Size::remainder());
// The main grid, of which one cell will receive the nested grid
GridBuilder::new()
// One row with 3 cells
.new_row(Size::remainder())
.cell(Size::remainder())
.cell(Size::remainder()) .nest(nested_grid) // Nesting the grid in the middle cell
.cell(Size::remainder())
.show(ui, |mut grid| {
// The nested grid replaces the cell it was nested in;
// And the cells within that nested grid replace it in the order, too.
//
// So despite there being 5 cells allocated total
// (2 from the nested grid and 3 from the main), only 4 exist.
grid.cell(|ui| {
ui.label("Left cell");
});
grid.cell(|ui| {
ui.label("Nested grid, top cell");
});
grid.cell(|ui| {
ui.label("Nested grid, bottom cell");
});
grid.cell(|ui| {
ui.label("Right cell");
});
});
```
## Usage
Check the [docs](https://docs.rs/egui_grid/latest/egui_grid/) for details and more info on usage.
## Issues
Currently this is feature complete. Bug fixes, optimizations, and staying up to date with [egui](https://github.com/emilk/egui) releases are the only ways this crate will be expanding for the foreseeable future.
While you are free to open an issue, contacting me (@mythit) on the [egui discord server](https://discord.gg/wdkZkEdXks) might be more worth your time.