Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ctreffs/SwiftNFD
Swift wrapper for Native File Dialog, a tiny, neat C library that portably invokes native file open and save dialogs.
https://github.com/ctreffs/SwiftNFD
dialog linux macos spm swift swift-package-manager windows
Last synced: about 2 months ago
JSON representation
Swift wrapper for Native File Dialog, a tiny, neat C library that portably invokes native file open and save dialogs.
- Host: GitHub
- URL: https://github.com/ctreffs/SwiftNFD
- Owner: ctreffs
- License: zlib
- Created: 2021-11-05T09:56:58.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-28T17:50:12.000Z (about 2 months ago)
- Last Synced: 2024-07-28T19:12:03.889Z (about 2 months ago)
- Topics: dialog, linux, macos, spm, swift, swift-package-manager, windows
- Language: C
- Homepage:
- Size: 129 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Swift Native File Dialog
[](LICENSE)
[](https://github.com/ctreffs/SwiftNFD/actions/workflows/ci-macos.yml)
[](https://github.com/ctreffs/SwiftNFD/actions/workflows/ci-linux.yml)
[](https://github.com/ctreffs/SwiftNFD/actions/workflows/ci-windows.yml)
A thin Swift wrapper around the popular [mlabbe/nativefiledialog](https://github.com/mlabbe/nativefiledialog) library by Michael Labbe.
Native File Dialog is a tiny, neat C library that portably invokes native file open, folder select and save dialogs. Write dialog code once and have it pop up native dialogs on all supported platforms. Avoid linking large dependencies like wxWidgets and qt.
### Features:
- Zlib licensed.
- Consistent UTF-8 support on all platforms.
- Simple universal file filter syntax.
- Multiple file selection support.
- No third party dependencies for building or linking.
- Support for Vista's modern `IFileDialog` on Windows.
- Support for non-deprecated Cocoa APIs on OS X.
- GTK3 dialog on Linux.
- Tested, works alongside [SDL2](https://www.libsdl.org) on all platforms, for the game developers out there.
## Usage ##
### Single file dialog
```swift
// open single file dialog without filters
let result = NFD.OpenDialog()
switch result {
case let .success(path):
if let path = path {
// use path
} else {
// user canceled
}
case let .failure(error):
// an error has occured
}
```
### macOS Demo
You can find a macOS demo application in `/Apps/NFD-Demo/NFD-Demo.xcodeproj`
## File Filter Syntax
There is a form of file filtering in every file dialog API, but no consistent means of supporting it. NFD provides support for filtering files by groups of extensions, providing its own descriptions (where applicable) for the extensions.
A wildcard filter is always added to every dialog.
#### Examples ####
`txt` The default filter is for text files. There is a wildcard option in a dropdown.
`png,jpg;psd` The default filter is for png and jpg files. A second filter is available for psd files. There is a wildcard option in a dropdown.
`nil` Wildcard only.
# Copyright and Credit
Copyright © 2014-2019 [Frogtoss Games](https://www.frogtoss.com), Inc.
File [LICENSE](LICENSE) covers all files in this repo.
Native File Dialog by Michael Labbe
Tomasz Konojacki for [microutf8](https://puszcza.gnu.org.ua/software/microutf8/)
[Denis Kolodin](https://github.com/DenisKolodin) for mingw support.
[Tom Mason](https://github.com/wheybags) for Zenity support.
## Support ##
Directed support for this work is available from the original author under a paid agreement.
[Contact Frogtoss Games](https://www.frogtoss.com/pages/contact.html).