Appinio Swiper

https://pub.dev/documentation/appinio_swiper/latest
Admin
Appinio Swiper is a Flutter package that provides a customizable Tinder-style card swiper with...
Tokens:25,370
Snippets:241
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install appinio_swiper Package

Source: https://pub.dev/documentation/appinio_swiper/latest/index.html

Add the appinio_swiper package to your Flutter project's pubspec.yaml file or run the flutter pub add command.

```bash
flutter pub add appinio_swiper
```

--------------------------------

### initialIndex Property

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiper/initialIndex.html

The `initialIndex` property allows you to specify which card the Appinio Swiper should start on. This is particularly useful for initializing the swiper with a specific card visible.

```APIDOC
## initialIndex Property

### Description
The card index to start the swiper at. This field is only considered when initializing an AppinioSwiper. Changing the initialIndex to a swiper that is already built will have no effect. If non-null, must be a value between 0 and cardCount (inclusive). Note that an initial index of cardCount will start the swiper at the end of the stack with no cards left to swipe.

### Type
`int?`

### Default Value
`0`

### Constraints
Must be a value between 0 and `cardCount` (inclusive).

### Implementation Example
```dart
final int? initialIndex;
```
```

--------------------------------

### Basic AppinioSwiper Usage

Source: https://pub.dev/documentation/appinio_swiper/latest/index.html

A basic example of how to implement the AppinioSwiper widget within a Flutter application. It displays a stack of cards with swipe functionality and logs the swipe direction.

```dart
import 'package:appinio_swiper/appinio_swiper.dart';
import 'package:flutter/cupertino.dart';

class Example extends StatelessWidget {

  @override
  Widget build(BuildContext context) {
    return CupertinoPageScaffold(
      child: SizedBox(
        height: MediaQuery
            .of(context)
            .size
            .height * 0.75,
        child: AppinioSwiper(
          cardsCount: 10,
          onSwiping: (AppinioSwiperDirection direction) {
            print(direction.toString());
          },
          cardsBuilder: (BuildContext context, int index) {
            return Container(
              alignment: Alignment.center,
              child: const Text(index.toString()),
              color: CupertinoColors.activeBlue,
            );
          },
        ),
      ),
    );
  }
}
```

--------------------------------

### Declare onSwipeBegin Property

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiper/onSwipeBegin.html

Declare the onSwipeBegin property as an optional callback. This property is used to handle the start of a swipe gesture.

```dart
final OnSwipe? onSwipeBegin;
```

--------------------------------

### Get Activity History

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiperController/activityHistory.html

Retrieves the history of swipes for the currently attached Swiper widget controller.

```APIDOC
## GET /websites/pub_dev_appinio_swiper/activityHistory

### Description
Retrieves the history of swipes for the swiper widget currently attached to this controller. If the history is empty, unswipes will do nothing.

### Method
GET

### Endpoint
/websites/pub_dev_appinio_swiper/activityHistory

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **activityHistory** (List<SwiperActivity>?) - The history of swipes for the swiper widget.

#### Response Example
```json
[
  {
    "type": "like",
    "timestamp": "2023-10-27T10:00:00Z"
  },
  {
    "type": "dislike",
    "timestamp": "2023-10-27T10:05:00Z"
  }
]
```
```

--------------------------------

### Get Card Size

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/SwiperPosition/cardSize.html

Retrieves the pixel size of the top card. This can be used to convert offsets relative to the card size.

```dart
Size get cardSize => _cardSize;
```

--------------------------------

### onSwipeBegin Property

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiper/onSwipeBegin.html

The onSwipeBegin property is a callback that fires when a new swiping activity starts, either through user interaction or programmatic control. It accepts an OnSwipe callback function.

```APIDOC
## onSwipeBegin Property

### Description
Callback that fires with the new swiping activity (eg a user swipes or the controller triggers a programmatic swipe).
See SwiperActivity for a list of activities.

### Type
`OnSwipe?`

### Implementation
```dart
final OnSwipe? onSwipeBegin;
```
```

--------------------------------

### Get Swiper Progress

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/SwiperPosition/progress.html

Calculates the current swiping progress of the top card. This value is 0 when the card is centered and 1 when it is swiped offscreen and about to be dismissed.

```dart
double get progress => max(
      _offsetRelativeToSize.dx.abs(),
      _offsetRelativeToSize.dy.abs(),
    );
```

--------------------------------

### Appinio Swiper initialIndex Property Declaration

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiper/initialIndex.html

Declares the initialIndex property for the Appinio Swiper. This property determines the starting card index and is only effective during the swiper's initialization.

```dart
final int? initialIndex;
```

--------------------------------

### Get Direction Implementation

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/SwiperActivity/direction.html

This getter calculates the direction of movement based on the difference between the end and begin points. It's used internally to determine the swipe axis.

```dart
AxisDirection get direction {
  return (end! - begin!).toAxisDirection();
}
```

--------------------------------

### Get Swipe Progress

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiperController/swipeProgress.html

Retrieves the current position of the card relative to its size, reflecting the user's drag or swipe animation progress. A value of 0 indicates no active swipe, 1 indicates a full swipe in progress, and it resets to 0 upon completion.

