https://github.com/kartikeyaa-k/score-progress-pretty-display-package

A Flutter package
https://github.com/kartikeyaa-k/score-progress-pretty-display-package

animation credit-score dart flutter flutter-package progress-bar ui

Last synced: 13 days ago
JSON representation

A Flutter package

• Host: GitHub
• URL: https://github.com/kartikeyaa-k/score-progress-pretty-display-package
• Owner: kartikeyaa-k
• License: bsd-3-clause
• Created: 2023-09-23T16:16:52.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-24T08:45:16.000Z (about 1 year ago)
• Last Synced: 2023-09-24T19:28:04.827Z (about 1 year ago)
• Topics: animation, credit-score, dart, flutter, flutter-package, progress-bar, ui
• Language: C++
• Homepage: https://pub.dev/packages/score_progress_pretty_display
• Size: 4.88 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


A Flutter package to display and visualize credit card scores, or any other type of score, in a visually appealing way.

## Previews

![preview_1](https://github.com/kartikeyaa-k/score-progress-pretty-display-package/assets/67781046/3011093c-dddd-4d03-8462-9ee6014f7f84)

![preview_2](https://github.com/kartikeyaa-k/score-progress-pretty-display-package/assets/67781046/db286f52-463a-4629-a0e4-a69f691695fb)

![preview_3](https://github.com/kartikeyaa-k/score-progress-pretty-display-package/assets/67781046/c4ffc6d4-a072-466f-9152-f1645f039dfe)

## Features

- **Customizable:** You can customize the appearance of the score visualization, including the color, size, and animation.

- **Animated:** The package includes animations to make the score visualization engaging and interactive.

- **Easy to Use:** Integrating this package into your Flutter project is straightforward and requires minimal setup.

## Installation

Add the following dependency to your `pubspec.yaml` file:

```yaml

dependencies:

  score_progress_pretty_display: ^1.0.0 # Use the latest version

```

## Usage

```dart

PrimaryArcAnimationComponent(

          score: 77,

          maxScore: 100,

          arcHeight: 340,

          arcWidth: 340,

          backgroundArcStrokeThickness: 10,

          progressArcStrokeThickness: 10,

          enableStepperEffect: false,

          isRoundEdges: false,

          minScoreTextFontSize: 30,

          maxScoreTextFontSize: 50,

          isRoundOffScoreWhileProgress: true,

          isRoundOffScore: true,

          showOutOfScoreFormat: true,

          isPrgressCurveFilled: false,

          scoreAnimationDuration: Duration(seconds: 2),

          scoreTextAnimationDuration: Duration(milliseconds: 500),

          scoreTextStyle: TextStyle(fontWeight: FontWeight.normal, height: 1),

          arcBackgroundColor: Colors.black12,

          arcProgressGradientColors: [

            Colors.yellowAccent,

            Colors.greenAccent,

            Colors.green,

          ],

        )

```

## Example 

For a complete example, check the example directory included with this package.

## Contribution Guide

1. Feel free to reach out for feedback/discussions on [email protected]

2. Before submit PR, you need to set githook on your machine by paste and run this command from your terminal at root project 

```

git config core.hooksPath .githooks

```

3. When you add new feature/fix issues, please make sure you update the documentation

```

dart doc .

```

4. If possible, I want to keep this package free from external dependencies.

## Roadmap 

1. I am planning to add new animations in the next release.