Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #31

Merged
merged 2 commits into from
Feb 11, 2024
Merged

Update README.md #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
35f07b0
Update README.md
fluxxcode Feb 11, 2024
4df0fe0
Update CHANGELOG.md
fluxxcode Feb 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
### 📚 Documentation
- Fix typos in the documentation [#29](https://github.com/fluxxcode/egui-file-dialog/pull/29)
- Fix eframe version in the example in README.md [#30](https://github.com/fluxxcode/egui-file-dialog/pull/30)
- Added “Currently missing features” section to README.md and minor improvements [#31](https://github.com/fluxxcode/egui-file-dialog/pull/31)

## 2024-02-07 - v0.2.0 - API improvements
### 🚨 Breaking Changes
Expand Down
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The goal for the future is that parts of the dialog can be dynamically adapted s

The project is currently in a very early version. Some planned features are still missing and some improvements still need to be made.

**NOTE**: As long as version 1.0.0 has not yet been reached, even minor version increases may contain breaking changes.
Check out [CHANGELOG.md](https://github.com/fluxxcode/egui-file-dialog/blob/develop/CHANGELOG.md) in the develop branch to find the latest features included in the next release.

**Currently only tested on Linux and Windows!**

Expand All @@ -25,7 +25,19 @@ The project is currently in a very early version. Some planned features are stil
- Shortcut for user directories (Home, Documents, ...) and system disks
- Resizable window

## Currently missing features
The following lists some of the features that are currently missing but are planned for the future!
- Customize labels and enabled features
- Selection of multiple directory items at once
- Customizable file icons
- Only show files with a specific file extension (The user can already filter files by file extension using the search, but there is currently no backend method for this or a dropdown to be able to select from predefined file extensions.)
- Keyboard input
- Context menus, for example for renaming, deleting or copying files or directories.
- Option to show or hide hidden files and folders

## Example
Detailed examples that can be run can be found in the [examples](https://github.com/fluxxcode/egui-file-dialog/tree/master/examples) folder.

The following example shows the basic use of the file dialog with [eframe](https://github.com/emilk/egui/tree/master/crates/eframe) to select a file.

Cargo.toml:
Expand Down
Loading