Contents - HopefulLlama/Bootstrap-Booklet GitHub Wiki

Constructors

Parameters Data Types Summaries

Actions on Construction

  • Sets own enabled property to true
  • Sets own showPageNumbers property to true

Field Summary

Property Data Type Summary
enabled Boolean Defaults to true. Used to define whether a contents page should be displayed on generation.
showPageNumbers Boolean Defaults to true. Used to define whether page numbers should be shown by each page.

Function Summary

Function Parameters Return Type Summary
generate
  1. Integer: bookletID
  2. Array‹Page›: pages
  3. String: panelClasses
String This function should not be called directly, but instead called as part of BootstrapBooklet.generate(). FYI:
  • bookletID references the ID of the booklet that the contents belongs to.
  • pages is an array of pages which it should generate a contents page for
  • panelClasses is a string which defines CSS classes to apply to its panels
⚠️ **GitHub.com Fallback** ⚠️