ArcaneToc class
A table of contents component for documentation pages.
Displays a hierarchical list of headings with anchor links. Supports tree-line visual connectors and active state highlighting.
- Inheritance
-
- Object
- Component
- StatelessComponent
- StatelessWidget
- ArcaneToc
Constructors
-
ArcaneToc({List<
TocEntry> entries = const [], String title = 'On this page', bool showTreeLines = true, String classPrefix = 'toc', Widget? customContent, Key? key}) -
const
- ArcaneToc.custom({required Widget content, String title = 'On this page', bool showTreeLines = true, String classPrefix = 'toc', Key? key})
-
Create a TOC that wraps custom content (e.g., from jaspr_content).
const
Properties
- classPrefix → String
-
CSS class prefix for customization.
final
- customContent → Widget?
-
Optional component to wrap around the TOC content.
Useful for integrating with jaspr_content's TableOfContents.
final
-
entries
→ List<
TocEntry> -
The list of TOC entries to display.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one component replaces another component in the tree.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showTreeLines → bool
-
Whether to show tree-line connectors.
final
- title → String
-
Title displayed above the TOC.
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this component.
override
-
createElement(
) → Element -
Creates a StatelessElement to manage this component's location in the tree.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
shouldRebuild(
covariant Component newComponent) → bool -
Implement this method to determine whether a rebuild can be skipped.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited