Contents

fileExporter(isPresented:document:contentTypes:defaultFilename:onCompletion:onCancellation:)

Presents a system interface for allowing the user to export a FileDocument to a file on disk.

Declaration

nonisolated func fileExporter<D>(isPresented: Binding<Bool>, document: D?, contentTypes: [UTType] = [], defaultFilename: String? = nil, onCompletion: @escaping (Result<URL, any Error>) -> Void, onCancellation: @escaping () -> Void = {}) -> some View where D : FileDocument

Parameters

  • isPresented:

    A binding to whether the interface should be shown.

  • document:

    The in-memory document to export.

  • contentTypes:

    The list of supported content types which can be exported. If not provided, FileDocument.writableContentTypes are used.

  • defaultFilename:

    If provided, the default name to use for the exported file, which will the user will have an opportunity to edit prior to the export.

  • onCompletion:

    A callback that will be invoked when the operation has succeeded or failed. The result indicates whether the operation succeeded or failed.

  • onCancellation:

    A callback that will be invoked if the user cancels the operation.

Discussion

In order for the interface to appear, isPresented must be true. When the operation is finished, isPresented will be set to false before onCompletion is called. If the user cancels the operation, isPresented will be set to false and onCancellation will be called.

See Also

Exporting to file