```APIDOC
## GET swipeProgress

### Description
Gets the current position of the card as a result of a user drag and/or a swipe animation. This value ranges from 0 (no active swipe) to 1 (full swipe in progress), resetting to 0 when the swipe is complete.

### Method
GET

### Endpoint
/websites/pub_dev_appinio_swiper/swipeProgress

### Parameters
This endpoint does not have any path, query, or request body parameters.

### Response
#### Success Response (200)
- **swipeProgress** (Offset?) - The current position of the card relative to its size.

#### Response Example
```json
{
  "swipeProgress": {
    "dx": 0.5,
    "dy": 0.0
  }
}
```
```

--------------------------------

### Get swipeProgress Offset

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiperController/swipeProgress.html

Retrieves the current swipe progress offset. This value is 0 when no swipe is active, increments to 1 during a swipe, and resets to 0 upon completion. Requires the position property to be available.

```dart
Offset? get swipeProgress {
  return position?._offsetRelativeToSize;
}
```

--------------------------------

### Get Opposite AxisDirection

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/DirectionUtils/opposite.html

Returns the opposite AxisDirection. Use this when you need to invert a direction, for example, when calculating movement in the reverse direction.

```dart
AxisDirection get opposite => switch (this) {
      AxisDirection.up => AxisDirection.down,
      AxisDirection.down => AxisDirection.up,
      AxisDirection.left => AxisDirection.right,
      AxisDirection.right => AxisDirection.left,
    };
```

--------------------------------

### AppinioSwiperController Constructor

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiperController/AppinioSwiperController.html

Initializes a new instance of the AppinioSwiperController.

```APIDOC
## AppinioSwiperController()

### Description

Initializes a new instance of the AppinioSwiperController.

### Method

Constructor

### Endpoint

N/A

### Parameters

N/A

### Request Example

N/A

### Response

N/A
```

--------------------------------

### Get Swiper Position

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiperController/position.html

Retrieves the current position of the swiper.

```APIDOC
## GET /websites/pub_dev_appinio_swiper/position

### Description
Gets the current position of the swiper.

### Method
GET

### Endpoint
/websites/pub_dev_appinio_swiper/position

### Parameters
#### Query Parameters
- **position** (SwiperPosition) - Optional - The position of the swiper.

### Response
#### Success Response (200)
- **position** (SwiperPosition) - The current position of the swiper.
```

--------------------------------

### SwipeOptions Constructors

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/SwipeOptions-class.html

Details on how to instantiate the SwipeOptions class using its various constructors.

```APIDOC
## SwipeOptions Constructors

### SwipeOptions.all()

If top, left, right, bottom all are true/false then simply make the allDirections true.

```dart
const SwipeOptions.all()
```

### SwipeOptions.only()

If horizontal and vertical both are true/false then simply make the allDirections true.

#### Parameters
- **up** (bool) - Optional - Whether swipe up is enabled.
- **down** (bool) - Optional - Whether swipe down is enabled.
- **left** (bool) - Optional - Whether swipe left is enabled.
- **right** (bool) - Optional - Whether swipe right is enabled.

```dart
const SwipeOptions.only({bool up = false, bool down = false, bool left = false, bool right = false})
```

### SwipeOptions.symmetric()

```dart
const SwipeOptions.symmetric({bool horizontal = false, bool vertical = false})
```
```

--------------------------------

### Swipe Constructor Implementation

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/Swipe/Swipe.html

Shows how to implement the Swipe constructor, passing required parameters to the superclass constructor.

```dart
Swipe(
  super.animation,
  {
  required super.begin,
  required super.end,
});
```

--------------------------------

### Get isHorizontal Property

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/DirectionUtils/isHorizontal.html

Returns true if the Swiper is oriented horizontally. This is derived from the isVertical property.

```dart
bool get isHorizontal => !isVertical;
```

--------------------------------

### DrivenActivity Implementation

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/DrivenActivity/DrivenActivity.html

Shows the implementation details of the DrivenActivity constructor, including how it calls the superclass constructor.

```APIDOC
## DrivenActivity Implementation

### Description
This section details the internal implementation of the DrivenActivity constructor, demonstrating how it passes arguments to its superclass.

### Method
Constructor Implementation

### Endpoint
N/A

### Parameters
- **animation** (AnimationController) - Passed to the superclass.
- **curve** (Curve) - Required. Assigned to the `curve` property.
- **begin** (Offset?) - Passed to the superclass.
- **end** (Offset?) - Passed to the superclass.

### Request Example
```dart
DrivenActivity(
  super.animation,
  curve: this.curve,
  begin: super.begin,
  end: super.end,
)
```

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Get currentOffset Property

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/SwiperActivity/currentOffset.html

Retrieves the current offset of the animation. This property is derived from the evaluation of the animation object.

```dart
Offset get currentOffset => evaluate(animation);
```

--------------------------------

### AppinioSwiper Constructor Implementation

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiper/AppinioSwiper.html

Shows the actual implementation of the AppinioSwiper constructor, assigning the provided parameters to the widget's properties and including assertions for valid input values.

```dart
const AppinioSwiper({
  Key? key,
  required this.cardBuilder,
  required this.cardCount,
  this.controller,
  this.initialIndex,
  this.duration = const Duration(milliseconds: 200),
  this.maxAngle = 15,
  this.invertAngleOnBottomDrag = true,
  this.threshold = 50,
  this.backgroundCardCount = 1,
  this.backgroundCardScale = .9,
  this.backgroundCardOffset,
  this.isDisabled = false,
  this.loop = false,
  this.swipeOptions = const SwipeOptions.all(),
  this.onTapDisabled,
  this.onSwipeBegin,
  this.onSwipeEnd,
  this.onCardPositionChanged,
  this.onEnd,
  this.defaultDirection = AxisDirection.right,
  this.allowUnSwipe = true,
  this.allowUnlimitedUnSwipe = true,
  this.onUnSwipe,
  this.onSwipeCancelled,
})  : assert(maxAngle >= 0),
      assert(threshold > 0),
      assert(initialIndex == null ||
          (initialIndex >= 0 && initialIndex <= cardCount)),
      super(key: key);
