Class HtmlDivFormatter

Formats a song into HTML. It uses DIVs to align lyrics with chords, which makes it useful for responsive web pages.

Hierarchy (View Summary)

Constructors

Accessors

Methods

Constructors

  • Instantiate

    Parameters

    • Optionalconfiguration: Partial<ConfigurationProperties> = {}

      options

      • evaluate

        Whether or not to evaluate meta expressions. For more info about meta expressions, see: https://bit.ly/2SC9c2u

      • metadata
      • metadata.separator

        The separator to be used when rendering a metadata value that has multiple values. See: https://bit.ly/2SC9c2u

      • key

        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.

      • expandChorusDirective

        Whether or not to expand {chorus} directives by rendering the last defined chorus inline after the directive.

      • useUnicodeModifiers

        Whether or not to use unicode flat and sharp symbols.

      • normalizeChords

        Whether or not to automatically normalize chords

    Returns HtmlDivFormatter

Accessors

  • get cssObject(): CSS
  • Basic CSS, in object style à la useStyles, to use with the HTML output For a CSS string see cssString

    Example:

    '.paragraph': {
      marginBottom: '1em'
    }
    

    Returns CSS

    the CSS object

Methods

  • 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;
    }
    

    Parameters

    • scope: string = ''

      the CSS scope to use, for example .chordSheetViewer

    Returns string

    the CSS string