Skip to content

Commit

Permalink
0.1.0
Browse files Browse the repository at this point in the history
Co-authored-by: MVP Bot <[email protected]>
Co-authored-by: Kasper Lahti <[email protected]>
  • Loading branch information
3 people authored Oct 13, 2022
1 parent 5e09c81 commit 27945b3
Show file tree
Hide file tree
Showing 2 changed files with 185 additions and 25 deletions.
4 changes: 2 additions & 2 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ let package = Package(
targets: [
.binaryTarget(
name: "Pow",
url: "https://packages.movingparts.io/binaries/pow/0.0.13/Pow.xcframework.zip",
checksum: "4fd8a2e00b886d5e5a41159a68f7991ba45217ad1e8690cb7f158cfa96fc831b"
url: "https://packages.movingparts.io/binaries/pow/0.1.0/Pow.xcframework.zip",
checksum: "27bfbae340405068387782b4f3712b58fa07225003c85c347f4d3c2122df8507"
),
]
)
206 changes: 183 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Pow

Delightful SwiftUI transitions for your app.
Delightful SwiftUI effects for your app.

> **Note**
> Pow is free to test and evaluate. To deploy an app using it to the App Store, you need to [purchase a license](https://movingparts.io/pow).
Expand All @@ -18,25 +18,170 @@ To add a package dependency to your Xcode project, select _File_ > _Add Package_

# Overview

Pow features a selection of [SwiftUI transitions](#transitions) as well as [Change Effects](#change-effects) that trigger every time a value is updated.

## Change Effects

Change Effects are effects that will trigger a visual or haptic every time a value changes.

Use the `changeEffect` modifier and pass in an `AnyChangeEffect` as well as a value to watch for changes.

```swift
Button {
post.toggleLike()
} label: {
Label(post.likes.formatted(), systemName: "heart.fill")
}
.changeEffect(.spray { heart }, value: post.likes, isEnabled: post.isLiked)
.tint(post.isLiked ? .red : .gray)
```

You can choose from the following Change Effects: [Spray](#spray), [Haptic Feedback](#haptic-feedback), [Jump](#jump), [Ping](#ping), [Rise](#rise), [Shake](#shake), [Shine](#shine), and [Spin](#spin).

### Spray

An effect that emits multiple particles in different shades and sizes moving up from the origin point.

```swift
likeButton
.changeEffect(
.spray(origin: .center) { Image(systemName: "heart.fill") },
value: likes
)
```

- Parameters:
- `origin`: The origin of the particles.
- `particles`: The particles to emit.

```swift
static func spray(origin: UnitPoint = .center, @ViewBuilder _ particles: () -> some View) -> AnyChangeEffect
```

### Haptic Feedback

Triggers the given haptic feedback type whenever a value changes.

- `feedback`: The feedback type beiged triggered.

```swift
static func hapticFeedback(_ feedback: UINotificationFeedbackGenerator.FeedbackType) -> AnyChangeEffect
```

### Jump

Makes the view jump the given height and then bounces a few times before settling.

- `height`: The height of the jump.

```swift
static func jump(height: CGFloat) -> AnyChangeEffect
```

### Ping

Adds one or more shapes that slowly grow and fade-out behind the view.

The shape will be colored by the current tint style.

- Parameters:
- `shape`: The shape to use for the effect.
- `count`: The number of shapes to emit.

```swift
static func ping(shape: some InsettableShape, count: Int) -> AnyChangeEffect
```

An effect that adds one or more shapes that slowly grow and fade-out behind the view.

- Parameters:
- `shape`: The shape to use for the effect.
- `style`: The style to use for the effect.
- `count`: The number of shapes to emit.

```swift
static func ping(shape: some InsettableShape, style: some ShapeStyle, count: Int) -> AnyChangeEffect
```

### Rise

An effect that emits the provided particles from the origin point and slowly float up while moving side to side.

- Parameters:
- `origin`: The origin of the particle.
- `particles`: The particles to emit.

```swift
static func rise(origin: UnitPoint = .center, @ViewBuilder _ particles: () -> some View) -> AnyChangeEffect
```

### Shake

Shakes the view when a change happens.

```swift
static var shake: AnyChangeEffect
```

An effect that shakes the view when a change happens.

- `rate`: The rate of the shake.

```swift
static func shake(rate: ShakeRate) -> AnyChangeEffect
```

### Shine

Highlights the view with a shine moving over the view.

The shine moves from the top leading edge to bottom trailing edge.

```swift
static var shine: AnyChangeEffect
```

### Spin

Spins the view around the given axis when a change happens.

```swift
static var spin: AnyChangeEffect
```

Spins the view around the given axis when a change happens.

- Parameters:
- axis: The x, y and z elements that specify the axis of rotation.
- anchor: The location with a default of center that defines a point in 3D space about which the rotation is anchored.
- anchorZ: The location with a default of 0 that defines a point in 3D space about which the rotation is anchored.
- perspective: The relative vanishing point with a default of 1 / 6 for this rotation.

```swift
static func spin(axis: (x: CGFloat, y: CGFloat, z: CGFloat), anchor: UnitPoint = .center, anchorZ: CGFloat = 0, perspective: CGFloat = 1 / 6) -> AnyChangeEffect
```

## Transitions

All transitions are namespaced under the `movingParts` static variable, e.g.

```swift
myView.transition(.movingParts.anvil)
```

## Anvil
### Anvil

[Preview](https://movingparts.io/pow/#anvil)

A transition that drops the view down from the top.
A transition that drops the view down from the top with matching haptic feedback.

The transition is only performed on insertion and takes 1.4 seconds.

```swift
static var anvil: AnyTransition
```

## Blinds
### Blinds

[Preview](https://movingparts.io/pow/#blinds)

Expand All @@ -57,7 +202,7 @@ Parameters:
static func blinds(slatWidth: CGFloat, style: BlindsStyle = .venetian, isStaggered: Bool = false) -> AnyTransition
```

## Blur
### Blur

[Preview ](https://movingparts.io/pow/#blur)

Expand All @@ -68,7 +213,7 @@ on removal.
static var blur: AnyTransition
```

## Boing
### Boing

[Preview](https://movingparts.io/pow/#boing)

Expand All @@ -86,7 +231,7 @@ any overshoot resulting in an elastic deformation of the view.
static func boing(edge: Edge) -> AnyTransition
```

## Clock
### Clock

[Preview](https://movingparts.io/pow/#clock)

Expand All @@ -104,7 +249,7 @@ A transition using a clockwise sweep around the centerpoint of the view.
static func clock(blurRadius: CGFloat) -> AnyTransition
```

## Flicker
### Flicker

[Preview](https://movingparts.io/pow/#flicker)

Expand All @@ -124,7 +269,7 @@ before settling.
static func flicker(count: Int) -> AnyTransition
```

## Film Exposure
### Film Exposure

[Preview](https://movingparts.io/pow/#film-exposure)

Expand All @@ -135,7 +280,7 @@ from fully visible to completely dark on removal.
static var filmExposure: AnyTransition
```

## Flip
### Flip

[Preview](https://movingparts.io/pow/#flip)

Expand All @@ -149,7 +294,7 @@ removes by rotating the view away from the viewer.
static var flip: AnyTransition
```

## Glare
### Glare

[Preview](https://movingparts.io/pow/#glare)

Expand Down Expand Up @@ -196,7 +341,7 @@ infoBox
static func glare(angle: Angle, color: Color = .white) -> AnyTransition
```

## Iris
### Iris

[Preview](https://movingparts.io/pow/#iris)

Expand All @@ -211,7 +356,7 @@ and a shrinking circle when removing.
static func iris(origin: UnitPoint = .center, blurRadius: CGFloat = 0) -> AnyTransition
```

## Move
### Move

[Preview](https://movingparts.io/pow/#move)

Expand Down Expand Up @@ -244,7 +389,7 @@ Text("Hello")
static func move(angle: Angle) -> AnyTransition
```

## Pop
### Pop

[Preview](https://movingparts.io/pow/#pop)

Expand Down Expand Up @@ -287,7 +432,7 @@ The transition is only performed on insertion.
static func pop<S: ShapeStyle>(_ style: S) -> AnyTransition
```

## Poof
### Poof

[Preview](https://movingparts.io/pow/#poof)

Expand All @@ -299,7 +444,7 @@ The transition is only performed on removal and takes 0.4 seconds.
static var poof: AnyTransition
```

## Rotate3D
### Rotate3D

A transition that inserts by rotating from the specified rotation, and
removes by rotating to the specified rotation in three dimensions.
Expand Down Expand Up @@ -334,7 +479,7 @@ Text("Hello")
static func rotate3D(_ angle: Angle, axis: (x: CGFloat, y: CGFloat, z: CGFloat), anchor: UnitPoint = .center, anchorZ: CGFloat = 0, perspective: CGFloat = 1) -> AnyTransition
```

## Snapshot
### Snapshot

[Preview](https://movingparts.io/pow/#snapshot)

Expand All @@ -345,7 +490,7 @@ from fully visible to completely bright on removal.
static var snapshot: AnyTransition
```

## Skid
### Skid

[Preview](https://movingparts.io/pow/#skid)

Expand All @@ -366,7 +511,7 @@ in an elastic deformation of the view.
static func skid(direction: SkidDirection) -> AnyTransition
```

## Swoosh
### Swoosh

[Preview](https://movingparts.io/pow/#swoosh)

Expand All @@ -377,7 +522,7 @@ during insertion and from the front towards the back during removal.
static var swoosh: AnyTransition
```

## Vanish
### Vanish

[Preview](https://movingparts.io/pow/#vanish)

Expand All @@ -386,7 +531,7 @@ A transition that dissolves the view into many small particles.
The transition is only performed on removal.

> **Note:**
> This transition will use an ease-out animation with a duration of 900ms by default.
> This transition will use an ease-out animation with a duration of 900ms if the current `Animation` is `.default`.
```swift
static var vanish: AnyTransition
Expand All @@ -397,15 +542,30 @@ A transition that dissolves the view into many small particles.
The transition is only performed on removal.

> **Note:**
> This transition will use an ease-out animation with a duration of 900ms by default.
> This transition will use an ease-out animation with a duration of 900ms if the current `Animation` is `.default`.
- Parameter `style`: The style to use for the particles.

```swift
static func vanish<S: ShapeStyle>(_ style: S) -> AnyTransition
```

## Wipe
A transition that dissolves the view into many small particles following a given shape.

The transition is only performed on removal.

> **Note:**
> This transition will use an ease-out animation with a duration of 900ms if the current `Animation` is `.default`.
- Parameter `style`: The style to use for the particles.
- Parameter `mask`: The mask that determines where particles should be placed.
- Parameter `eoFill`: A Boolean that indicates whether the shape is interpreted with the even-odd winding number rule.

```swift
static func vanish<T: ShapeStyle, S: Shape>(_ style: T, mask: S, eoFill: Bool = false) -> AnyTransition
```

### Wipe

[Preview](https://movingparts.io/pow/#wipe)

Expand Down

0 comments on commit 27945b3

Please sign in to comment.