```

--------------------------------

### Get Swiper Position

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiperController/position.html

Retrieves the current position of the swiper. Ensure a swiper is attached before accessing this property.

```dart
SwiperPosition? get position {
  return _attachedSwiper?._position;
}
```

--------------------------------

### Swipe Class Overview

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/Swipe-class.html

Provides an overview of the Swipe class, its inheritance, and its purpose.

```APIDOC
## Swipe Class
A swipe triggered either by the controller or a user drag.

Inheritance:
* Object
* Animatable<Offset>
* Tween<Offset>
* SwiperActivity
* Swipe
```

--------------------------------

### DrivenActivity Class Overview

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/DrivenActivity-class.html

Provides details about the DrivenActivity class, its inheritance, constructors, properties, and methods.

```APIDOC
## DrivenActivity Class

An animation triggered by AppinioSwiperController.animateTo.

### Inheritance
* Object
* Animatable<Offset>
* Tween<Offset>
* SwiperActivity
* DrivenActivity

### Constructors

#### DrivenActivity

```dart
DrivenActivity(AnimationController animation, {required Curve curve, required Offset? begin, required Offset? end})
```

### Properties

- **animation** → `AnimationController`
  `final` `inherited`

- **begin** ↔ `Offset?`
  The value this variable has at the beginning of the animation.
  `getter/setter pair` `inherited`

- **currentOffset** → `Offset`
  `no setter` `override`

- **curve** → `Curve`
  `final`

- **curvedAnimation** → `Animation<double>`
  `late` `final`

- **direction** → `AxisDirection`
  `no setter` `inherited`

- **end** ↔ `Offset?`
  The value this variable has at the end of the animation.
  `getter/setter pair` `inherited`

- **hashCode** → `int`
  The hash code for this object.
  `no setter` `inherited`

- **runtimeType** → `Type`
  A representation of the runtime type of the object.
  `no setter` `inherited`

### Methods

- **animate**(Animation<double> parent) → `Animation<Offset>`
  Returns a new Animation that is driven by the given animation but that takes on values determined by this object.
  `inherited`

- **chain**(Animatable<double> parent) → `Animatable<Offset>`
  Returns a new Animatable whose value is determined by first evaluating the given parent and then evaluating this object at the result.
  `inherited`

- **evaluate**(Animation<double> animation) → `Offset`
  The current value of this object for the given Animation.
  `inherited`

- **lerp**(double t) → `Offset`
  Returns the value this variable has at the given animation clock value.
  `inherited`

- **noSuchMethod**(Invocation invocation) → `dynamic`
  Invoked when a nonexistent method or property is accessed.
  `inherited`

- **toString**() → `String`
  A string representation of this object.
  `inherited`

- **transform**(double t) → `Offset`
  Returns the interpolated value for the current value of the given animation.
  `inherited`

### Operators

- **operator ==**(Object other) → `bool`
  The equality operator.
  `inherited`
```

--------------------------------

### onEnd Property

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiper/onEnd.html

The `onEnd` property is a callback function that gets executed when the Swiper component has no more cards to display.

```APIDOC
## onEnd Property

### Description
Function that is called when the card stack runs out of cards.

### Type
`VoidCallback?`

### Implementation
```dart
final VoidCallback? onEnd;
```
```

--------------------------------

### Get Swiper cardIndex

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiperController/cardIndex.html

Retrieves the index of the currently displayed card. This property is read-only and updates as cards animate.

```dart
int? get cardIndex {
  return position?.index;
}
```

--------------------------------

### SwiperActivity Class Overview

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/SwiperActivity-class.html

Provides an overview of the SwiperActivity class, its purpose, and its inheritance hierarchy.

```APIDOC
## SwiperActivity Class

An activity that moves the top card with a beginning and an end. All Swiper activities inherit from this class.

### Inheritance
* Object
* Animatable<Offset>
* Tween<Offset>
* SwiperActivity

### Implementers
* CancelSwipe
* DrivenActivity
* Swipe
* Unswipe
```

--------------------------------

### Get Swiper Direction

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/CancelSwipe/direction.html

Retrieves the opposite direction of the Swiper's current axis. This is useful for determining the swipe direction.

```dart
@override
AxisDirection get direction => super.direction.opposite;
```

--------------------------------

### SwipeOptions.all Constructor

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/SwipeOptions/SwipeOptions.all.html

Use this constructor when all swipe directions (up, down, left, right) should be enabled. It's a convenient way to set all directions to true.

```dart
const SwipeOptions.all()
    : up = true,
      down = true,
      left = true,
      right = true;
```

--------------------------------

### DrivenActivity Constructor Implementation

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/DrivenActivity/DrivenActivity.html

Provides the implementation for the DrivenActivity constructor, initializing the animation controller and required parameters.

```dart
DrivenActivity(
  super.animation, {
  required this.curve,
  required super.begin,
  required super.end,
});

