https://github.com/catppuccin/flutter
🦋 Soothing pastel library for Flutter
https://github.com/catppuccin/flutter
catppuccin flutter hacktoberfest library
Last synced: 5 months ago
JSON representation
🦋 Soothing pastel library for Flutter
- Host: GitHub
- URL: https://github.com/catppuccin/flutter
- Owner: catppuccin
- License: mit
- Created: 2023-08-08T18:34:49.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-14T01:34:19.000Z (over 1 year ago)
- Last Synced: 2025-02-16T10:02:39.269Z (over 1 year ago)
- Topics: catppuccin, flutter, hacktoberfest, library
- Language: Dart
- Homepage:
- Size: 790 KB
- Stars: 30
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Catppuccin for Flutter
## Previews
🌻 Latte
🪴 Frappé
🌺 Macchiato
🌿 Mocha
## Installation
To use Catppuccin in a Flutter project, you can follow these steps:
1. **Add `catppuccin_flutter` to Your `pubspec.yaml` File:**
Open your `pubspec.yaml` file and add the following line under the `dependencies` section:
```yaml
dependencies:
# ...
catppuccin_flutter: ^1.0.0
# ...
```
2. After adding `catppuccin_flutter` to your `pubspec.yaml` file, run the following command in your terminal to fetch the packages:
```bash
flutter pub get
```
## Usage
```dart
import 'package:catppuccin_flutter/catppuccin_flutter.dart';
Flavor flavor = catppuccin.latte;
Color primaryColor = flavor.mauve;
Color secondaryColor = flavor.pink;
```
* `catppuccin` encapsulates all the flavor names, namely `latte`, `frappe`, `macchiato` and `mocha`.
* `Flavor` typedef for record, which is a collection of all the colors available.
Also, you can get started with our [example](https://github.com/catppuccin/flutter/tree/main/example) to see it in action!
## Contributing
If you are looking to contribute, please read through our
[CONTRIBUTING.md](https://github.com/catppuccin/.github/blob/main/CONTRIBUTING.md)
first!
## 💝 Thanks to
- [useEffects](https://github.com/useEffects)
Copyright © 2022-present Catppuccin Org
