@rafaelaugusto/jolt 0.1.0-beta.1 → 0.1.0-beta.3

package/src/text.ts

@@ -0,0 +1,296 @@
+import { Application, Label, isIOS } from '@nativescript/core'
+import { textProperty, formattedTextProperty } from '@nativescript/core/ui/text-base'
+import { toView } from './animate.js'
+import type { Animation } from './engine.js'
+import { textLayer } from './text-layout.js'
+import type { Target } from './types.js'
+
+export interface TextOptions {
+  /** Composed letters (including emoji), or words. Defaults to 'letter'. */
+  by?: 'letter' | 'word'
+  /** Milliseconds per piece. Defaults to 400. */
+  duration?: number
+  /** Milliseconds between pieces. Defaults to 35. */
+  stagger?: number
+  /** Milliseconds before the first piece. Defaults to zero. */
+  delay?: number
+  /** Initial vertical offset in DIPs. Defaults to 12. */
+  y?: number
+}
+type Options = Required<TextOptions>
+const running = new WeakMap<Label, TextAnimation>()
+const callbacks = new WeakMap<NSObject, (finished: boolean) => void>()
+let Delegate: typeof NSObject | undefined
+const styleEvents = [
+  'fontInternalChange',
+  'colorChange',
+  'textAlignmentChange',
+  'textDecorationChange',
+  'textTransformChange',
+  'letterSpacingChange',
+  'lineHeightChange',
+  'textShadowChange',
+  'textStrokeChange',
+  'whiteSpaceChange',
+  'textOverflowChange',
+  'maxLinesChange',
+  'paddingLeftChange',
+  'paddingRightChange',
+  'paddingTopChange',
+  'paddingBottomChange',
+  'visibilityChange',
+  'directionChange',
+  'borderLeftWidthChange',
+  'borderRightWidthChange',
+  'borderTopWidthChange',
+  'borderBottomWidthChange',
+]
+
+/** Reveals the text of an iOS Label without splitting its layout or accessibility element. */
+export function animateText(target: Target, options: TextOptions = {}): Animation {
+  const config: Options = {
+    by: options.by ?? 'letter',
+    duration: options.duration ?? 400,
+    stagger: options.stagger ?? 35,
+    delay: options.delay ?? 0,
+    y: options.y ?? 12,
+  }
+  if (config.by !== 'letter' && config.by !== 'word')
+    throw new TypeError('Text grouping must be letter or word.')
+  for (const key of ['duration', 'stagger', 'delay'] as const) {
+    if (!Number.isFinite(config[key]) || config[key] < 0)
+      throw new RangeError(`Text ${key} must be a nonnegative finite number.`)
+  }
+  if (!Number.isFinite(config.y)) throw new RangeError('Text y must be finite.')
+  const view = toView(target)
+  if (!(view instanceof Label)) throw new TypeError('Expected a NativeScript Label.')
+  running.get(view)?.stop()
+  return new TextAnimation(view, config)
+}
+
+function completion(
+  callback: (finished: boolean) => void,
+): NSObject & CAAnimationDelegate {
+  if (!Delegate) {
+    const base = NSObject as typeof NSObject & {
+      extend(
+        methods: object,
+        options: { protocols: unknown[]; name: string },
+      ): typeof NSObject
+    }
+    Delegate = base.extend(
+      {
+        animationDidStopFinished(
+          this: NSObject,
+          _animation: CAAnimation,
+          finished: boolean,
+        ) {
+          callbacks.get(this)?.(finished)
+        },
+      },
+      { protocols: [CAAnimationDelegate], name: 'JoltTextAnimationDelegate' },
+    )
+  }
+  const delegate = Delegate.new()
+  callbacks.set(delegate, callback)
+  return delegate
+}
+
+class TextAnimation implements Animation {
+  readonly finished: Promise<boolean>
+  private resolve!: (finished: boolean) => void
+  private readonly formatted: Label['formattedText']
+  private settled = false
+  private queued = false
+  private native: UILabel | undefined
+  private bounds: CGRect | undefined
+  private layer: CALayer | undefined
+  private originalText: string | null = null
+  private originalAttributed: NSAttributedString | null = null
+  private accessibility: string | null = null
+  private temporaryAccessibility: string | undefined
+  private delegate: NSObject | undefined
+  private observer: ReturnType<typeof Application.ios.addNotificationObserver> | undefined
+
+  constructor(
+    private readonly view: Label,
+    private readonly options: Options,
+  ) {
+    this.finished = new Promise((resolve) => {
+      this.resolve = resolve
+    })
+    this.formatted = view.formattedText
+    running.set(view, this)
+    if (!isIOS) {
+      this.end(false)
+      return
+    }
+    if (options.duration === 0 || UIAccessibilityIsReduceMotionEnabled()) {
+      this.end(true)
+      return
+    }
+    view.on('loaded', this.schedule)
+    view.on('layoutChanged', this.layoutChanged)
+    view.on('unloaded', this.stop)
+    view.on('textChange', this.changed)
+    view.on('formattedTextChange', this.changed)
+    this.formatted?.on('propertyChange', this.changed)
+    for (const event of styleEvents) view.style.on(event, this.changed)
+    this.schedule()
+  }
+
+  then<A = boolean, B = never>(
+    onfulfilled?: ((finished: boolean) => A | PromiseLike<A>) | null,
+    onrejected?: ((reason: unknown) => B | PromiseLike<B>) | null,
+  ): Promise<A | B> {
+    return this.finished.then(onfulfilled, onrejected)
+  }
+  /** Cancels the entrance and restores the full text. */
+  stop = () => this.end(false)
+  private changed = () => this.end(false, true)
+  private motionChanged = () => {
+    if (UIAccessibilityIsReduceMotionEnabled()) this.end(true)
+  }
+  private layoutChanged = () => {
+    const native = this.view.nativeViewProtected as UILabel | undefined
+    const a = this.bounds
+    const b = native?.bounds
+    if (
+      this.layer &&
+      (native !== this.native ||
+        !native?.window ||
+        !b ||
+        !a ||
+        a.origin.x !== b.origin.x ||
+        a.origin.y !== b.origin.y ||
+        a.size.width !== b.size.width ||
+        a.size.height !== b.size.height)
+    )
+      return this.stop()
+    this.schedule()
+  }
+  private schedule = () => {
+    if (this.settled || this.queued) return
+    this.queued = true
+    void Promise.resolve().then(() => {
+      this.queued = false
+      if (this.settled || this.layer || !this.view.isLoaded) return
+      try {
+        this.start()
+      } catch {
+        this.end(false)
+      }
+    })
+  }
+  private start() {
+    if (this.options.duration === 0 || UIAccessibilityIsReduceMotionEnabled())
+      return this.end(true)
+    if (this.view.visibility !== 'visible') return this.end(false)
+    const native = this.view.nativeViewProtected as UILabel | undefined
+    if (!(native instanceof UILabel) || !native.window) return
+    if (native.bounds.size.width <= 0 || native.bounds.size.height <= 0) return
+    const prepared = textLayer(native, this.options.by)
+    if (!prepared) return this.end(false)
+    if (!prepared.layer?.sublayers?.count) return this.end(true)
+    if (
+      !Number.isFinite(
+        this.options.delay +
+          this.options.duration +
+          (prepared.layer.sublayers.count - 1) * this.options.stagger,
+      )
+    )
+      return this.end(false)
+    this.native = native
+    this.bounds = native.bounds
+    this.layer = prepared.layer
+    this.originalText = native.text
+    this.originalAttributed = native.attributedText
+    this.accessibility = native.accessibilityLabel
+    this.temporaryAccessibility = this.accessibility ?? prepared.text
+    const { duration, delay, stagger, y } = this.options
+    const start = CACurrentMediaTime()
+    CATransaction.begin()
+    CATransaction.setDisableActions(true)
+    try {
+      native.text = ''
+      native.accessibilityLabel = this.temporaryAccessibility
+      native.layer.addSublayer(this.layer)
+      const pieces = this.layer.sublayers!
+      for (let i = 0; i < pieces.count; i++) {
+        const piece = pieces.objectAtIndex(i)
+        const fade = CABasicAnimation.animationWithKeyPath('opacity')
+        fade.fromValue = 0
+        fade.toValue = 1
+        const move = CABasicAnimation.animationWithKeyPath('transform.translation.y')
+        move.fromValue = y
+        move.toValue = 0
+        fade.duration = move.duration = duration / 1000
+        const group = CAAnimationGroup.new()
+        group.animations = NSArray.arrayWithArray([fade, move])
+        group.duration = duration / 1000
+        group.beginTime = start + (delay + i * stagger) / 1000
+        group.fillMode = kCAFillModeBackwards
+        group.timingFunction = CAMediaTimingFunction.functionWithName(
+          kCAMediaTimingFunctionEaseOut,
+        )
+        if (i === pieces.count - 1)
+          this.delegate = group.delegate = completion((finished) => this.end(finished))
+        piece.addAnimationForKey(group, 'jolt:text')
+      }
+      this.observer = Application.ios.addNotificationObserver(
+        UIAccessibilityReduceMotionStatusDidChangeNotification,
+        this.motionChanged,
+      )
+    } finally {
+      CATransaction.commit()
+    }
+  }
+  private end(finished: boolean, refresh = false) {
+    if (this.settled) return
+    this.settled = true
+    const { view, native, layer } = this
+    view.off('loaded', this.schedule)
+    view.off('layoutChanged', this.layoutChanged)
+    view.off('unloaded', this.stop)
+    view.off('textChange', this.changed)
+    view.off('formattedTextChange', this.changed)
+    this.formatted?.off('propertyChange', this.changed)
+    for (const event of styleEvents) view.style.off(event, this.changed)
+    if (running.get(view) === this) running.delete(view)
+    if (this.observer)
+      Application.ios.removeNotificationObserver(
+        this.observer,
+        UIAccessibilityReduceMotionStatusDidChangeNotification,
+      )
+    if (this.delegate) callbacks.delete(this.delegate)
+    if (native && layer) {
+      CATransaction.begin()
+      CATransaction.setDisableActions(true)
+      try {
+        // Restore only the native text we suppressed; app changes win.
+        if (!native.text && !native.attributedText?.length) {
+          if (refresh && view.nativeViewProtected === native) {
+            const property = view.formattedText ? formattedTextProperty : textProperty
+            ;(view as unknown as Record<symbol, (value: unknown) => void>)[
+              property.setNative
+            ]!(view.formattedText ?? view.text)
+          } else if (this.originalAttributed)
+            native.attributedText = this.originalAttributed
+          else native.text = this.originalText
+        }
+        if (native.accessibilityLabel === this.temporaryAccessibility)
+          native.accessibilityLabel = this.accessibility
+        layer.removeFromSuperlayer()
+        const pieces = layer.sublayers
+        if (pieces)
+          for (let i = 0; i < pieces.count; i++)
+            pieces.objectAtIndex(i).removeAnimationForKey('jolt:text')
+      } finally {
+        CATransaction.commit()
+      }
+    }
+    this.native = this.layer = this.delegate = this.observer = undefined
+    this.originalAttributed = null
+    this.resolve(finished)
+  }
+}