```

--------------------------------

### defaultDirection Property

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiper/defaultDirection.html

The defaultDirection property specifies the default direction in which the card gets swiped when triggered by a controller. It defaults to AxisDirection.right.

```APIDOC
## defaultDirection Property

### Description
The default direction in which the card gets swiped when triggered by controller.

### Type
AxisDirection

### Default Value
AxisDirection.right

### Implementation
```dart
final AxisDirection defaultDirection;
```
```

--------------------------------

### AppinioSwiper Constructor

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiper-class.html

This section details the constructor for the AppinioSwiper widget, outlining all the available parameters for customization.

```APIDOC
## AppinioSwiper Constructor

### Description
Initializes a new instance of the AppinioSwiper widget.

### Parameters
#### Constructor Parameters
- **key** (Key?) - Optional - Controls how one widget replaces another widget in the tree.
- **cardBuilder** (IndexedWidgetBuilder) - Required - The indexed widget builder that builds a card for the given index.
- **cardCount** (int) - Required - The number of cards in the stack.
- **controller** (AppinioSwiperController?) - Optional - A controller that provides programmatic control of the swiper and notifies on swiper state changes.
- **initialIndex** (int?) - Optional - The card index to start the swiper at.
- **duration** (Duration) - Optional - The duration of swipe animations. Defaults to `const Duration(milliseconds: 200)`.
- **maxAngle** (double) - Optional - The maximum angle the card reaches while horizontally swiping. Defaults to `15`.
- **invertAngleOnBottomDrag** (bool) - Optional - Sets whether the card should angle in the opposite direction when it is dragged from the bottom half. Defaults to `true`.
- **threshold** (double) - Optional - The minimum distance a user has to pan the card before triggering a swipe animation. Defaults to `50`.
- **backgroundCardCount** (int) - Optional - Background cards count. Defaults to `1`.
- **backgroundCardScale** (double) - Optional - The amount to scale each successive background card down by. Defaults to `0.9`.
- **backgroundCardOffset** (Offset?) - Optional - The amount to offset each successive background card relative to the card before it.
- **isDisabled** (bool) - Optional - Set to true to disable swiping. Defaults to `false`.
- **loop** (bool) - Optional - Set to true if you want the card stack to loop back to the beginning when the user swipes to the end. Defaults to `false`.
- **swipeOptions** (SwipeOptions) - Optional - What swipe directions to allow. Defaults to `const SwipeOptions.all()`.
- **onTapDisabled** (VoidCallback?) - Optional - Function that is called when a user attempts to swipe but swiping is disabled.
- **onSwipeBegin** (OnSwipe?) - Optional - Callback that fires with the new swiping activity (e.g., a user swipes or the controller triggers a programmatic swipe).
- **onSwipeEnd** (OnSwipe?) - Optional - Callback that fires with a swipe activity after the activity is complete.
- **onCardPositionChanged** (void Function(SwiperPosition position)?) - Optional - A callback that is called with the card's SwiperPosition whenever the position changes.
- **onEnd** (VoidCallback?) - Optional - Function that is called when the card stack runs out of cards.
- **defaultDirection** (AxisDirection) - Optional - The default direction in which the card gets swiped when triggered by controller. Defaults to `AxisDirection.right`.
- **allowUnSwipe** (bool) - Optional - Allow unswipe. Defaults to `true`.
- **allowUnlimitedUnSwipe** (bool) - Optional - Allow unlimited unswipe. Defaults to `true`.
- **onUnSwipe** (void Function(SwiperActivity activity)?) - Optional - This callback is called when user unswipe the card.
- **onSwipeCancelled** (void Function(SwiperActivity activity)?) - Optional - This callback is called when user cancels the swipe before reaching threshold.
```

--------------------------------

### Get Offset Property

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/SwiperPosition/offset.html

Retrieves the current offset of the card at the top of the stack. This getter is used to access the private _offset variable.

```dart
Offset get offset => _offset;
```

--------------------------------

### Right Property Implementation

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/SwipeOptions/right.html

This snippet shows the implementation of the 'right' property in the Appinio Swiper.

```APIDOC
## Right Property

### Description
Controls the right alignment behavior of the Appinio Swiper.

### Method
N/A (This is a property definition)

### Endpoint
N/A (This is a property definition)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A

## Implementation
```dart
final bool right;
```
```

--------------------------------

### Get Swiper Activity

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiperController/swipeActivity.html

Retrieve the current activity of the swiper. This property is non-null when the user finishes a drag or a programmatic swipe is initiated.

```dart
SwiperActivity? get swipeActivity {
  return _attachedSwiper?._swipeActivity;
}
```

--------------------------------

### Appinio Swiper Basic Parameters

Source: https://pub.dev/documentation/appinio_swiper/latest/index.html

This section outlines the basic parameters available for configuring the Appinio Swiper widget.

```APIDOC
## Appinio Swiper Basic Configuration

### Description
Configures the fundamental properties of the Appinio Swiper widget, such as the number of cards, background card appearance, and swipe behavior.

