Chord Provider (99% documented)

GitHub View on GitHub

Chord Provider ChordPro parser ChordPro Environment Enumeration Reference

Environment

enum Environment: String, Codable

The environment of a section of the song

Show on GitHub

Official environments

chorus
Chorus environment
Declaration
Swift

case chorus
Show on GitHub
repeatChorus
Repeat chorus environment
Declaration
Swift

case repeatChorus = "repeat_chorus"
Show on GitHub
verse
Verse environment
Declaration
Swift

case verse
Show on GitHub
bridge
Bridge environment
Declaration
Swift

case bridge
Show on GitHub
comment
Comment environment
Declaration
Swift

case comment
Show on GitHub
tab
Tab environment
Declaration
Swift

case tab
Show on GitHub
grid
Grid environment
Declaration
Swift

case grid
Show on GitHub

Official delegated environment directives

abc
ABC environment
Declaration
Swift

case abc
Show on GitHub
textblock
Textblock environment
Declaration
Swift

case textblock
Show on GitHub

Custom environments

strum
Strum environment
Declaration
Swift

case strum
Show on GitHub
metadata
The environment contains metadata
Declaration
Swift

case metadata
Show on GitHub
image
Image environment
Declaration
Swift

case image
Show on GitHub
none
Not an environment

Note
A source comment or an empty line for example
Declaration
Swift

case none
Show on GitHub
directives
The directives for opening and closing an environment
Declaration
Swift

var directives: (open: ChordPro.Directive, close: ChordPro.Directive)
Show on GitHub
label
The default label for the environment
Declaration
Swift

var label: String
Show on GitHub