Dialog settings

Customize the dialogs with platform-specific settings

FileKit allows you to customize dialog behavior with platform-specific settings. Each platform has its own settings class that can be configured according to your needs.

Platform-Specific Settings

JVM Settings

On JVM platforms (Windows, macOS, Linux), you can customize:

• title: Set a custom title for the dialog
• parentWindow: Set the parent window for the dialog (useful for modal behavior)
• macOS: Configure macOS-specific settings

// Basic settings with title and parent window
val settings = FileKitDialogSettings(
    title = "Select a file",
    parentWindow = window
)

// With macOS-specific settings
val settings = FileKitDialogSettings(
    title = "Select a file",
    parentWindow = window,
    macOS = FileKitMacOSSettings(
        resolvesAliases = false,
        canCreateDirectories = true
    )
)

For desktop applications, it’s recommended to pass the window reference:

Window(onCloseRequest = ::exitApplication) {
    val dialogSettings = FileKitDialogSettings(this.window)
    App(dialogSettings)
}

iOS and macOS Settings

On iOS and macOS, you can configure:

• title: Set a custom title for the dialog
• canCreateDirectories: Allow or prevent directory creation in dialogs (default: true)

On iOS, you can also configure:

• assetRepresentationMode: Choose the Photos picker asset representation mode (default: Automatic)
• presenter: Set the UIViewController used to present native dialogs. If null, FileKit uses the current top-most controller.

val settings = FileKitDialogSettings(
    title = "Save document",
    canCreateDirectories = true,
    assetRepresentationMode = FileKitAssetRepresentationMode.Automatic
)

The iOS Photos picker supports these asset representation modes:

• Automatic: Let the system choose the best representation
• Current: Prefer the original/current representation and avoid transcoding when possible
• Compatible: Prefer a broadly compatible representation, even if transcoding is required

Use Compatible when picked image bytes need to be decoded by libraries that may not support every Apple-native image format, such as HEIF/HEIC.

Android, Web, and WASM

These platforms currently don’t have any specific settings to configure. Use the default settings:

val settings = FileKitDialogSettings.createDefault()

Using DialogSettings in KMP

When working with Kotlin Multiplatform projects, you might need to handle platform-specific settings differently. Here’s how to use expect/actual to manage dialog settings:

For platforms that need specific configuration, use expect/actual:

// commonMain
expect fun createDialogSettings(): FileKitDialogSettings

// desktopMain
actual fun createDialogSettings(): FileKitDialogSettings {
    return FileKitDialogSettings(
        title = "Select a file",
        parentWindow = window,
        macOS = FileKitMacOSSettings(
            canCreateDirectories = true
        )
    )
}

// iosMain
actual fun createDialogSettings(): FileKitDialogSettings {
    return FileKitDialogSettings(
        assetRepresentationMode = FileKitAssetRepresentationMode.Automatic
    )
}

// androidMain, jsMain
actual fun createDialogSettings(): FileKitDialogSettings {
    return FileKitDialogSettings.createDefault()
}

You can then use the platform-specific settings in your shared code:

class SharedViewModel {
    private val dialogSettings = createDialogSettings()
    
    suspend fun pickFile() {
        FileKit.openFilePicker(
            dialogSettings = dialogSettings
        )
    }
}

This approach allows you to:

• Keep your common code platform-agnostic
• Provide platform-specific configurations where needed
• Maintain type safety across platforms

Platform-specific settings are continuously evolving. You can ask for a feature or report a bug on the GitHub repository.