Class HtmlDivFormatter

constructor

• new HtmlDivFormatter(
      configuration?: Record<string, any> & Partial<
          {
              decapo: boolean;
              delegates: Partial<DelegatesConfiguration>;
              evaluate: boolean;
              expandChorusDirective: boolean;
              instrument: Partial<InstrumentConfiguration>;
              key: null | string | Key;
              metadata: Partial<MetadataConfiguration>;
              normalizeChords: boolean;
              user: Partial<UserConfigurationProperties>;
              useUnicodeModifiers: boolean;
          },
      > & { cssClasses?: Partial<HtmlTemplateCssClasses> },
  ): HtmlDivFormatter

  Instantiate the formatter. For all options see Formatter

  Parameters

  • Optionalconfiguration: Record<string, any> & Partial<
        {
            decapo: boolean;
            delegates: Partial<DelegatesConfiguration>;
            evaluate: boolean;
            expandChorusDirective: boolean;
            instrument: Partial<InstrumentConfiguration>;
            key: null | string | Key;
            metadata: Partial<MetadataConfiguration>;
            normalizeChords: boolean;
            user: Partial<UserConfigurationProperties>;
            useUnicodeModifiers: boolean;
        },
    > & { cssClasses?: Partial<HtmlTemplateCssClasses> } = {}

    options

    • cssClasses

      CSS classes to use in the HTML output. The default classes are defined in defaultCssClasses. You can override them by providing your own classes here:

    • cssClasses

      CSS classes to use in the HTML output. The default classes are defined in defaultCssClasses. You can override them by providing your own classes here:

    • OptionalcssClasses?: Partial<HtmlTemplateCssClasses>

      CSS classes to use in the HTML output. The default classes are defined in defaultCssClasses. You can override them by providing your own classes here:

  Returns HtmlDivFormatter

  Example

  {
     cssClasses: {
       annotation: 'my-annotation',
       chord: 'my-chord',
       chordSheet: 'my-chord-sheet',
       column: 'my-column',
       comment: 'my-comment',
       emptyLine: 'my-empty-line',
       label: 'my-label',
       labelWrapper: 'my-label-wrapper',
       line: 'my-line',
       literal: 'my-literal',
       literalContents: 'my-contents',
       lyrics: 'my-lyrics',
       paragraph: 'my-paragraph',
       row: 'my-row',
       subtitle: 'my-subtitle',
       title: 'my-title',
     }
   }
  Copy