TableOfContentsExtension class
An extension that generates a table of contents from the headers in the page.
The resulting TableOfContents object is stored in the page's data under the 'toc' key.
It may be consumed by a layout to display the table of contents.
- Implemented types
Constructors
- TableOfContentsExtension({int maxHeaderDepth = 3})
-
const
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- maxHeaderDepth → int
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
apply(
Page page, List< Node> nodes) → Future<List< Node> > -
Applies the extension to the given Page and parsed
Nodes.override -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited