Skip to content

Commit adfddbc

Browse files
authored
chore: Add README for examples folder (#301)
1 parent 5dc0d50 commit adfddbc

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

examples/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Examples
2+
3+
This directory contains examples of how to use `egui_dock`.
4+
5+
To run an example, use the following command from the project root:
6+
7+
```bash
8+
cargo run --example <example_name>
9+
```
10+
11+
Replace `<example_name>` with the name of the example file without the `.rs` extension.
12+
13+
## List of Examples
14+
15+
- [`hello`](hello.rs): A comprehensive demo of `egui_dock` features, including a style editor and various dock configurations.
16+
- [`simple`](simple.rs): A minimal example showing how to set up a basic dock with a few tabs.
17+
- [`tab_add`](tab_add.rs): Shows how to implement a custom "add tab" button and handle it in the `update` loop.
18+
- [`tab_add_popup`](tab_add_popup.rs): Demonstrates how to use a popup menu for adding different types of tabs.
19+
- [`save_load_dock_state`](save_load_dock_state.rs): Shows how to persist the dock layout to a JSON file and load it back.
20+
- [`text_editor`](text_editor.rs): A practical example of a text editor with multiple open buffers as tabs.
21+
- [`reject_windows`](reject_windows.rs): Demonstrates the ability of tabs to either allow or reject being moved into separate windows.

0 commit comments

Comments
 (0)