+{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/welcomewindow"]}],"topicSections":[{"title":"Window Configuration","anchor":"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"},{"title":"Structures","anchor":"Structures","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},{"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":"Enumerations"},{"generated":true,"identifiers":["doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/AppKit"],"title":"Extended Modules","anchor":"Extended-Modules"}],"kind":"symbol","primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","type":"heading","level":2,"text":"Overview"},{"inlineContent":[{"text":"To use welcome window, simply import the package","type":"text"}],"type":"paragraph"},{"code":["import WelcomeWindow"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"And add it as a window in your SwiftUI App."}],"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() })"," }"," }"," )"," }","}"],"type":"codeListing","syntax":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"hierarchy":{"paths":[[]]},"metadata":{"modules":[{"name":"WelcomeWindow"}],"externalID":"WelcomeWindow","roleHeading":"Framework","role":"collection","title":"WelcomeWindow","symbolKind":"module"},"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."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow"},"references":{"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/RecentsListView":{"navigatorTitle":[{"text":"RecentsListView","kind":"identifier"}],"url":"\/documentation\/welcomewindow\/recentslistview","kind":"symbol","type":"topic","title":"RecentsListView","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"RecentsListView","kind":"identifier"}],"abstract":[],"identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/RecentsListView"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/AppKit":{"title":"AppKit","kind":"symbol","type":"topic","url":"\/documentation\/welcomewindow\/appkit","role":"collection","identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/AppKit","abstract":[]},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/RecentsStore":{"type":"topic","kind":"symbol","abstract":[{"text":"A utility store for managing recent project file access using security-scoped bookmarks.","type":"text"}],"url":"\/documentation\/welcomewindow\/recentsstore","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"RecentsStore","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"RecentsStore"}],"title":"RecentsStore","identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/RecentsStore"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/WelcomeView":{"abstract":[],"identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/WelcomeView","url":"\/documentation\/welcomewindow\/welcomeview","title":"WelcomeView","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WelcomeView","kind":"identifier"}],"kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WelcomeView"}]},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow":{"title":"WelcomeWindow","url":"\/documentation\/welcomewindow","role":"collection","kind":"symbol","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."}],"identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow","type":"topic"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/DocumentOpenDialogConfiguration":{"identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/DocumentOpenDialogConfiguration","title":"DocumentOpenDialogConfiguration","kind":"symbol","url":"\/documentation\/welcomewindow\/documentopendialogconfiguration","role":"symbol","navigatorTitle":[{"text":"DocumentOpenDialogConfiguration","kind":"identifier"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DocumentOpenDialogConfiguration","kind":"identifier"}],"abstract":[{"text":"A configuration struct for presenting an open document dialog.","type":"text"}]},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/WelcomeActions":{"identifier":"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."}],"type":"topic","kind":"symbol","title":"WelcomeActions","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WelcomeActions"}],"navigatorTitle":[{"text":"WelcomeActions","kind":"identifier"}],"url":"\/documentation\/welcomewindow\/welcomeactions"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/ActionsBuilder":{"abstract":[{"type":"text","text":"A result builder used to construct "},{"type":"codeVoice","code":"WelcomeActions"},{"type":"text","text":" from SwiftUI views."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"ActionsBuilder"}],"identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/ActionsBuilder","type":"topic","title":"ActionsBuilder","navigatorTitle":[{"text":"ActionsBuilder","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/welcomewindow\/actionsbuilder","role":"symbol"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/DocumentSaveDialogConfiguration":{"identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/DocumentSaveDialogConfiguration","abstract":[{"type":"text","text":"A configuration struct for presenting a save document dialog."}],"title":"DocumentSaveDialogConfiguration","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"DocumentSaveDialogConfiguration"}],"kind":"symbol","url":"\/documentation\/welcomewindow\/documentsavedialogconfiguration","type":"topic","role":"symbol","navigatorTitle":[{"text":"DocumentSaveDialogConfiguration","kind":"identifier"}]},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/FocusTarget":{"role":"symbol","identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/FocusTarget","url":"\/documentation\/welcomewindow\/focustarget","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"FocusTarget"}],"abstract":[],"title":"FocusTarget","navigatorTitle":[{"kind":"identifier","text":"FocusTarget"}],"kind":"symbol"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/DefaultSceneID":{"role":"symbol","type":"topic","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"DefaultSceneID"}],"abstract":[{"text":"An enum containing default scene identifier constants.","type":"text"}],"kind":"symbol","url":"\/documentation\/welcomewindow\/defaultsceneid","navigatorTitle":[{"text":"DefaultSceneID","kind":"identifier"}],"title":"DefaultSceneID","identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/DefaultSceneID"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/RecentsListItem":{"title":"RecentsListItem","url":"\/documentation\/welcomewindow\/recentslistitem","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"RecentsListItem","kind":"identifier"}],"role":"symbol","kind":"symbol","abstract":[],"identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/RecentsListItem","navigatorTitle":[{"text":"RecentsListItem","kind":"identifier"}],"type":"topic"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/WelcomeWindowView":{"role":"symbol","identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/WelcomeWindowView","url":"\/documentation\/welcomewindow\/welcomewindowview","navigatorTitle":[{"text":"WelcomeWindowView","kind":"identifier"}],"kind":"symbol","type":"topic","title":"WelcomeWindowView","abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WelcomeWindowView","kind":"identifier"}]},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/WelcomeWindow":{"navigatorTitle":[{"kind":"identifier","text":"WelcomeWindow"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WelcomeWindow"}],"kind":"symbol","role":"symbol","url":"\/documentation\/welcomewindow\/welcomewindow","title":"WelcomeWindow","identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/WelcomeWindow","abstract":[{"text":"A customizable welcome window scene supporting up to three content views","type":"text"},{"type":"text","text":" "},{"type":"text","text":"and an optional custom recent projects list."}],"type":"topic"},"doc://welcomewindow.WelcomeWindow/documentation/WelcomeWindow/WelcomeButton":{"identifier":"doc:\/\/welcomewindow.WelcomeWindow\/documentation\/WelcomeWindow\/WelcomeButton","title":"WelcomeButton","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WelcomeButton","kind":"identifier"}],"kind":"symbol","role":"symbol","url":"\/documentation\/welcomewindow\/welcomebutton","navigatorTitle":[{"kind":"identifier","text":"WelcomeButton"}],"abstract":[]}}}
0 commit comments