Skip to content

Latest commit

 

History

History
237 lines (191 loc) · 9.73 KB

README.md

File metadata and controls

237 lines (191 loc) · 9.73 KB
Raw

👏 MediumClapFlutter

Say Thanks! Twitter

A Custom Floating Action Button (FAB) library like clapping effect on Medium.

The source code is 100% Dart, and everything resides in the /lib folder.

Show some ❤️ and star the repo to support the project

GitHub stars GitHub forks GitHub watchers GitHub followers
Twitter Follow

Open Source Love License

YouTube Channel

MTechViral

Facebook Group

Let's Flutter

💻 Installation

In the dependencies: section of your pubspec.yaml, add the following line:

  medium_clap_flutter: <latest_version>

❔ Usage

ClapFAB for Icon

import 'package:medium_clap_flutter/medium_clap_flutter.dart';

class MyWidget extends StatelessWidget {
  Widget build(BuildContext context) {
    return Center(
    //Use this child anywhere in your app
      child: ClapFAB.icon(
        defaultIcon: FontAwesomeIcons.heart,
        filledIcon: FontAwesomeIcons.solidHeart,
        countCircleColor: Colors.green,
        defaultIconColor: Colors.green,
        hasShadow: true,
        sparkleColor: Colors.green,
        shadowColor: Colors.green,
        filledIconColor: Colors.green,
      ),
    );
  }
}

ClapFAB for Image

import 'package:medium_clap_flutter/medium_clap_flutter.dart';

class MyWidget extends StatelessWidget {
  Widget build(BuildContext context) {
    return Center(
    //Use this child anywhere in your app
      child: ClapFAB.image(
        defaultImage: "images/clap.png",
        filledImage: "images/clap.png",
        countCircleColor: Colors.red,
        hasShadow: true,
        sparkleColor: Colors.red,
        shadowColor: Colors.red,
        defaultImageColor: Colors.red,
        filledImageColor: Colors.red,
      ),
    );
  }
}

🎨 Customization and Attributes

All customizable attributes for ClapFab

Attribute Name Default Value Description
defaultIcon/defaultImage Icons.favorite_border/"images/clap.png" The default icon/image of the ClapFab button
filledIcon/filledImage Icons.favorite/"images.clap.png" The filled icon/image after clapping of the ClapFab button
defaultIconColor/defaultImageColor Colors.blue The color of default icon/image of the ClapFab button
filledIconColor/defaultImageColor Colors.blue The filled color of icon/image after clapping of the ClapFab button
hasShadow true Whether to have shadow or not around ClapFab button
countCircleColor Colors.blue The color of count's circle background
countTextColor Colors.white The color of count's circle text
sparkleColor Colors.blue The color of sparkels around the count
shadowColor Colors.blue The color of the shadow
floatingOutlineColor Colors.white The outline color/ border color of the ClabFab button
floatingBgColor Colors.white The Background color of the ClabFab button
initCounter 0 Initial counter value
maxCounter NOT_LIMIT_INCREMENT (-1) Maximum counter value

Clap Count

Use one of this properties clapFabCallback or clapUpCallback to get the clap count

ClapFAB.image(
        clapFabCallback: (int counter)=>print(counter),
      );

OR

ClapFAB.icon(
        clapFabCallback: (int counter)=>print(counter),
      );

OR

ClapFAB.icon(
        clapUpCallback: (int counter)=>print(counter),
      );

📃 Inspired from

💰 Donations

This project needs you! If you would like to support this project's further development, the creator of this project or the continuous maintenance of this project, feel free to donate. Your donation is highly appreciated (and I love food, coffee and beer). Thank you!

PayPal

  • Donate $5: Thank's for creating this project, here's a tea (or some juice) for you!
  • Donate $10: Wow, I am stunned. Let me take you to the movies!
  • Donate $15: I really appreciate your work, let's grab some lunch!
  • Donate $25: That's some awesome stuff you did right there, dinner is on me!
  • Donate $50: I really really want to support this project, great job!
  • Donate $100: You are the man! This project saved me hours (if not days) of struggle and hard work, simply awesome!
  • Donate $2799: Go buddy, buy Macbook Pro for yourself!

Of course, you can also choose what you want to donate, all donations are awesome!

👨 Developed By

Pawan Kumar

GDE (Google Developer Expert) for Flutter. Passionate #Flutter, #Android Developer. #Entrepreneur #YouTuber

👍 How to Contribute

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

📃 License

Copyright (c) 2018 Pawan Kumar

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Getting Started

For help getting started with Flutter, view our online documentation.

For help on editing package code, view the documentation.