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