### Parameters
#### Query Parameters
- **cardCount** (int) - Required - Number of cards you want to render.
- **backgroundCardCount** (int) - Optional - Number of cards you want to render in background. Default: 1
- **backgroundCardScale** (double) - Optional - Scale factor for the background card. Default: .9
- **backgroundCardOffset** (double) - Optional - Offset for the background card.
- **cardBuilder** (CardsBuilder) - Required - Callback of the type CardsBuilder.
- **swipeOptions** (AppinioSwipeOptions) - Optional - Value of type AppinioSwipeOptions to restrict swipes.
- **invertAngleOnBottomDrag** (bool) - Optional - Sets whether the card should angle in the opposite direction when it is dragged from the bottom half. Default: true
- **controller** (AppinioSwiperController) - Optional - Trigger swipe, unSwipe and animateTo.
- **padding** (EdgeInsets) - Optional - Control swiper padding. Default: EdgeInsets.symmetric(horizontal: 20, vertical: 25)
- **duration** (Duration) - Optional - The duration that every animation should last. Default: 200 milliseconds
- **cardsSpacing** (double) - Optional - The spacing between background cards. Default: 40
- **maxAngle** (double) - Optional - Maximum angle the card reaches while swiping. Default: 30
- **threshold** (double) - Optional - Threshold from which the card is swiped away. Default: 50
- **isDisabled** (bool) - Optional - Set to `true` if swiping should be disabled, has no impact when triggered from the outside. Default: false
- **onTapDisabled** (Function) - Optional - Function that get triggered when the swiper is disabled.
- **onSwipeBegin** (Function) - Optional - Called when user starts to swipe a card.
- **onSwipeEnd** (Function) - Optional - Called when swipe action completes.
- **onCardPositionChanged** (Function) - Optional - Called when card position changes.
- **onEnd** (Function) - Optional - Called when there is no Widget left to be swiped away.
- **defaultDirection** (AxisDirection) - Optional - Direction in which the card is swiped away when triggered from the outside. Default: right
- **allowUnswipe** (bool) - Optional - Set to `false` if unswipe should be disabled away. Default: true
- **unlimitedUnswipe** (bool) - Optional - Set to `true` if the user can unswipe as many cards as possible. Default: false
- **onUnswipe** (Function) - Optional - Called with the boolean `true` when the last card gets unswiped and with the boolean `false` if there is no card to unswipe.
- **onSwipeCancelled** (Function) - Optional - Gets called when the user leaves the card before the threshold is reached.
```

--------------------------------

### SwiperPosition Constructor Parameters

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/SwiperPosition/SwiperPosition.html

Defines the parameters required for initializing SwiperPosition, including card size, count, drag thresholds, and loop behavior.

```dart
SwiperPosition({
  1. required Size cardSize,
  2. required int cardCount,
  3. required double threshold,
  4. required double maxAngleRadians,
  5. required bool invertAngleOnBottomDrag,
  6. required bool loop,
  7. required int? initialIndex,

})
```

--------------------------------

### Offset Property

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/SwiperPosition/offset.html

The offset property determines the position of the card at the top of the Swiper stack. You can get the current offset or set a new one.

```APIDOC
## Offset Property

### Description
Gets the current offset of the card on the top of the stack.

### Method
GET

### Endpoint
`/websites/pub_dev_appinio_swiper/offset`

### Parameters
None

### Response
#### Success Response (200)
- **offset** (Offset) - The current offset of the top card.

#### Response Example
```json
{
  "offset": {
    "dx": 10.0,
    "dy": 20.0
  }
}
```

## Set Offset Property

### Description
Sets a new offset for the card on the top of the stack and notifies listeners of the change.

### Method
SET

### Endpoint
`/websites/pub_dev_appinio_swiper/offset`

### Parameters
#### Request Body
- **newOffset** (Offset) - Required - The new offset value to apply.

### Request Example
```json
{
  "newOffset": {
    "dx": 15.0,
    "dy": 25.0
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Indicates the offset has been updated.

#### Response Example
```json
{
  "message": "Offset updated successfully."
}
```
```

--------------------------------

### Unswipe Constructor

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/Unswipe/Unswipe.html

Details the Unswipe constructor, its parameters, and implementation.

```APIDOC
## Unswipe Constructor

### Description
Initializes an Unswipe object with an animation controller and a starting offset.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Constructor Signature
```dart
Unswipe(
  AnimationController animation,
  {
    required Offset? begin,
  }
)
```

### Implementation
```dart
Unswipe(
  super.animation,
  {
    required super.begin,
  }
) : super(end: Offset.zero);
```

### Request Example
None

### Response
None
```

--------------------------------

### Get Rotation Angle in Radians

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/SwiperPosition/angleRadians.html

Use this getter to retrieve the rotation angle of the card in radians. It converts the 'angle' property from degrees to radians.

```dart
double get angleRadians => angle * (pi / 180);
```

--------------------------------

### Get Swiper Activity History

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiperController/activityHistory.html

Retrieves the list of past swipe activities for the attached swiper. Returns an empty list if no swipes have occurred.

```dart
Future<List<SwiperActivity>?> get activityHistory async {
  return _attachedSwiper?._activityHistory.toList(growable: false);
}
```

--------------------------------

### Swipe Constructors

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/Swipe-class.html

Details the available constructors for the Swipe class.

```APIDOC
## Constructors

### Swipe
```dart
Swipe(AnimationController animation, {required Offset? begin, required Offset? end})
```
```

--------------------------------

### Swipe Methods

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/Swipe-class.html

Details the methods available in the Swipe class.

