Skip to content

Pliniodev/chords-diagram

Repository files navigation

chords-diagram

image

A simple Composable Guitar Chords Diagram


quick start

maven { url 'https://jitpack.io' }
dependencies {
    implementation 'com.github.Pliniodev:chords-diagram:version'
}

Example of use

ChordsDiagram(
    modifier = Modifier.fillMaxWidth(),
    options = ChordDiagramOptions(
        chordDiagramSize = ChordDiagramSize.Medium,
        variant = ChordDiagramVariant.Full,
        openStrings = listOf(
            OpenGuitarString.First,
            OpenGuitarString.Second,
            OpenGuitarString.Third,
            OpenGuitarString.Fifth,
        ),
        chordPositions = listOf(
            ChordPosition(
                guitarFret = GuitarFret.First,
                barChord = 1..6,
            ),
            ChordPosition(
                guitarFret = GuitarFret.Second,
                fingerPosition = FingerPosition(
                    guitarString = GuitarString.B,
                    fingering = Fingering.Second,
                )
            ),
            ChordPosition(
                guitarFret = GuitarFret.Third,
                fingerPosition = FingerPosition(
                    guitarString = GuitarString.D,
                    fingering = Fingering.Fourth,
                )
            ),
            ChordPosition(
                guitarFret = GuitarFret.Third,
                fingerPosition = FingerPosition(
                    guitarString = GuitarString.A,
                    fingering = Fingering.Third,
                )
            ),
        )
    ),
)

Result

image

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages