Directory picker dialog

Open a folder picker dialog in a Kotlin Multiplatform project

Supported on Android, iOS, macOS, JVM, JS and WASM targets

Quick start

Easily open a folder picker dialog to let users select a directory.

filekit-dialogs

val directory = FileKit.openDirectoryPicker()

onError receives a FileKitDialogException only when FileKit cannot complete a valid directory operation. User cancellation is not a failure: it invokes onResult(null). Coroutine cancellation, invalid invocation, and unexpected defects continue to propagate normally.

The compatibility overload without onError remains available and ignores normalized operational failures without logging. New integrations should use explicit error handling.

See dialog error handling for the complete callback and propagation matrix.

Customizing the dialog

You can customize the dialog by setting the initial directory and platform-specific dialogSettings, such as a title on supported platforms.

filekit-dialogs

val directory = FileKit.openDirectoryPicker(
    directory = PlatformFile("/custom/initial/path"),
    dialogSettings = FileKitDialogSettings.createDefault(),
)

Read more about dialog settings to customize the dialog for each platform.

On JS and WASM, directory picking uses the browser webkitdirectory input behavior. Browsers expose the selected directory as a flat list of files, so FileKit rebuilds a virtual directory tree from their relative paths. Empty directories are not available, and directory lastModified() values are synthetic.

macOS System Appearance

On macOS, to ensure the directory picker dialog uses the system’s theme (light or dark), you may need to set a system property at the start of your application:

System.setProperty("apple.awt.application.appearance", "system")

This is typically done in your main function, before the application window is created.