TableOfContentsWidget class

Widget for displaying the table of contents in a drawer.

Inheritance

Constructors

TableOfContentsWidget({Key? key, required List<ChapterNode> chapters, required ReaderThemeData themeData, required void onChapterTap(ChapterNode chapter), int currentParagraphIndex = -1, String? bookTitle, String? bookAuthor, Uint8List? coverImage})
Creates a new table of contents widget.
const

Properties

bookAuthor → String?
Author of the book.
final
bookTitle → String?
Title of the book.
final
chapters → List<ChapterNode>
List of chapters in the book.
final
coverImage → Uint8List?
Cover image data.
final
currentParagraphIndex → int
Index of the current paragraph being read (for highlighting active chapter).
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onChapterTap → void Function(ChapterNode chapter)
Callback when a chapter is tapped.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
themeData → ReaderThemeData
The current theme data.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited