Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iampawan/pkskeleton

A Facebook & Twitter Like Card Loading Shimmer Skeleton Library.
https://github.com/iampawan/pkskeleton

dart flutter package

Last synced: 4 days ago
JSON representation

A Facebook & Twitter Like Card Loading Shimmer Skeleton Library.

Awesome Lists containing this project

README

        

# PKSkeleton

[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/iampawan) [![Twitter](https://img.shields.io/twitter/url/https/github.com/iampawan/PKSkeleton.svg?style=social)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fiampawan%2FPKSkeleton)

A Facebook & Twitter Like Card Loading Shimmer Skeleton Library.

The source code is **100% Dart**, and everything resides in the [/lib](https://github.com/iampawan/PKSkeleton/tree/master/lib) folder.

### Show some :heart: and star the repo to support the project

[![GitHub stars](https://img.shields.io/github/stars/iampawan/PKSkeleton.svg?style=social&label=Star)](https://github.com/iampawan/PKSkeleton) [![GitHub forks](https://img.shields.io/github/forks/iampawan/PKSkeleton.svg?style=social&label=Fork)](https://github.com/iampawan/PKSkeleton/fork) [![GitHub watchers](https://img.shields.io/github/watchers/iampawan/PKSkeleton.svg?style=social&label=Watch)](https://github.com/iampawan/PKSkeleton) [![GitHub followers](https://img.shields.io/github/followers/iampawan.svg?style=social&label=Follow)](https://github.com/iampawan/BreathingFlutter)
[![Twitter Follow](https://img.shields.io/twitter/follow/imthepk.svg?style=social)](https://twitter.com/imthepk)

[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=102)](https://opensource.org/licenses/Apache-2.0)

## YouTube Channel

[MTechViral](https://www.youtube.com/c/MTechViral)

## Facebook Group

[Let's Flutter With Dart](https://www.facebook.com/groups/425920117856409/)

## 💻 Installation

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

```yaml
pk_skeleton:
```

## ❔ Usage

## Light Theme

### PKCardSkeleton

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

//Widget
PKCardSkeleton(
isCircularImage: true,
isBottomLinesActive: true,
)

```

### PKCardListSkeleton

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

//Widget
PKCardListSkeleton(
isCircularImage: true,
isBottomLinesActive: true,
length: 10,
)

```

### PKCardProfileSkeleton

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

//Widget
PKCardProfileSkeleton(
isCircularImage: true,
isBottomLinesActive: true,
)

```
### PKCardPageSkeleton

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

//Widget
PKCardPageSkeleton(
totalLines: 5,
)

```

## Dark Theme

To use dark theme in your app.
Simply provide brightness to dark in your Material App Widget or use Theme Widget.

Enable Dark Theme

```
ThemeData(
brightness: Brightness.dark,
),
```

### PKDarkCardSkeleton

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

//Widget
PKDarkCardSkeleton(
isCircularImage: true,
isBottomLinesActive: true,
)

```
### PKDarkCardListSkeleton

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

//Widget
PKDarkCardListSkeleton(
isCircularImage: true,
isBottomLinesActive: true,
length: 10,
)

```

### PKDarkCardProfileSkeleton

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

//Widget
PKDarkCardProfileSkeleton(
isCircularImage: true,
isBottomLinesActive: true,
)

```
### PKDarkCardPageSkeleton

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

//Widget
PKDarkCardPageSkeleton(
totalLines: 5,
)

```

## 💰 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) 2019 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.dev/).

For help on editing package code, view the [documentation](https://flutter.dev/developing-packages/).