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