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