https://github.com/yelodevs/yelo_icons
A Flutter package for easily integrating custom SVG icons into your Flutter applications.
https://github.com/yelodevs/yelo_icons
dart dart-package flutter flutter-package flutter-plugin fluttericons svg
Last synced: about 2 months ago
JSON representation
A Flutter package for easily integrating custom SVG icons into your Flutter applications.
- Host: GitHub
- URL: https://github.com/yelodevs/yelo_icons
- Owner: Yelodevs
- License: mit
- Created: 2024-09-27T20:29:40.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-09-29T18:15:27.000Z (8 months ago)
- Last Synced: 2025-01-29T17:44:37.647Z (3 months ago)
- Topics: dart, dart-package, flutter, flutter-package, flutter-plugin, fluttericons, svg
- Language: C++
- Homepage: https://yelodev.gitbook.io/yelo-icons/
- Size: 2.99 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
### Updated README for **Yelo Icons**:
# Yelo Icons
[](https://pub.dartlang.org/packages/yelo_icons)
A Flutter package for easily integrating custom SVG icons into your Flutter applications.
# Support
**YELO ICONS** is a package created for **Flutter/dart**. If you find it useful, please consider supporting it.
## Features
- Simple API for using custom SVG icons
- Customizable icon size and color
- Built on top of the `flutter_svg` package for efficient SVG rendering
- **New in v1.0.3**: Added interaction handlers like `onTap`, `onPress`, `onLongPress` and more.
## Getting started
Add `yelo_icons` to your `pubspec.yaml` file:
```yaml
dependencies:
yelo_icons: ^1.0.3
```
Run `flutter pub get` to install the package.
## Usage
Import the package in your Dart code:
```dart
import 'package:yelo_icons/yelo_icons.dart';
```
### Basic Usage:
Use the `Yelo.icon()` method to display an icon:
```dart
Yelo.icon("bold/user", size: 24, color: Colors.blue)
```
### With Interaction:
You can now add interaction events such as `onTap`, `onLongPress`, etc.
```dart
Yelo.icon(
"bold/user",
size: 48,
color: Colors.red,
onTap: () {
print("User icon tapped!");
},
onLongPress: () {
print("User icon long-pressed!");
},
)
```
### Example:
```dart
import 'package:flutter/material.dart';
import 'package:yelo_icons/yelo_icons.dart';
class MyWidget extends StatelessWidget {
@override
Widget build(BuildContext context) {
return Column(
children: [
Yelo.icon("bold/user", size: 48, color: Colors.red, onTap: () {
print('Icon tapped!');
}),
Yelo.icon("outline/settings", size: 24, color: Colors.green),
],
);
}
}
```
## Additional information
For more information on using this package, please refer to the [API documentation](https://github.com/Yelodevs/yelo_icons/blob/main/YELO-API-DOC.md).
To report issues or contribute to the package, visit our [GitHub repository](https://github.com/Yelodevs/yelo_icons).
## Contributing
If you have suggestions or find issues with the package, feel free to open an issue or a pull request on the [GitHub repository](https://github.com/Yelodevs/yelo_icons).
## Credits
- Kudos to all contributors who made this package what it is.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.