Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions apps/desktop/Sources/StimDesktop/Design/Theme.swift
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,14 @@ enum BrandAssets {
url(scheme == .dark ? "stim-build-dark.json" : "stim-build-light.json", websitePath: "static/img/branding")
}

static func tutorial(_ scheme: ColorScheme) -> URL? {
url(scheme == .dark ? "stim-tutorial-dark.json" : "stim-tutorial-light.json", websitePath: "static/img/branding")
}

static func stepDone(_ scheme: ColorScheme) -> URL? {
url(scheme == .dark ? "stim-step-done-dark.json" : "stim-step-done-light.json", websitePath: "static/img/branding")
}

/// The wordmark's path art as a template image, so callers tint it with `Palette.primary`.
static let wordmark: NSImage? = {
let art = image("wordmark.svg")
Expand Down
122 changes: 122 additions & 0 deletions apps/desktop/Sources/StimDesktop/Design/TutorialIllustration.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
import Lottie
import StimKit
import SwiftUI

struct TutorialIllustration: View {
var step: String
var failed = false
#if DEBUG
var fixtureRendering = false
#endif
@State private var shown: String?
@State private var bridge: String?
@State private var generation = 0
@State private var windowVisible = false
@AppStorage(AppPreferences.Key.pausesHiddenFrames) private var pausesHidden = true
@Environment(\.colorScheme) private var colorScheme
@Environment(\.accessibilityReduceMotion) private var reduceMotion

static let size = CGSize(width: 288, height: 168)

var body: some View {
ZStack {
if let art = TutorialArt.load(colorScheme) {
if rendersStatic {
if let image = art.still(failed ? step : "\(step).still") { Image(nsImage: image).resizable() }
} else {
LottieView(animation: art.animation)
.playbackMode(playback(art))
.animationDidFinish { completed in
if completed { bridge = nil }
}
.resizable()
.background(WindowStateReader { windowVisible = $0 != .hidden })
.id(generation)
.transition(.opacity)
}
}
}
.aspectRatio(Self.size, contentMode: .fit)
.accessibilityHidden(true)
.onChange(of: step, initial: true) { _, next in show(next) }
}

private var rendersStatic: Bool {
#if DEBUG
fixtureRendering
#else
false
#endif
}

private func show(_ next: String) {
guard next != shown else { return }
let marker = shown.map { "\($0)>\(next)" }
if let marker, !reduceMotion, TutorialArt.load(colorScheme)?.markers.contains(marker) == true {
bridge = marker
shown = next
return
}
bridge = nil
withAnimation(shown == nil || reduceMotion ? nil : .easeInOut(duration: 0.25)) {
shown = next
generation += 1
}
}

private func playback(_ art: TutorialArt) -> LottiePlaybackMode {
guard let shown else { return .paused(at: .frame(0)) }
if failed { return .paused(at: .marker(shown)) }
if reduceMotion || (pausesHidden && !windowVisible) { return .paused(at: .marker("\(shown).still")) }
if let bridge {
return .playing(.fromMarker(bridge, toMarker: bridge, playEndMarkerFrame: true, loopMode: .playOnce))
}
return .playing(.marker(shown, loopMode: art.once.contains(shown) ? .playOnce : .loop))
}
}

struct TutorialArt {
let animation: LottieAnimation
let markers: Set<String>
let once: Set<String>

@MainActor private static var cache: [ColorScheme: TutorialArt] = [:]

@MainActor static func load(_ scheme: ColorScheme) -> TutorialArt? {
if let cached = cache[scheme] { return cached }
guard let url = BrandAssets.tutorial(scheme), let data = try? Data(contentsOf: url),
let asset = try? JSONSerialization.jsonObject(with: data) as? [String: Any],
let animation = try? LottieAnimation(dictionary: asset)
else { return nil }
let modes = (asset["stim"] as? [String: Any])?["modes"] as? [String: String] ?? [:]
let art = TutorialArt(
animation: animation, markers: Set(animation.markerNames),
once: Set(modes.filter { $0.value == "once" }.keys))
cache[scheme] = art
return art
}

#if DEBUG
@MainActor func still(_ marker: String) -> NSImage? {
guard let frame = animation.frameTime(forMarker: marker) else { return nil }
let view = LottieAnimationView(animation: animation, configuration: LottieConfiguration(renderingEngine: .mainThread))
view.frame = CGRect(origin: .zero, size: TutorialIllustration.size)
view.currentFrame = frame
view.layoutSubtreeIfNeeded()
view.layer?.displayIfNeeded()
guard let layer = view.layer else { return nil }
let scale: CGFloat = 2
let width = Int(TutorialIllustration.size.width * scale)
let height = Int(TutorialIllustration.size.height * scale)
guard
let context = CGContext(
data: nil, width: width, height: height, bitsPerComponent: 8, bytesPerRow: 0,
space: CGColorSpace(name: CGColorSpace.sRGB)!, bitmapInfo: CGImageAlphaInfo.premultipliedLast.rawValue)
else { return nil }
context.translateBy(x: 0, y: CGFloat(height))
context.scaleBy(x: scale, y: -scale)
layer.render(in: context)
return context.makeImage().map { NSImage(cgImage: $0, size: TutorialIllustration.size) }
}
#endif
}
22 changes: 21 additions & 1 deletion apps/desktop/Sources/StimDesktop/Views/TutorialPanel.swift
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,13 @@ struct TutorialPanel: View {
Text("\(position) of \(steps.count)")
.font(.stim(.caption)).foregroundStyle(Palette.secondary).monospacedDigit()
}
.padding(Space.xl)
.padding([.horizontal, .top], Space.xl)
TutorialTrack(steps: steps, progress: snapshot.steps)
.padding(.horizontal, Space.xl)
.padding(.vertical, Space.md)
illustration
.padding(.horizontal, Space.lg)
.padding(.bottom, Space.md)
Divider()
panelContent
Divider()
Expand All @@ -47,6 +53,20 @@ struct TutorialPanel: View {
.accessibilityLabel("Stim tutorial")
}

@ViewBuilder private var illustration: some View {
let step = snapshot.currentStep ?? (snapshot.record.done.contains("delete") ? "delete" : "finish")
let state = snapshot.steps.first { $0.id == step }?.state
let failed: Bool = {
if case .failed = state { return true }
return false
}()
#if DEBUG
TutorialIllustration(step: step, failed: failed, fixtureRendering: fixtureRendering)
#else
TutorialIllustration(step: step, failed: failed)
#endif
}

private var rendersStatic: Bool {
#if DEBUG
fixtureRendering
Expand Down
80 changes: 80 additions & 0 deletions apps/desktop/Sources/StimDesktop/Views/TutorialTrack.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
import Lottie
import StimKit
import SwiftUI

struct TutorialTrack: View {
var steps: [TutorialStep]
var progress: [TutorialStepProgress]
@State private var seenDone: Set<String>?
@State private var celebrating: Set<String> = []
@Environment(\.colorScheme) private var colorScheme
@Environment(\.accessibilityReduceMotion) private var reduceMotion

var body: some View {
HStack(spacing: 0) {
ForEach(Array(steps.enumerated()), id: \.element.id) { index, step in
let state = progress.first { $0.id == step.id }?.state ?? .pending
node(step, state: state)
if index < steps.count - 1 {
segment(filled: state == .done || state == .skipped)
}
}
}
.frame(height: 22)
.onChange(of: doneIDs, initial: true) { _, done in celebrate(done) }
.accessibilityElement(children: .ignore)
.accessibilityLabel("Tutorial progress")
.accessibilityValue("\(doneIDs.count) of \(steps.count) steps done")
}

private var doneIDs: Set<String> { Set(progress.filter { $0.state == .done }.map(\.id)) }

private func celebrate(_ done: Set<String>) {
defer { seenDone = done }
guard let seenDone, !reduceMotion else { return }
celebrating.formUnion(done.subtracting(seenDone))
}

private func node(_ step: TutorialStep, state: TutorialStepState) -> some View {
let size: CGFloat = step.optional ? 12 : 16
return ZStack {
switch state {
case .done:
Circle().fill(Palette.success)
Image(systemName: "checkmark").font(.system(size: size * 0.55, weight: .bold)).foregroundStyle(Palette.onBrand)
case .current:
Circle().strokeBorder(Palette.primary, lineWidth: 2)
Circle().fill(Palette.primary).frame(width: size * 0.4, height: size * 0.4)
case .failed:
Circle().strokeBorder(Palette.error, lineWidth: 2)
Image(systemName: "exclamationmark").font(.system(size: size * 0.55, weight: .bold))
.foregroundStyle(Palette.error)
case .skipped:
Circle().strokeBorder(Palette.tertiary, lineWidth: 1.5)
Image(systemName: "minus").font(.system(size: size * 0.5, weight: .bold)).foregroundStyle(Palette.tertiary)
case .pending:
Circle().strokeBorder(
Palette.tertiary, style: StrokeStyle(lineWidth: 1.5, dash: step.optional ? [2, 2] : []))
}
}
.frame(width: size, height: size)
.overlay {
if celebrating.contains(step.id), let url = BrandAssets.stepDone(colorScheme) {
LottieView(animation: .filepath(url.path))
.playbackMode(.playing(.fromProgress(0, toProgress: 1, loopMode: .playOnce)))
.animationDidFinish { _ in celebrating.remove(step.id) }
.resizable()
.frame(width: 40, height: 40)
.allowsHitTesting(false)
}
}
.help(step.title)
}

private func segment(filled: Bool) -> some View {
Rectangle()
.fill(filled ? Palette.success : Palette.tertiary.opacity(0.5))
.frame(height: filled ? 2 : 1)
.frame(maxWidth: .infinity)
}
}
2 changes: 1 addition & 1 deletion website/scripts/build-stim-tutorial-lottie.py
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ def segment(self, name, length, still=None, once=False):
global OFF
OFF = self.t
self.ip, self.op = self.t, self.t + length - 0.5
self.markers.append({'tm': self.t, 'cm': name, 'dr': length})
self.markers.append({'tm': self.t, 'cm': name, 'dr': length - 1})
if '>' not in name:
self.modes[name] = 'once' if once else 'loop'
if once:
Expand Down
2 changes: 1 addition & 1 deletion website/static/img/branding/stim-tutorial-dark.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion website/static/img/branding/stim-tutorial-light.json

Large diffs are not rendered by default.

Loading