package/src/track.ts

@@ -1,6 +1,7 @@
 import { linear } from './easing.js'
+import { solveDecay } from './decay.js'
 import { precision, type Property } from './properties.js'
-import { solveSpring } from './spring.js'
+import { solveSpring, springPhysics } from './spring.js'
 import type { Curve, ResolvedTransition } from './transition.js'
 
 /**
@@ -37,6 +38,7 @@ interface Motion {
 }
 
 const SAMPLES_PER_SECOND = 60
+const MAX_DECAY_SAMPLES = 6000
 const ARRIVAL_TOLERANCE = 0.05
 
 export function createTrack(
@@ -48,7 +50,9 @@ export function createTrack(
   const motion =
     curve.type === 'spring'
       ? spring(property, keyframes, curve, velocity)
-      : tween(keyframes, curve)
+      : curve.type === 'decay'
+        ? decay(property, keyframes[0]!, curve)
+        : tween(keyframes, curve)
   const { duration } = motion
   const first = motion.values[0]!
   const last = motion.values.at(-1)!
@@ -75,7 +79,11 @@ export function createTrack(
     values: motion.values,
     to: !finite || endsBackwards ? first : last,
     end,
-    arrival: curve.type === 'spring' && repeat === 0 ? delay + arrival(motion) : end,
+    arrival:
+      (curve.type === 'spring' || (curve.type === 'decay' && curve.snap !== undefined)) &&
+      repeat === 0
+        ? delay + arrival(motion)
+        : end,
     valueAt: (elapsed) => motion.position(localTime(elapsed)[0]),
     velocityAt: (elapsed) => {
       if (elapsed <= delay || elapsed >= end) return 0
@@ -85,6 +93,37 @@ export function createTrack(
   }
 }
 
+function decay(
+  property: Property,
+  from: number,
+  curve: Extract<Curve, { type: 'decay' }>,
+): Motion {
+  const motion = solveDecay(from, curve.velocity, curve.friction, precision[property])
+  if (curve.snap) {
+    const to = curve.snap.reduce((closest, stop) =>
+      Math.abs(stop - motion.to) < Math.abs(closest - motion.to) ? stop : closest,
+    )
+    return spring(
+      property,
+      [from, to],
+      { type: 'spring', physics: springPhysics({}), velocity: curve.velocity },
+      0,
+    )
+  }
+
+  const steps = Math.max(
+    1,
+    Math.min(MAX_DECAY_SAMPLES, Math.ceil((motion.duration / 1000) * SAMPLES_PER_SECOND)),
+  )
+  const times: number[] = []
+  const values: number[] = []
+  for (let i = 0; i <= steps; i++) {
+    times.push(i / steps)
+    values.push(motion.position((i / steps) * motion.duration))
+  }
+  return { ...motion, times, values }
+}
+
 function arrival({ times, values, duration }: Motion) {
   const target = values.at(-1)!
   const tolerance =

package/src/transition.ts

@@ -52,6 +52,12 @@ export type Curve =
       times: readonly number[] | undefined
     }
   | { type: 'spring'; physics: SpringPhysics; velocity: number | undefined }
+  | {
+      type: 'decay'
+      friction: number
+      velocity: number
+      snap: readonly number[] | undefined
+    }
 
 export interface ResolvedTransition {
   curve: Curve

package/src/types.ts

@@ -1,4 +1,5 @@
 import type { View } from '@nativescript/core'
+import type { Haptic } from './haptics.js'
 import type { SpringName, Transition } from './transition.js'
 
 /** A value to animate to, or keyframes. `null` stands for the value the view has when the animation starts. */
@@ -24,6 +25,19 @@ export interface Keyframes {
 export type Target =
   View | { readonly nativeView: View } | { readonly nativeElement: View }
 
+/** Translation velocities in DIPs per second. Omitted axes keep their current motion. */
+export interface DecayVelocity {
+  x?: number
+  y?: number
+}
+
+export interface DecayOptions {
+  /** Velocity multiplier per millisecond, between 0 and 1 exclusively. Defaults to 0.998. */
+  friction?: number
+  /** Spring to the closest stop to the projected landing, shared or set per axis. */
+  snap?: readonly number[] | { x?: readonly number[]; y?: readonly number[] }
+}
+
 export interface Stagger {
   /** Milliseconds between one target and the next. */
   each: number
@@ -38,4 +52,6 @@ export type AnimateOptions = Transition & {
   relative?: boolean
   /** With several targets, delays each one by this much more than the previous. */
   stagger?: number | Stagger
+  /** iOS impact feedback at arrival, or at explicit points in a finite animation. */
+  haptic?: Haptic
 }