Add To Cart Animation

https://pub.dev/packages/add_to_cart_animation
Admin
A Flutter plugin that provides add-to-cart animations for shopping apps, allowing any widget to be...
Tokens:10,248
Snippets:73
Trust Score:9.9
Update:9 months ago
Show doc for...
Tokens:
Raw
### Flutter Add to Cart Animation Example

Source: https://pub.dev/packages/add_to_cart_animation/versions/2.0.3/example

Demonstrates the usage of the add_to_cart_animation Flutter plugin. It shows how to integrate the animation by setting up GlobalKeys for the cart icon and animating items. This example requires the flutter SDK and the add_to_cart_animation package.

```dart
import 'package:add_to_cart_animation/add_to_cart_animation.dart';
import 'package:flutter/material.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Add To Cart Animation Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Add To Cart Animation Example'),
      debugShowCheckedModeBanner: false,
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);
  final String title;

  @override
  MyHomePageState createState() => MyHomePageState();
}

class MyHomePageState extends State<MyHomePage> {
  GlobalKey<CartIconKey> cartKey = GlobalKey<CartIconKey>();
  late Function(GlobalKey) runAddToCartAnimation;
  var _cartQuantityItems = 0;

  @override
  Widget build(BuildContext context) {
    return AddToCartAnimation(
      cartKey: cartKey,
      height: 30,
      width: 30,
      opacity: 0.85,
      dragAnimation: const DragToCartAnimationOptions(
        rotation: true,
      ),
      jumpAnimation: const JumpAnimationOptions(),
      createAddToCartAnimation: (runAddToCartAnimation) {
        this.runAddToCartAnimation = runAddToCartAnimation;
      },
      child: Scaffold(
        appBar: AppBar(
          title: Text(widget.title),
          centerTitle: false,
          actions: [
            IconButton(
              icon: const Icon(Icons.cleaning_services),
              onPressed: () {
                _cartQuantityItems = 0;
                cartKey.currentState!.runClearCartAnimation();
              },
            ),
            const SizedBox(width: 16),
            AddToCartIcon(
              key: cartKey,
              icon: const Icon(Icons.shopping_cart),
              badgeOptions: const BadgeOptions(
                active: true,
                backgroundColor: Colors.red,
              ),
            ),
            const SizedBox(
              width: 16,
            )
          ],
        ),
        body: ListView(
          children: List.generate(
            15,
            (index) => AppListItem(
              onClick: listClick,
              index: index,
            ),
          ),
        ),
      ),
    );
  }

  void listClick(GlobalKey widgetKey) async {
    await runAddToCartAnimation(widgetKey);
    await cartKey.currentState!.
        runCartAnimation((++_cartQuantityItems).toString());
  }
}

class AppListItem extends StatelessWidget {
  final GlobalKey widgetKey = GlobalKey();
  final int index;
  final void Function(GlobalKey) onClick;

  AppListItem({super.key, required this.onClick, required this.index});
  @override
  Widget build(BuildContext context) {
    Container mandatoryContainer = Container(
      key: widgetKey,
      width: 60,
      height: 60,
      color: Colors.transparent,
      child: Image.network(
        "https://cdn.jsdelivr.net/gh/omerbyrk/add_to_cart_animation/example/assets/apple.png",
        width: 60,
        height: 60,
      ),
    );

    return ListTile(
      onTap: () => onClick(widgetKey),
      leading: mandatoryContainer,
      title: Text(
        "Animated Apple Product Image $index",
      ),
    );
  }
}

```

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

### Flutter Add to Cart Animation Example

Source: https://pub.dev/packages/add_to_cart_animation/versions/1.0.0/example

This example demonstrates the usage of the add_to_cart_animation Flutter plugin. It shows how to set up the AddToCartAnimation widget, configure animation parameters, and trigger the animation when an item is clicked. It requires the 'add_to_cart_animation' and 'flutter/material.dart' packages.

