samusaranx/onefingerrotation-remastered

Usage

This package adds one view modifier .viewRotation() that accepts a number of optional arguments that control the behavior of the modified view.

These are all the arguments with example values:

@State var angle: Angle = .zero

// ...

someView
	.viewRotation(
		rotationAngle: $angle,
		touchRotationEnabled: .constant(true),
		knobRange: Angle(degrees: -90)...Angle(degrees: 90),
		inertiaEnabled: .constant(true),
		inertiaFriction: .constant(1.5),
		autoRotationEnabled: .constant(false),
		autoRotationSpeed: .constant(.degrees(90)),
		proMotion: true
	)

The proMotion argument controls whether affected views will animate at ProMotion frame rates.\ It defaults to false, which limits animations to 60 FPS, which is generally good enough.\ Please refer to Optimizing iPhone and iPad apps to support ProMotion displays to learn more.

Below are some possible configurations that are possible with this package:

Set-and-Forget Rotation

Use this if you only want rotation and nothing else. Just add .viewRotation() to a view and it will become rotatable with one finger.

Rotation with a bound value

Use this if you want to act on certain rotation angles.

@State var rotation: Angle = .zero

someView
	.viewRotation(rotationAngle: $rotation)

Rotation with Inertia

Use this if you want the ✨ fanciest ✨ rotation. Set inertiaEnabled to true and optionally override inertiaFriction to control how quickly the view's rotation slows down after flicking it.

Note: The default friction value is 1.5.

@State var rotation: Angle = .zero
@State var inertiaEnabled: Angle = .constant(true)
@State var inertiaFriction: Double = 1.5

someView
	.viewRotation(
		rotationAngle: $totalAngle,
		inertiaEnabled: $inertiaEnabled,
		inertiaFriction: $inertiaFriction
	)

Auto Rotation

Use this if you want a view that, in addition to the previous rotation modes, can also rotate on its own.

Note: By default, auto-rotating views rotate by 20 degrees per second.

@State var rotation: Angle = .zero
@State var autoRotationEnabled: Angle = .constant(true)
@State var autoRotationSpeed: Angle = .constant(.degrees(20))

someView
	.viewRotation(
		rotationAngle: $totalAngle,
		autoRotationEnabled: $rotationEnabled,
		autoRotationSpeed: $rotationSpeed
	)

Auto Rotation only

If you don't want your rotating view to be interrupted by a user, just set touchRotationEnabled to false.

Note: By default, touch rotation is enabled.

@State var rotation: Angle = .zero
@State var autoRotationEnabled: Angle = .constant(true)
@State var autoRotationSpeed: Angle = .constant(.degrees(20))

someView
	.viewRotation(
		rotationAngle: $totalAngle,
		touchRotationEnabled: .constant(false),
		autoRotationEnabled: $rotationEnabled,
		autoRotationSpeed: $rotationSpeed
	)

Shortcuts

There is an additional overload to .viewRotation that takes a Mode enum:

func viewRotation(mode: ViewRotation.Mode, proMotion: Bool = false) -> some View

This overload enables easier, more readable view setup for a number of cases:

public enum Mode {
	case knob(range: ClosedRange<Angle>)
	case inertia(friction: Double)
	case autoRotation(speed: Angle)
	case autoRotationNoTouch(speed: Angle)
	case inertiaAndAutoRotation(friction: Double, speed: Angle)
}

Package Metadata

Repository: samusaranx/onefingerrotation-remastered

Default branch: main

README: README.md