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