```dart
import 'package:add_to_cart_animation/add_to_cart_animation.dart';
import 'package:add_to_cart_animation/add_to_cart_icon.dart';

import 'package:flutter/material.dart';

import 'list_item.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Add To Cart Animation',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Add To Cart Animation'),
      debugShowCheckedModeBanner: false,
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, required this.title}) : super(key: key);
  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  // We can detech the location of the card by this  GlobalKey<CartIconKey>
  GlobalKey<CartIconKey> gkCart = GlobalKey<CartIconKey>();
  late Function(GlobalKey) runAddToCardAnimation;
  var _cartQuantityItems = 0;

  @override
  Widget build(BuildContext context) {
    return AddToCartAnimation(
      // To send the library the location of the Cart icon
      gkCart: gkCart,
      rotation: true,
      dragToCardCurve: Curves.easeIn,
      dragToCardDuration: const Duration(milliseconds: 1000),
      previewCurve: Curves.linearToEaseOut,
      previewDuration: const Duration(milliseconds: 500),
      previewHeight: 30,
      previewWidth: 30,
      opacity: 0.85,
      initiaJump: false,
      receiveCreateAddToCardAnimationMethod: (addToCardAnimationMethod) {
        // You can run the animation by addToCardAnimationMethod, just pass trough the the global key of  the image as parameter
        this.runAddToCardAnimation = addToCardAnimationMethod;
      },
      child: Scaffold(
        appBar: AppBar(
          title: Text(widget.title),
          centerTitle: false,
          actions: [
            // Improvement/Suggestion 4.4 -> Adding 'clear-cart-button'
            IconButton(
              icon: Icon(Icons.cleaning_services),
              onPressed: () {
                _cartQuantityItems = 0;
                gkCart.currentState!.runClearCartAnimation();
              },
            ),
            SizedBox(width: 16),
            AddToCartIcon(
              key: gkCart,
              icon: Icon(Icons.shopping_cart),
              colorBadge: Colors.red,
            ),
            SizedBox(
              width: 16,
            )
          ],
        ),
        body: ListView(
          children: [
            AppListItem(onClick: listClick, index: 1),
            AppListItem(onClick: listClick, index: 2),
            AppListItem(onClick: listClick, index: 3),
            AppListItem(onClick: listClick, index: 4),
            AppListItem(onClick: listClick, index: 5),
            AppListItem(onClick: listClick, index: 6),
            AppListItem(onClick: listClick, index: 7),
          ],
        ),
      ),
    );
  }

  // Improvement/Suggestion 4.4 -> Running AddTOCartAnimation BEFORE runCArtAnimation
  void listClick(GlobalKey gkImageContainer) async {
    await runAddToCardAnimation(gkImageContainer);
    await gkCart.currentState!.runCartAnimation((++_cartQuantityItems).toString());
  }
}

```

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

### Example pubspec.yaml Dependency Entry

Source: https://pub.dev/packages/add_to_cart_animation/versions/0.0.1/install

This snippet shows how the add_to_cart_animation package will be listed under the dependencies section in your pubspec.yaml file after running the `flutter pub add` command.

```yaml
dependencies:
  add_to_cart_animation: ^0.0.1
```

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

### Flutter Add to Cart Animation Example

Source: https://pub.dev/packages/add_to_cart_animation/example

This Flutter code demonstrates how to use the 'add_to_cart_animation' package to implement an 'add to cart' functionality. It initializes the animation controller, sets up the cart icon, and handles item clicks to trigger the animation. The example includes a list of items, and tapping an item initiates the animation sequence.

