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

https://github.com/strash/flutter_numeric_text

A Flutter widget to animate any text.
https://github.com/strash/flutter_numeric_text

animation animation-effects dart flutter flutter-package flutter-widget text

Last synced: 3 months ago
JSON representation

A Flutter widget to animate any text.

Awesome Lists containing this project

README

          

## `Text(data)` → `NumericText(data)`

This widget allows you to animate any text. The animation is reminiscent of the text animation in SwiftUI's `.numericText(value:)`. The widget is easy to use and allows you to seamlessly replace `Text(data)` with `NumericText(data)`.

## Features

- Automatic text animation
- Minimal configuration required to get started
- Supports almost all parameters of the `Text()` widget
- No external dependencies required

## Usage

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

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

@override
Widget build(BuildContext context) {
// Simply add the widget, and when its value changes,
// it will automatically trigger the animation.

// To use the widget, you only need to provide
// a data value, other fields are optional.

NumericText(
"12345 or text",
duration: const Duration(milliseconds: 300),
style: const TextStyle(fontSize: 24, color: Colors.black),
textAlign: TextAlign.center,
textDirection: TextDirection.ltr,
locale: const Locale("en", "US"),
softWrap: true,
overflow: TextOverflow.ellipsis,
maxLines: 1,
semanticsLabel: "Numeric value",
);
}
}
```

### With `GoogleFonts`

```dart
...
NumericText(
"12345 or text",
duration: const Duration(milliseconds: 300),
style: GoogleFonts.(
fontSize: 24,
color: Colors.black,
// Just a friendly reminder to add the [textStyle] field.
// It'll make sure everything calculates correctly.
textStyle: Theme.of(context).textTheme.bodyMedium,
),
);
...
```

## Installation

To use this package, add it to your `pubspec.yaml` file:

```yaml
dependencies:
flutter_numeric_text: ^1.0.0 # Replace with the latest version
```

## Contributing

Contributions are welcome! If you have suggestions for improvements or find bugs, please open an issue or submit a pull request.

## License

This project is licensed under the MIT License. See the [LICENSE](https://github.com/strash/flutter_numeric_text/blob/main/LICENSE) file for details.