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