```dart
import 'package:add_to_cart_animation/add_to_cart_animation.dart';
import 'package:flutter/material.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Add To Cart Animation Example',
      theme: ThemeData(
        useMaterial3: false,
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Add To Cart Animation Example'),
      debugShowCheckedModeBanner: false,
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);
  final String title;

  @override
  MyHomePageState createState() => MyHomePageState();
}

class MyHomePageState extends State<MyHomePage> {
  // We can detect the location of the cart by this  GlobalKey<CartIconKey>
  GlobalKey<CartIconKey> cartKey = GlobalKey<CartIconKey>();
  late Function(GlobalKey) runAddToCartAnimation;
  var _cartQuantityItems = 0;

  @override
  Widget build(BuildContext context) {
    return AddToCartAnimation(
      // To send the library the location of the Cart icon
      cartKey: cartKey,
      height: 30,
      width: 30,
      opacity: 0.85,
      dragAnimation: const DragToCartAnimationOptions(
        rotation: true,
      ),
      jumpAnimation: const JumpAnimationOptions(),
      createAddToCartAnimation: (runAddToCartAnimation) {
        // You can run the animation by addToCartAnimationMethod, just pass trough the the global key of  the image as parameter
        this.runAddToCartAnimation = runAddToCartAnimation;
      },
      child: Scaffold(
        appBar: AppBar(
          title: Text(widget.title),
          centerTitle: false,
          actions: [
            //  Adding 'clear-cart-button'
            IconButton(
              icon: const Icon(Icons.cleaning_services),
              onPressed: () {
                _cartQuantityItems = 0;
                cartKey.currentState!.runClearCartAnimation();
              },
            ),
            const SizedBox(width: 16),
            AddToCartIcon(
              key: cartKey,
              icon: const Icon(Icons.shopping_cart),
              badgeOptions: const BadgeOptions(
                active: true,
                backgroundColor: Colors.red,
              ),
            ),
            const SizedBox(
              width: 16,
            )
          ],
        ),
        body: ListView(
          children: List.generate(
            15,
            (index) => AppListItem(
              onClick: listClick,
              index: index,
            ),
          ),
        ),
      ),
    );
  }

  void listClick(GlobalKey widgetKey) async {
    await runAddToCartAnimation(widgetKey);
    await cartKey.currentState!
        .runCartAnimation((++_cartQuantityItems).toString());
  }
}

class AppListItem extends StatelessWidget {
  final GlobalKey widgetKey = GlobalKey();
  final int index;
  final void Function(GlobalKey) onClick;

  AppListItem({super.key, required this.onClick, required this.index});
  @override
  Widget build(BuildContext context) {
    //  Container is mandatory. It can hold images or whatever you want
    Container mandatoryContainer = Container(
      key: widgetKey,
      width: 60,
      height: 60,
      color: Colors.transparent,
      child: Image.network(
        "https://cdn.jsdelivr.net/gh/omerbyrk/add_to_cart_animation/example/assets/apple.png",
        width: 60,
        height: 60,
      ),
    );

    return ListTile(
      onTap: () => onClick(widgetKey),
      leading: mandatoryContainer,
      title: Text(
        "Animated Apple Product Image $index",
      ),
    );
  }
}

```

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

### Add Dependency to pubspec.yaml

Source: https://pub.dev/packages/add_to_cart_animation/versions/2.0.0/install

Shows the line that gets added to your project's pubspec.yaml file when you add the add_to_cart_animation dependency. This explicitly lists the package and its version constraint.

```yaml
dependencies:
  add_to_cart_animation: ^2.0.0
```

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

### Flutter Add to Cart Animation Example

Source: https://pub.dev/packages/add_to_cart_animation/versions/0.0.5/example

This Flutter code demonstrates how to integrate the add_to_cart_animation plugin into a simple application. It sets up a basic UI with a list of items and a shopping cart icon, utilizing the plugin to animate the transition of an item from the list to the cart. The `AddToCartAnimation` widget wraps the main content, and `AddToCartIcon` represents the cart. The `runAddToCardAnimation` function is called when an item is clicked to trigger the animation.