```APIDOC
## Methods

### animate
* **Signature**: `Animation<Offset> animate(Animation<double> parent)`
* **Description**: Returns a new Animation that is driven by the given animation but that takes on values determined by this object.

### chain
* **Signature**: `Animatable<Offset> chain(Animatable<double> parent)`
* **Description**: Returns a new Animatable whose value is determined by first evaluating the given parent and then evaluating this object at the result.

### evaluate
* **Signature**: `Offset evaluate(Animation<double> animation)`
* **Description**: The current value of this object for the given Animation.

### lerp
* **Signature**: `Offset lerp(double t)`
* **Description**: Returns the value this variable has at the given animation clock value.

### noSuchMethod
* **Signature**: `dynamic noSuchMethod(Invocation invocation)`
* **Description**: Invoked when a nonexistent method or property is accessed.

### toString
* **Signature**: `String toString()`
* **Description**: A string representation of this object.

### transform
* **Signature**: `Offset transform(double t)`
* **Description**: Returns the interpolated value for the current value of the given animation.
```

--------------------------------

### SwipeOptions.all Constructor

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/SwipeOptions/SwipeOptions.all.html

The SwipeOptions.all() constructor is a convenience constructor that sets all directional swipe options (up, down, left, right) to true. This is useful when you want to enable swiping in all directions simultaneously.

```APIDOC
## SwipeOptions.all Constructor

### Description

A convenience constructor for `SwipeOptions` that sets all directional swipe options (up, down, left, right) to true. This is used when all directions are intended to be enabled.

### Method

Constructor

### Endpoint

N/A (Class Constructor)

### Parameters

N/A

### Request Body

N/A

### Request Example

```dart
const SwipeOptions.all();
```

### Response

N/A (Constructor)

### Implementation Details

When `SwipeOptions.all()` is called, it initializes the following properties to `true`:

- `up`
- `down`
- `left`
- `right`

This is equivalent to manually setting each of these properties to `true`.
```

--------------------------------

### SwipeOptions Methods and Operators

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/SwipeOptions-class.html

Details on the available methods and operators for the SwipeOptions class.

```APIDOC
## SwipeOptions Methods and Operators

### noSuchMethod()

- **Parameters**: 
  - **invocation** (Invocation) - The invocation details.
- **Returns**: dynamic
- **Description**: Invoked when a nonexistent method or property is accessed.
- **Inherited**: true

### toString()

- **Returns**: String
- **Description**: A string representation of this object.
- **Inherited**: true

### operator ==()

- **Parameters**: 
  - **other** (Object) - The object to compare with.
- **Returns**: bool
- **Description**: The equality operator.
- **Inherited**: true
```

--------------------------------

### Get Current Offset with Curved Animation

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/DrivenActivity/currentOffset.html

Use this getter to retrieve the current offset value, which is determined by evaluating a curved animation. Ensure the `curvedAnimation` is properly initialized.

```dart
@override
Offset get currentOffset => evaluate(curvedAnimation);
```

--------------------------------

### Unswipe Class Overview

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/Unswipe-class.html

Details about the Unswipe class, its purpose, and inheritance hierarchy.

```APIDOC
## Unswipe Class

An unswipe which undoes the last Swipe activity. Can only be triggered by AppinioSwiperController.

### Inheritance
* Object
* Animatable<Offset>
* Tween<Offset>
* SwiperActivity
* Unswipe
```

--------------------------------

### SwiperActivity Methods

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/SwiperActivity-class.html

Details the methods available within the SwiperActivity class.

```APIDOC
## Methods

### animate(Animation<double> parent) → Animation<Offset>
     Returns a new Animation that is driven by the given animation but that takes on values determined by this object.

### chain(Animatable<double> parent) → Animatable<Offset>
     Returns a new Animatable whose value is determined by first evaluating the given parent and then evaluating this object at the result.

### evaluate(Animation<double> animation) → Offset
     The current value of this object for the given Animation.

### lerp(double t) → Offset
     Returns the value this variable has at the given animation clock value.

### noSuchMethod(Invocation invocation) → dynamic
     Invoked when a nonexistent method or property is accessed.

### toString() → String
     A string representation of this object.

### transform(double t) → Offset
     Returns the interpolated value for the current value of the given animation.
```

--------------------------------

### SwiperPosition Constructor Implementation

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/SwiperPosition/SwiperPosition.html

The implementation of the SwiperPosition constructor, initializing private fields with provided arguments and setting a default initial index.

```dart
SwiperPosition({
  required Size cardSize,
  required int cardCount,
  required double threshold,
  required double maxAngleRadians,
  required bool invertAngleOnBottomDrag,
  required bool loop,
  required int? initialIndex,
})  : _cardSize = cardSize,
      _cardCount = cardCount,
      _threshold = threshold,
      _maxAngle = maxAngleRadians,
      _invertAngleOnBottomDrag = invertAngleOnBottomDrag,
      _loop = loop,
      _baseIndex = initialIndex ?? 0;
```

--------------------------------

### Curve Property Implementation

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/DrivenActivity/curve.html

Explains the implementation of the 'curve' property within the Appinio Swiper component.

```APIDOC
## Curve Property

### Description
Represents the curve used for animations or transitions within the Swiper component.

### Type
`Curve`

### Implementation
```dart
final Curve curve;
```
```

--------------------------------

### Get progressRelativeToThreshold

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/SwiperPosition/progressRelativeToThreshold.html

Calculates the current swiping progress relative to the swiping threshold. Returns the absolute value of the horizontal offset if it's greater than the vertical offset, otherwise returns the vertical offset.

