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