```dart
import 'package:add_to_cart_animation/add_to_cart_animation.dart';
import 'package:add_to_cart_animation/add_to_cart_icon.dart';
import 'package:flutter/material.dart';

import 'list_item.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Add To Cart Animation',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Add To Cart Animation'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, required this.title}) : super(key: key);
  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  // We can detech the location of the card by this  GlobalKey<CartIconKey>
  GlobalKey<CartIconKey> gkCart = GlobalKey<CartIconKey>();
  late Function(GlobalKey) runAddToCardAnimation;

  @override
  Widget build(BuildContext context) {
    return AddToCartAnimation(
      // To send the library the location of the Cart icon
      gkCart: gkCart,
      rotation: true,
      dragToCardCurve: Curves.easeIn,
      dragToCardDuration: const Duration(milliseconds: 1000),
      previewCurve: Curves.linearToEaseOut,
      previewDuration: const Duration(milliseconds: 500),
      previewHeight: 30,
      previewWidth: 30,
      opacity: 0.85,
      receiveCreateAddToCardAnimationMethod: (addToCardAnimationMethod) {
        // You can run the animation by addToCardAnimationMethod, just pass trough the the global key of  the image as parameter
        this.runAddToCardAnimation = addToCardAnimationMethod;
      },
      child: Scaffold(
        appBar: AppBar(
          title: Text(widget.title),
          centerTitle: false,
          actions: [
            //
            AddToCartIcon(
              key: gkCart,
              icon: Icon(Icons.shopping_cart),
            ),
            SizedBox(
              width: 16,
            )
          ],
        ),
        body: ListView(
          children: [
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
          ],
        ),
      ),
    );
  }

  void listClick(GlobalKey gkImage) {
    runAddToCardAnimation(gkImage);
  }
}

```

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

### Add to Cart Animation Plugin Example (Flutter)

Source: https://pub.dev/packages/add_to_cart_animation/versions/2.0.3/score

This snippet demonstrates the basic usage of the AddToCartAnimation widget, a core component of the plugin. It shows how to integrate the animation into a Flutter application, likely involving a target widget and a source widget for the animation. No specific input or output is detailed, but it serves as an entry point for utilizing the plugin's functionality.

```dart
/// Example usage of the AddToCartAnimation widget.
/// This is a placeholder for actual example code that would be found in the package's example directory.
/// It demonstrates how to initiate the add to cart animation.

// Assuming AddToCartAnimation and AddToCartIcon are imported from 'package:add_to_cart_animation/add_to_cart_animation.dart';

// Example Widget Structure:
/*
class MyShoppingCartPage extends StatefulWidget {
  @override
  _MyShoppingCartPageState createState() => _MyShoppingCartPageState();
}

class _MyShoppingCartPageState extends State<MyShoppingCartPage>
    with SingleTickerProviderStateMixin {
  late GlobalKey<AddToCartAnimationState> _animatedKey;
  late AddToCartIcon {
    _animatedKey = GlobalKey<AddToCartAnimationState>();
  }

  void _runAddToCartAnimation() {
    _animatedKey.currentState?.run();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Shopping Cart'),
        actions: [
          // Example of AddToCartIcon
          AddToCartIcon(
            icon: const Icon(Icons.shopping_cart),
            badgeCount: 3, // Example badge count
            key: _animatedKey,
          )
        ],
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: _runAddToCartAnimation, // Trigger the animation
          child: Text('Add to Cart'),
        ),
      ),
    );
  }
}
*/

// The actual code would be within the package's example/lib folder.
```

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

### Implement Add to Cart Animation in Flutter

Source: https://pub.dev/packages/add_to_cart_animation/versions/0.0.1/example

This example demonstrates how to use the add_to_cart_animation Flutter package to implement a shopping cart icon and trigger the animation when an item is 'added'. It requires the `add_to_cart_animation` and `flutter/material.dart` packages. The `AddToCartAnimation` widget wraps the main app content, and the `AddToCartIcon` displays the cart. A global key is used to manage the animation state.

```dart
import 'package:add_to_cart_animation/add_to_cart_animation.dart';
import 'package:add_to_cart_animation/add_to_cart_icon.dart';
import 'package:flutter/material.dart';

import 'list_item.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Add To Cart Animation',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Add To Cart Animation'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, required this.title}) : super(key: key);
  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  GlobalKey<CartIconKey> gkCart = GlobalKey<CartIconKey>();
  late Function(GlobalKey) runAddToCardAnimation;

  @override
  Widget build(BuildContext context) {
    return AddToCartAnimation(
      gkCart: gkCart,
      rotation: true,
      receiveCreateAddToCardAnimationMethod: (addToCardAnimationMethod) {
        this.runAddToCardAnimation = addToCardAnimationMethod;
      },
      child: Scaffold(
        appBar: AppBar(
          title: Text(widget.title),
          centerTitle: false,
          actions: [
            AddToCartIcon(
              key: gkCart,
              icon: Icon(Icons.shopping_cart),
            ),
            SizedBox(
              width: 16,
            )
          ],
        ),
        body: ListView(
          children: [
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
            AppListItem(onClick: listClick),
          ],
        ),
      ),
    );
  }

  void listClick(GlobalKey gkImage) {
    runAddToCardAnimation(gkImage);
  }
}

```

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

