Instantiate
Optional
configuration: Partial<ConfigurationProperties> = {}options
Whether or not to evaluate meta expressions. For more info about meta expressions, see: https://bit.ly/2SC9c2u
The separator to be used when rendering a metadata value that has multiple values. See: https://bit.ly/2SC9c2u
The key to use for rendering. The chord sheet will be
transposed from the song's original key (as indicated by the {key}
directive) to the specified key.
Note that transposing will only work if the original song key is set.
Whether or not to expand {chorus}
directives
by rendering the last defined chorus inline after the directive.
Whether or not to use unicode flat and sharp symbols.
Whether or not to automatically normalize chords
Basic CSS, in object style à la useStyles, to use with the HTML output For a CSS string see cssString
Example:
'.paragraph': {
marginBottom: '1em'
}
the CSS object
Generates basic CSS, optionally scoped within the provided selector, to use with the HTML output
For example, execute cssString('.chordSheetViewer') will result in CSS like:
.chordSheetViewer .paragraph {
margin-bottom: 1em;
}
the CSS scope to use, for example .chordSheetViewer
the CSS string
Formats a song into HTML. It uses DIVs to align lyrics with chords, which makes it useful for responsive web pages.