Declaration
Initializers
8 SwiftUI initializers back <NewDocumentButton>. The props you pass pick one.
<NewDocumentButton
contentType?: string | null
>
children: string | number | ReadonlyArray<string | number>
</NewDocumentButton>nonisolated init(
_ title: some StringProtocol,
contentType: UTType? = nil
)children*string | number | ReadonlyArray<string | number>The text to display.
Swift
title: some StringProtocolcontentTypestring | nullAn optional content type of the document to create.
Default
`nil`
Also takes the common view props: modifiers, style and testID.
Overview
Use a new document button to give people the option to create documents in your app.
In the following example, there are two new document buttons, both support Text labels.
When the user taps or clicks the first button, the system creates a new document in the directory
currently open in the document browser. The second button presents a template picker,
where a document can be prepopulated or preconfigured using a template.
@State private var isTemplatePickerPresented = false
@State private var documentCreationContinuation:
CheckedContinuation<TextDocument?, any Error>?
var body: some Scene {
DocumentGroupLaunchScene("My Documents") {
NewDocumentButton(Text("Start Writing…"))
NewDocumentButton(Text("Choose a Template"), for: TextDocument.self) {
try await withCheckedThrowingContinuation { continuation in
documentCreationContinuation = continuation
isTemplatePickerPresented = true
}
}
.fullScreenCover(isPresented: $isTemplatePickerPresented) {
TemplatePicker(
continuation: $documentCreationContinuation
)
}
}
DocumentGroup(newDocument: TextDocument()) { configuration in
MyDocumentView(document: configuration.$document))
}
}
struct TemplatePicker: View {
@Binding var continuation:
CheckedContinuation<TextDocument?, any Error>?
@Environment(\.dismiss) var dismiss
var body: some View {
VStack {
Text("Choose a template")
.font(.title)
Button("Meeting minutes") {
let document = makeMeetingMinutes()
documentCreationContinuation?.resume(returning: document)
dismiss()
}
Button("Letter") {
let document = makeLetter()
documentCreationContinuation?.resume(returning: document)
dismiss()
}
Button("Cancel") {
documentCreationContinuation?.resume(throwing: CancellationError())
dismiss()
}
}
}
private func makeMeetingMinutes() -> TextDocument { ... }
private func makeLetter() -> TextDocument { ... }
}
struct TextDocument: FileDocument { ... }If you don't provide a custom label, the system provides a button with the default "Create Document" label.
From Apple’s SwiftUI documentation. Code samples there are Swift.
Relationships
Conforms to
- View
See also
More in Documents.