DTOnboarding

KO | EN

gitlite — search

#hacktoberfest #react #typescript #llm #go #rust #docker #cli #kubernetes #vue #security #ios #mcp #open-source

(★ 29)

A macOS onboarding component

DTOnboarding Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# DTOnboarding

<a href="https://developer.apple.com/swift"><img alt="Swift5" src="https://img.shields.io/badge/language-Swift5-orange.svg"/></a>
<a href="https://swift.org/package-manager"><img alt="Swift Package Manager" src="https://img.shields.io/badge/SwiftPM-compatible-yellowgreen.svg"/></a>
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/demianturner/dtonboarding?sort=semver)
![GitHub](https://img.shields.io/github/license/demianturner/dtonboarding)
![macOS](https://img.shields.io/badge/macOS-10.12-green.svg)

A macOS onboarding component.

- creates a window containing a configurable number of screens
- use buttons or gestures to navigate
- component size, layout and content easily are configurable

![](https://i.imgur.com/sJb69GE.gif)

## Installation
Install using Swift Package Manager.  Use master branch.

## Dependencies
- [https://github.com/demianturner/DTPageControl](https://github.com/demianturner/DTPageControl)

## Requirements
- OS X 10.14+
- Xcode 11.0 or above

## Demo/Example
Either compile and run the example in the Demo folder or see the component used in [Crypto Tools](https://apps.apple.com/gb/app/crypto-tools/id1345035239?mt=12).

## Usage

Use the following code in your `AppDelegate.swift` or similar.

```swift
class AppDelegate: NSObject, NSApplicationDelegate {
    private var onboardingWindowController: NSWindowController?

func applicationDidFinishLaunching(_ aNotification: Notification) {
        let config = OnboardingConfig(
            windowWidth: 350,
            windowHeight: 430,
            windowTitle: "my sample title",
            pageCount: 3,
            pageControlWidth: 200,
            pageControlHeight: 20,
            pageControlVerticalDistanceFromBottom: 20, 
            pageTransitionStyle: .stackBook
        )

let pages = [
            DTPageController(controllerId: "1"),
            DTPageController(controllerId: "2"),
            DTPageController(controllerId: "3")
        ]

let onboardingController = DTOnboardingController(config: config, pages: pages)
        let frame = onboardingController.view.bounds
        let myWindow = NSWindow(
            contentRect: .init(origin: .zero, size: frame.size),
            styleMask: [.closable, .miniaturizable, .resizable, .titled],
            backing: .buffered,
            defer: false
        )
        myWindow.title = config.windowTitle
        myWindow.center()

onboardingWindowController = NSWindowController(window: myWindow)
        onboardingWindowController?.contentViewController = onboardingController
        onboardingWindowController?.showWindow(self)
    }
}
```

## License
This software is Open Source under the MIT license, see LICENSE for details.

DTOnboarding

DTOnboarding Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

DTOnboarding

DTOnboarding Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README