+{"variants":[{"paths":["\/documentation\/welcomewindow"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[[]]},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","identifier":{"url":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow","interfaceLanguage":"swift"},"metadata":{"externalID":"WelcomeWindow","modules":[{"name":"WelcomeWindow"}],"symbolKind":"module","role":"collection","title":"WelcomeWindow","roleHeading":"Framework"},"abstract":[{"type":"text","text":"A highly customizable welcome window built for macOS applications. This package supports NSDocument-based apps and offers the ability to override the recent list for other use cases. It’s designed to provide a native and elegant welcome experience for your app at launch, with support for new\/open document actions, drag-and-drop functionality, and dynamic layouts."}],"topicSections":[{"anchor":"Window-Configuration","title":"Window Configuration","identifiers":["doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/WelcomeWindow","doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/WelcomeButton"]},{"identifiers":["doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/RecentsStore"],"anchor":"Recent-Projects-List","title":"Recent Projects List"},{"identifiers":["doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/DocumentOpenDialogConfiguration","doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/DocumentSaveDialogConfiguration","doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/RecentsListItem","doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/RecentsListView","doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/WelcomeView","doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/WelcomeWindowView"],"generated":true,"anchor":"Structures","title":"Structures"},{"anchor":"Enumerations","title":"Enumerations","identifiers":["doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/ActionsBuilder","doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/DefaultSceneID","doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/FocusTarget","doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/WelcomeActions"],"generated":true},{"anchor":"Extended-Modules","identifiers":["doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/AppKit"],"title":"Extended Modules","generated":true}],"primaryContentSections":[{"kind":"content","content":[{"level":2,"text":"Overview","type":"heading","anchor":"Overview"},{"inlineContent":[{"type":"text","text":"To use welcome window, simply import the package"}],"type":"paragraph"},{"type":"codeListing","code":["import WelcomeWindow"],"syntax":"swift"},{"inlineContent":[{"text":"And add it as a window in your SwiftUI App.","type":"text"}],"type":"paragraph"},{"code":["@main","struct CodeEditApp: App {"," @Environment(\\.dismiss) private var dismiss",""," var body: some Scene {"," WelcomeWindow("," \/\/ Add two action buttons below your icon"," actions: { dismiss in"," WelcomeButton("," iconName: \"circle.fill\","," title: \"New Text Document\","," action: {"," NSDocumentController.shared.createFileDocumentWithDialog("," configuration: .init(title: \"Create new text document\"),"," onCompletion: { dismiss() }"," )"," }"," )"," WelcomeButton("," iconName: \"triangle.fill\","," title: \"Open Text Document or Folder\","," action: {"," NSDocumentController.shared.openDocumentWithDialog("," configuration: .init(canChooseDirectories: true),"," onDialogPresented: { dismiss() },"," onCancel: { openWindow(id: \"welcome\") }"," )"," }"," )"," },"," \/\/ Receive files via drag and drop"," onDrop: { url, dismiss in"," print(\"File dropped at: \\(url.path)\")",""," Task {"," NSDocumentController.shared.openDocument(at: url, onCompletion: { dismiss() })"," }"," }"," )"," }","}"],"syntax":"swift","type":"codeListing"}]}],"references":{"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/WelcomeView":{"abstract":[],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WelcomeView"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WelcomeView"}],"type":"topic","role":"symbol","identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/WelcomeView","url":"\/documentation\/welcomewindow\/welcomeview","title":"WelcomeView"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/DocumentOpenDialogConfiguration":{"title":"DocumentOpenDialogConfiguration","navigatorTitle":[{"kind":"identifier","text":"DocumentOpenDialogConfiguration"}],"abstract":[{"type":"text","text":"A configuration struct for presenting an open document dialog."}],"identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/DocumentOpenDialogConfiguration","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"DocumentOpenDialogConfiguration"}],"url":"\/documentation\/welcomewindow\/documentopendialogconfiguration","type":"topic","role":"symbol"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/DefaultSceneID":{"url":"\/documentation\/welcomewindow\/defaultsceneid","identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/DefaultSceneID","type":"topic","kind":"symbol","abstract":[{"text":"An enum containing default scene identifier constants.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"DefaultSceneID"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"DefaultSceneID","kind":"identifier"}],"title":"DefaultSceneID","role":"symbol"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/ActionsBuilder":{"type":"topic","abstract":[{"type":"text","text":"A result builder used to construct "},{"code":"WelcomeActions","type":"codeVoice"},{"type":"text","text":" from SwiftUI views."}],"navigatorTitle":[{"kind":"identifier","text":"ActionsBuilder"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"ActionsBuilder","kind":"identifier"}],"role":"symbol","title":"ActionsBuilder","url":"\/documentation\/welcomewindow\/actionsbuilder","kind":"symbol","identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/ActionsBuilder"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/RecentsListItem":{"abstract":[],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"RecentsListItem"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"RecentsListItem"}],"type":"topic","role":"symbol","identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/RecentsListItem","url":"\/documentation\/welcomewindow\/recentslistitem","title":"RecentsListItem"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow":{"abstract":[{"type":"text","text":"A highly customizable welcome window built for macOS applications. This package supports NSDocument-based apps and offers the ability to override the recent list for other use cases. It’s designed to provide a native and elegant welcome experience for your app at launch, with support for new\/open document actions, drag-and-drop functionality, and dynamic layouts."}],"url":"\/documentation\/welcomewindow","type":"topic","title":"WelcomeWindow","role":"collection","kind":"symbol","identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/WelcomeActions":{"abstract":[{"type":"text","text":"A representation of a limited set of welcome action views, supporting up to three actions."}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WelcomeActions"}],"navigatorTitle":[{"text":"WelcomeActions","kind":"identifier"}],"identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/WelcomeActions","title":"WelcomeActions","kind":"symbol","type":"topic","role":"symbol","url":"\/documentation\/welcomewindow\/welcomeactions"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/WelcomeWindow":{"url":"\/documentation\/welcomewindow\/welcomewindow","navigatorTitle":[{"text":"WelcomeWindow","kind":"identifier"}],"abstract":[{"type":"text","text":"A customizable welcome window scene supporting up to three content views"},{"type":"text","text":" "},{"text":"and an optional custom recent projects list.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/WelcomeWindow","role":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WelcomeWindow"}],"title":"WelcomeWindow"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/RecentsListView":{"url":"\/documentation\/welcomewindow\/recentslistview","abstract":[],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"RecentsListView"}],"navigatorTitle":[{"text":"RecentsListView","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/RecentsListView","kind":"symbol","title":"RecentsListView","role":"symbol"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/FocusTarget":{"role":"symbol","url":"\/documentation\/welcomewindow\/focustarget","title":"FocusTarget","identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/FocusTarget","navigatorTitle":[{"text":"FocusTarget","kind":"identifier"}],"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"FocusTarget","kind":"identifier"}],"kind":"symbol","type":"topic","abstract":[]},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/RecentsStore":{"identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/RecentsStore","type":"topic","url":"\/documentation\/welcomewindow\/recentsstore","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"A utility store for managing recent project file access using security-scoped bookmarks."}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RecentsStore","kind":"identifier"}],"title":"RecentsStore","navigatorTitle":[{"text":"RecentsStore","kind":"identifier"}]},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/WelcomeButton":{"abstract":[],"navigatorTitle":[{"text":"WelcomeButton","kind":"identifier"}],"identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/WelcomeButton","role":"symbol","type":"topic","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WelcomeButton"}],"url":"\/documentation\/welcomewindow\/welcomebutton","title":"WelcomeButton"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/AppKit":{"title":"AppKit","abstract":[],"identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/AppKit","kind":"symbol","url":"\/documentation\/welcomewindow\/appkit","type":"topic","role":"collection"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/WelcomeWindowView":{"url":"\/documentation\/welcomewindow\/welcomewindowview","kind":"symbol","title":"WelcomeWindowView","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WelcomeWindowView"}],"navigatorTitle":[{"kind":"identifier","text":"WelcomeWindowView"}],"identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/WelcomeWindowView","role":"symbol","type":"topic","abstract":[]},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/DocumentSaveDialogConfiguration":{"url":"\/documentation\/welcomewindow\/documentsavedialogconfiguration","kind":"symbol","navigatorTitle":[{"text":"DocumentSaveDialogConfiguration","kind":"identifier"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"DocumentSaveDialogConfiguration","kind":"identifier"}],"role":"symbol","abstract":[{"text":"A configuration struct for presenting a save document dialog.","type":"text"}],"title":"DocumentSaveDialogConfiguration","identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/DocumentSaveDialogConfiguration"}}}
0 commit comments