flutter_circle_of_fifths 1.3.1
flutter_circle_of_fifths: ^1.3.1 copied to clipboard
A comprehensive Flutter music suite: interactive Circle of Fifths, ChordPro sheet viewer, instrument diagrams, progressions, and modes.
flutter_circle_of_fifths #
A comprehensive, interactive, customizable Material 3 Circle of Fifths, Chord Sheet Viewer, and Music Theory Suite for Flutter. Supports Major and Minor modes, diatonic scale breakdown, song transposition (ChordPro), instrument chord diagrams (Guitar, Ukulele, Piano), harmonic progressions with Roman numeral analysis, Gregorian church modes, and pure Dart audio synthesis.
📚 Documentation by Language / Documentación por Idioma #
Select your preferred language to access full widget documentation, property tables, theory explanations, and copy-paste examples:
- 🇪🇸 Documentación Completa en Español (
doc/es/)- Guías detalladas de cada widget, tablas de parámetros, personalización de interlineado y ejemplos en español.
- 🇺🇸 Full English Documentation Hub (
doc/en/)- Exhaustive guides for every widget, properties reference tables, customization options, and code samples in English.
☕ Support the Project / Apoya el Proyecto #
If this package has been helpful and you'd like to support its ongoing development and maintenance, feel free to contribute:
- 💳 PayPal: paypal.me/NyKservice
- 🅿️ Patreon: patreon.com/JuanPabloGosalvez
Your support is greatly appreciated to keep this project 100% free, open-source, and constantly evolving!
🌟 Key Features #
- 🎡 Interactive 12-Sector Wheel: Tap the outer ring for Major keys or the middle ring for Relative Minor keys.
- 🔄 Dynamic 12:00 Rotation: Smoothly centers the selected key at the top of the wheel.
- 📝 ChordPro Song Sheet Viewer (
ChordSheetViewer): Aligns interactive chord badges directly over lyrics. Tap any chord to inspect its fingerings. - 🎚️ Harmonic Transposition Engine (
ChordTransposer): Real-time transposition by semitones (+1/-1) or directly across Circle of Fifths keys with automatic accidental adaptation (#vsb). - 🎸 Instrument Chord Diagrams: Vector-drawn diagrams with barres and finger numbers for Guitar (6 strings), Ukulele (4 strings), and Piano (1–3 octaves).
- 🎼 Harmonic Progression Builder (
ProgressionBuilderWidget): Popular templates (Pop Axis of Awesome, Jazz ii-V-I, 12-Bar Blues, Canon), Roman numeral analysis ($I, ii, iii, IV, V, vi, vii^\circ$), and secondary dominant suggestions. - 🎷 7 Gregorian Modes & Advanced Scales (
ScaleModesWidget): Ionian, Dorian, Phrygian, Lydian, Mixolydian, Aeolian, Locrian, plus Pentatonics, Blues, Harmonic Minor, and Melodic Minor. - 🔊 Zero-Dependency Audio Synthesis (
SimpleAudioSynthesizer): Pure Dart in-memory PCM WAV synthesis for notes and chords across all 6 Flutter platforms (Android, iOS, Web, Windows, macOS, Linux). - 🌐 Full Localization (i18n): Translate or customize all text labels (
CircleOfFifthsLabels) across all widgets from a single place, with built-in Spanish support (CircleOfFifthsLabels.spanish). - 🎨 Material 3 Theme Adaptive: Seamlessly adapts to light and dark themes using modern Flutter APIs.
- 📱 Modal Sheets: Ready-to-use draggable bottom sheets for the Circle of Fifths and chord inspection with a single function call.
🧩 Widget Catalog & Quick Links #
| Widget | Summary | 🇺🇸 English Docs | 🇪🇸 Documentación ES |
|---|---|---|---|
ChordSheetViewer |
ChordPro lyrics viewer, transposition, stanzas & spacing | 📖 View Docs | 📖 Ver Guía |
CircleOfFifthsWheelWidget |
Interactive vector Circle of Fifths canvas wheel with 12:00 auto-rotation | 📖 View Docs | 📖 Ver Guía |
CircleOfFifthsSheet |
Turnkey draggable modal bottom sheet with Wheel & Summary tab views | 📖 View Docs | 📖 Ver Guía |
ScaleDetailCard |
Diatonic scale degrees (I–VII), interval formula, piano keybed & chord taps | 📖 View Docs | 📖 Ver Guía |
ChordInspectorSheet |
Harmonic analysis modal with Guitar, Ukulele & Piano voicings and audio | 📖 View Docs | 📖 Ver Guía |
FretboardWidget |
Vector string instrument fretboard (Guitar 6-string & Ukulele 4-string) | 📖 View Docs | 📖 Ver Guía |
PianoKeybedWidget |
Interactive 1–3 octave piano keyboard highlighting active scale/chord notes | 📖 View Docs | 📖 Ver Guía |
ProgressionBuilderWidget |
Roman numeral harmonic progressions, chord suggestions & playback | 📖 View Docs | 📖 Ver Guía |
ScaleModesWidget |
7 Gregorian church modes & advanced scales explorer with audio scale playback | 📖 View Docs | 📖 Ver Guía |
🚀 Getting Started #
Add the dependency to your pubspec.yaml:
dependencies:
flutter_circle_of_fifths: ^1.3.1
Run:
flutter pub get
💻 Quick Example #
import 'package:flutter/material.dart';
import 'package:flutter_circle_of_fifths/flutter_circle_of_fifths.dart';
void openCircleOfFifths(BuildContext context) {
CircleOfFifthsSheet.show(
context,
customTheme: const CircleOfFifthsTheme(
centerLabel: 'NyK',
),
);
}