```dart
double get progressRelativeToThreshold {
  final Offset offset = _offsetRelativeToThreshold;
  if (offset.dx.abs() > offset.dy) {
    return offset.dx;
  }
  return offset.dy;
}
```

--------------------------------

### Get Rotation Angle - AppinioSwiper

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/SwiperPosition/angle.html

Calculates the current rotation angle of the card based on user drag offset and card size. It can invert the angle if dragging from the bottom half of the card and `_invertAngleOnBottomDrag` is true.

```dart
double get angle {
  // If we allow inverting the direction and the user is dragging from the
  // bottom half of the card, angle in the opposite direction.
  final direction = _invertAngleOnBottomDrag &&
          _rotationAlignment != null &&
          _rotationAlignment!.y > 0
      ? -1
      : 1;
  return (direction * _maxAngle * (_offset.dx / _cardSize.width))
      .clamp(-_maxAngle, _maxAngle);
}
```

--------------------------------

### SwiperPosition Class Overview

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/SwiperPosition-class.html

Provides details about the SwiperPosition class, its purpose, and how it relates to the AppinioSwiperController.

```APIDOC
## SwiperPosition Class

### Description
The position of the swiper. This includes the current card index and the offset and rotations applied to the top card. You can use this position to coordinate custom animations with the swiper state. The swiper position is exposed by AppinioSwiperController.

### Mixed-in types
* ChangeNotifier

### Constructors
SwiperPosition({
  required Size cardSize,
  required int cardCount,
  required double threshold,
  required double maxAngleRadians,
  required bool invertAngleOnBottomDrag,
  required bool loop,
  required int? initialIndex
})

### Properties
- **angle** (double) - The rotation angle of the card in degrees. (no setter)
- **angleRadians** (double) - The rotation angle of the card in radians. (no setter)
- **cardSize** (Size) - The pixel size of the top card. (no setter)
- **hashCode** (int) - The hash code for this object. (no setter, inherited)
- **hasListeners** (bool) - Whether any listeners are currently registered. (no setter, inherited)
- **index** (int) - The current index of the swiper. (no setter)
- **offset** (Offset) - The offset of the card on the top of the stack. (getter/setter pair)
- **progress** (double) - The current swiping progress of the top card. (no setter)
- **progressRelativeToThreshold** (double) - The current swiping progress relative to the swiping threshold. (no setter)
- **runtimeType** (Type) - A representation of the runtime type of the object. (no setter, inherited)

### Methods
- **addListener** (void Function(VoidCallback listener)) - Register a closure to be called when the object changes. (inherited)
- **dispose** (void Function()) - Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed). (inherited)
- **noSuchMethod** (dynamic Function(Invocation invocation)) - Invoked when a nonexistent method or property is accessed. (inherited)
- **notifyListeners** (void Function()) - Call all the registered listeners. (inherited)
- **removeListener** (void Function(VoidCallback listener)) - Remove a previously registered closure from the list of closures that are notified when the object changes. (inherited)
- **toString** (String Function()) - A string representation of this object. (inherited)

### Operators
- **operator ==** (bool Function(Object other)) - The equality operator. (inherited)
```

--------------------------------

### AppinioSwiper Constructor

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiper/AppinioSwiper.html

The AppinioSwiper widget constructor allows for extensive customization of the swipeable card interface. Below are the parameters available for configuration.

```APIDOC
## AppinioSwiper Constructor

### Description
Initializes a new instance of the AppinioSwiper widget with customizable options.

### Method
Constructor

### Parameters
#### Constructor Parameters
- **key** (Key?) - Optional - An object that identifies the widget.
- **cardBuilder** (IndexedWidgetBuilder) - Required - A builder function that creates the widget for each card.
- **cardCount** (int) - Required - The total number of cards in the swiper.
- **controller** (AppinioSwiperController?) - Optional - A controller to manage the swiper's state and actions.
- **initialIndex** (int?) - Optional - The index of the initially visible card. Defaults to 0 if not provided.
- **duration** (Duration) - Optional - The duration of the swipe animation. Defaults to 200 milliseconds.
- **maxAngle** (double) - Optional - The maximum angle the card can rotate during a swipe. Defaults to 15.
- **invertAngleOnBottomDrag** (bool) - Optional - Whether to invert the rotation angle when dragging from the bottom. Defaults to true.
- **threshold** (double) - Optional - The swipe threshold in pixels. Defaults to 50.
- **backgroundCardCount** (int) - Optional - The number of background cards to display behind the active card. Defaults to 1.
- **backgroundCardScale** (double) - Optional - The scale factor for background cards. Defaults to 0.9.
- **backgroundCardOffset** (Offset?) - Optional - The offset for positioning background cards.
- **isDisabled** (bool) - Optional - Whether the swiper is disabled. Defaults to false.
- **loop** (bool) - Optional - Whether the swiper should loop back to the beginning after the last card. Defaults to false.
- **swipeOptions** (SwipeOptions) - Optional - Configuration for swipe gestures. Defaults to all swipe options enabled.
- **onTapDisabled** (VoidCallback?) - Optional - Callback function when tapping on a disabled swiper.
- **onSwipeBegin** (OnSwipe?) - Optional - Callback function when a swipe gesture begins.
- **onSwipeEnd** (OnSwipe?) - Optional - Callback function when a swipe gesture ends.
- **onCardPositionChanged** (void Function(SwiperPosition position)?) - Optional - Callback function when the position of a card changes.
- **onEnd** (VoidCallback?) - Optional - Callback function when the swiper reaches the end of the cards.
- **defaultDirection** (AxisDirection) - Optional - The default direction for swipes. Defaults to AxisDirection.right.
- **allowUnSwipe** (bool) - Optional - Whether unswiping is allowed. Defaults to true.
- **allowUnlimitedUnSwipe** (bool) - Optional - Whether unlimited unswiping is allowed. Defaults to true.
- **onUnSwipe** (void Function(SwiperActivity activity)?) - Optional - Callback function when a card is unswiped.
- **onSwipeCancelled** (void Function(SwiperActivity activity)?) - Optional - Callback function when a swipe is cancelled.

### Assertions
- `maxAngle` must be greater than or equal to 0.
- `threshold` must be greater than 0.
- `initialIndex` must be null or between 0 and `cardCount` (inclusive).

### Request Example
```dart
AppinioSwiper(
  cardBuilder: (context, index) => CardWidget(index: index),
  cardCount: 10,
  // Other optional parameters...
)
```

### Response
This is a constructor, so there is no direct response in terms of data. The widget is built and rendered based on the provided parameters.
```

