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