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