Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iampawan/MediumClapFlutter
A Custom Floating Action Button (FAB) library like clapping effect on Medium
https://github.com/iampawan/MediumClapFlutter
dart flutter flutter-package flutter-plugin
Last synced: 3 months ago
JSON representation
A Custom Floating Action Button (FAB) library like clapping effect on Medium
- Host: GitHub
- URL: https://github.com/iampawan/MediumClapFlutter
- Owner: iampawan
- License: mit
- Created: 2018-07-23T19:02:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-08T16:36:09.000Z (over 4 years ago)
- Last Synced: 2024-06-21T10:37:35.780Z (5 months ago)
- Topics: dart, flutter, flutter-package, flutter-plugin
- Language: Dart
- Size: 26.4 KB
- Stars: 141
- Watchers: 6
- Forks: 20
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 👏 MediumClapFlutter
[](https://saythanks.io/to/iampawan) [](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fiampawan%2FMediumClapFlutter)
A Custom Floating Action Button (FAB) library like clapping effect on Medium.
The source code is **100% Dart**, and everything resides in the [/lib](https://github.com/iampawan/MediumClapFlutter/tree/master/lib) folder.
### Show some :heart: and star the repo to support the project
[](https://github.com/iampawan/MediumClapFlutter) [](https://github.com/iampawan/MediumClapFlutter/fork) [](https://github.com/iampawan/MediumClapFlutter) [](https://github.com/iampawan/MediumClapFluttert)
[](https://twitter.com/imthepk)
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/iampawan/MediumClapFlutter/blob/master/LICENSE)
## YouTube Channel
[MTechViral](https://www.youtube.com/c/MTechViral)
## Facebook Group
[Let's Flutter](https://www.facebook.com/groups/425920117856409/)
## 💻 Installation
In the `dependencies:` section of your `pubspec.yaml`, add the following line:
```yaml
medium_clap_flutter:
```
## ❔ Usage
### ClapFAB for Icon
```dart
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
```dart
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
```dart
ClapFAB.image(
clapFabCallback: (int counter)=>print(counter),
);
```
OR
```dart
ClapFAB.icon(
clapFabCallback: (int counter)=>print(counter),
);
```
OR
```dart
ClapFAB.icon(
clapUpCallback: (int counter)=>print(counter),
);
```
## 📃 Inspired from
* Medium Clap By Kartik Sharma [https://github.com/Kartik1607/FlutterUI/tree/master/MediumClapAnimation/medium_clap](https://github.com/Kartik1607/FlutterUI/tree/master/MediumClapAnimation/medium_clap)
* MediumClap-Android By Wajahat Karim [https://github.com/wajahatkarim3/MediumClap-Android](https://github.com/wajahatkarim3/MediumClap-Android)
## 💰 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](https://www.paypal.me/imthepk/5)**: Thank's for creating this project, here's a tea (or some juice) for you!
* **[Donate $10](https://www.paypal.me/imthepk/10)**: Wow, I am stunned. Let me take you to the movies!
* **[Donate $15](https://www.paypal.me/imthepk/15)**: I really appreciate your work, let's grab some lunch!
* **[Donate $25](https://www.paypal.me/imthepk/25)**: That's some awesome stuff you did right there, dinner is on me!
* **[Donate $50](https://www.paypal.me/imthepk/50)**: I really really want to support this project, great job!
* **[Donate $100](https://www.paypal.me/imthepk/100)**: You are the man! This project saved me hours (if not days) of struggle and hard work, simply awesome!
* **[Donate $2799](https://www.paypal.me/imthepk/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](https://flutter.io/).
For help on editing package code, view the [documentation](https://flutter.io/developing-packages/).