NiceWiki class

A wiki module with page tree sidebar and content viewer/editor.

Inheritance
Available extensions

Constructors

NiceWiki({Key? key, required List<NiceWikiPage> pages, String? selectedPageId, ValueChanged<NiceWikiPage>? onSelectPage, void onSavePage(String pageId, String content, String title)?, void onCreatePage(String? parentId, String title)?, ValueChanged<String>? onDeletePage, bool editable = false, bool searchable = true, double sidebarWidth = 260})
const

Properties

editable bool
Whether editing is allowed.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onCreatePage → void Function(String? parentId, String title)?
Called to create a new page.
final
onDeletePage ValueChanged<String>?
Called to delete a page.
final
onSavePage → void Function(String pageId, String content, String title)?
Called to save page content.
final
onSelectPage ValueChanged<NiceWikiPage>?
Called when selecting a page.
final
pages List<NiceWikiPage>
All pages (flat or nested via children).
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
searchable bool
Whether to show search.
final
selectedPageId String?
Currently selected page ID.
final
sidebarWidth double
Sidebar width.
final

Methods

asFocusable({FocusNode? focusNode, bool autofocus = false}) Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Mark this widget as focusable.
asSemanticButton({String? label, VoidCallback? onTap}) Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Mark this widget as a button for screen readers.
asSemanticHeading(String label) Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Mark this widget as a heading for screen readers.
createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<NiceWiki>
Creates the mutable state for this widget at a given location in the tree.
override
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
excludeFromSemantics() Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Exclude this widget from the semantic tree.
mergeSemantics() Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Merge semantics of child widgets.
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
withSemanticLabel(String label) Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Add a semantic label to this widget.

Operators

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