--------------------------------

### Swipe Constructor

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/Swipe/Swipe.html

The Swipe constructor initializes a swipe animation with specified animation controller, begin, and end offsets.

```APIDOC
## Swipe Constructor

### Description
Initializes a swipe animation.

### Method
Constructor

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **animation** (AnimationController) - The animation controller for the swipe.
- **begin** (Offset?) - The starting offset of the swipe. Required.
- **end** (Offset?) - The ending offset of the swipe. Required.

### Request Example
```dart
Swipe(
  super.animation,
  begin: Offset(0.0, 1.0),
  end: Offset(0.0, 0.0),
);
```

### Response
#### Success Response (200)
N/A (Constructor)

#### Response Example
N/A (Constructor)
```

--------------------------------

### Get Current Swiper Index

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/SwiperPosition/index.html

Retrieves the current index of the swiper. This value updates after a SwiperActivity is completely finished. If AppinioSwiper.loop is true, the index wraps to 0 at the end of the stack; otherwise, it equals the stack length when finished.

```dart
int get index => _baseIndexToEffectiveIndex(_baseIndex);
```

--------------------------------

### onTapDisabled Property

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiper/onTapDisabled.html

The onTapDisabled property is a callback function that gets invoked when a user tries to swipe the Appinio Swiper component, but the swiping functionality is currently disabled. This is useful for providing user feedback or triggering alternative actions when swiping is not permitted.

```APIDOC
## onTapDisabled Property

### Description

Function that is called when a user attempts to swipe but swiping is disabled.

### Type

`VoidCallback?`

### Modifiers

`final`

### Implementation Example

```dart
final VoidCallback? onTapDisabled;
```
```

--------------------------------

### toAlignment Method

Source: https://pub.dev/documentation/appinio_swiper/latest/enums/OffsetUtils/toAlignment.html

Converts a Size object to an Alignment object.

```APIDOC
## toAlignment Method

### Description
Converts a Size object to an Alignment object based on internal dx and dy values.

### Method
N/A (This is a utility method, not an API endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Alignment** (Alignment) - The calculated Alignment object.

#### Response Example
```dart
// Example of how the method might be called and what it returns
Size mySize = Size(100.0, 200.0);
// Assuming dx and dy are accessible or part of the class context
// Alignment calculatedAlignment = toAlignment(mySize);
// print(calculatedAlignment);
```

## Implementation
```dart
Alignment toAlignment(
  Size size
) {
  return Alignment(
    2 * (dx / size.width) - 1,
    2 * (dy / size.height) - 1,
  );
}
```
```

--------------------------------

### AppinioSwiper Constructor Definition

Source: https://pub.dev/documentation/appinio_swiper/latest/appinio_swiper/AppinioSwiper/AppinioSwiper.html

Defines the parameters available for the AppinioSwiper constructor, including required widgets, counts, controllers, and various customization options for swipe behavior and appearance.

```dart
const AppinioSwiper({
  1. Key? key, 
  2. required IndexedWidgetBuilder cardBuilder, 
  3. required int cardCount, 
  4. AppinioSwiperController? controller,
  5. int? initialIndex,
  6. Duration duration = const Duration(milliseconds: 200),
  7. double maxAngle = 15,
  8. bool invertAngleOnBottomDrag = true,
  9. double threshold = 50,
  10. int backgroundCardCount = 1,
  11. double backgroundCardScale = .9,
  12. Offset? backgroundCardOffset,
  13. bool isDisabled = false,
  14. bool loop = false,
  15. SwipeOptions swipeOptions = const SwipeOptions.all(),
  16. VoidCallback? onTapDisabled,
  17. OnSwipe? onSwipeBegin,
  18. OnSwipe? onSwipeEnd,
  19. void onCardPositionChanged(
    1. SwiperPosition position
)?,
  20. VoidCallback? onEnd,
  21. AxisDirection defaultDirection = AxisDirection.right,
  22. bool allowUnSwipe = true,
  23. bool allowUnlimitedUnSwipe = true,
  24. void onUnSwipe(
    1. SwiperActivity activity
)?,
  25. void onSwipeCancelled(
    1. SwiperActivity activity
)?,

})
```
Tokens:
Raw