### Add add_to_cart_animation Dependency to pubspec.yaml

Source: https://pub.dev/packages/add_to_cart_animation/versions/2.0.2/install

This snippet shows how the add_to_cart_animation package is declared as a dependency in a Flutter project's pubspec.yaml file. The caret symbol (^) indicates that any compatible version of 2.0.2 will be used.

```yaml
dependencies:
  add_to_cart_animation: ^2.0.2
```

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

### Add Dependency to pubspec.yaml

Source: https://pub.dev/packages/add_to_cart_animation/versions/1.0

This snippet shows how to add the add_to_cart_animation package as a dependency to your Flutter project's pubspec.yaml file. Ensure you use a compatible version.

```yaml
add_to_cart_animation: ^1.0.1
```

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

### Add add_to_cart_animation Dependency to Flutter Project

Source: https://pub.dev/packages/add_to_cart_animation/versions/0.0.1/install

This command adds the add_to_cart_animation package as a dependency to your Flutter project. It automatically updates your pubspec.yaml file and fetches the package.

```bash
flutter pub add add_to_cart_animation
```

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

### Dart Type Annotation Warning (lib/add_to_cart_icon.dart)

Source: https://pub.dev/packages/add_to_cart_animation/versions/2.0.3/score

This snippet highlights a static analysis warning in the `add_to_cart_icon.dart` file regarding a missing type annotation for the `badgeQuantity` parameter in the `updateBadge` function. This indicates a potential area for improvement in code clarity and maintainability, as explicitly defining types can prevent runtime errors and improve developer understanding. The function is asynchronous and likely handles updating a visual badge count.

```dart
   ╷
98 │   updateBadge(String? badgeQuantity) async {
   │   ^^^^^^^^^^^
   ╵
```

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

### Import add_to_cart_animation Package in Dart Code

Source: https://pub.dev/packages/add_to_cart_animation/versions/0.0.1/install

This import statement allows you to use the functionalities provided by the add_to_cart_animation package within your Dart code. Ensure the package is added as a dependency first.

```dart
import 'package:add_to_cart_animation/add_to_cart_animation.dart';
```

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

### Add Dependency to pubspec.yaml

Source: https://pub.dev/packages/add_to_cart_animation/versions/0.0

This snippet shows how to add the 'add_to_cart_animation' plugin as a dependency to your Flutter project's pubspec.yaml file. Ensure you have a compatible Flutter SDK version.

```yaml
add_to_cart_animation: ^0.0.7
```

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

### Flutter Add to Cart Icon with Badge

Source: https://pub.dev/packages/add_to_cart_animation/score

This code snippet relates to displaying an add-to-cart icon, likely with a quantity badge, using the add_to_cart_animation package. The `updateBadge` function suggests functionality to refresh the badge count. The missing type annotation warning in the analysis indicates a potential area for improvement in the package's code.

```dart
class AddToCartIcon extends StatefulWidget {
  // ... properties ...
}

class _AddToCartIconState extends State<AddToCartIcon> {
  // ... state variables ...

  updateBadge(String? badgeQuantity) async {
    // ... implementation to update the badge ...
  }

  // ... other methods ...
}

```

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

### Flutter Add to Cart Animation Plugin

Source: https://pub.dev/packages/add_to_cart_animation/score

This snippet showcases the basic usage of the add_to_cart_animation Flutter plugin. It is designed to provide an 'add to cart' animation effect. The plugin can be integrated into Flutter applications, particularly those with e-commerce features. No specific input or output is detailed, but it implies visual feedback for user actions.

```dart
import 'package:add_to_cart_animation/add_to_cart_animation.dart';

// ... inside your widget

AddToCartAnimation( 
  // child: your widget that triggers the animation (e.g., a button)
  // Optional: add to cart icon to show badge
  // Optional: duration of animation
  // Optional: onDone callback
)

```
Tokens:
Raw