DocumentationAddon class

An addon that displays documentation for the widget.

The documentation is displayed in a markdown format.

The documentation is loaded from a markdown file in the assets folder. The path to the markdown file is determined by the query parameter path. Example: ?path=dss-components/form/textdynamicinput/textdynamicinput.percent give the path to the markdown file assets/markdown/dss-components/form/textdynamicinput/textdynamicinput.percent.md

The documentation is displayed in a resizable container.

The documentation can be toggled on and off using the documentation field.

Constructors

DocumentationAddon.new({required AssetBundle assetBundle, bool initialBool = true})

Properties

assetBundle → AssetBundle
final
description → String?
The description of the composable group.
finalinherited
fields → List<Field<bool>>
A list of Fields that belong to this composable group.
no setter
groupName → String
The name of the query group param.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
initialBool → bool
final
isNullable → bool
Whether this composable group is nullable.
finalinherited
name → String
The display name of the composable group.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

buildFields(BuildContext context) → Widget
Converts the fields into a Widget that will be rendered in the settings side panel.
inherited
buildUseCase(BuildContext context, Widget child, bool setting) → Widget
Builds the wrapper widget for use cases based on the current setting.
isNullified(BuildContext context) → bool
Whether the group has been nullified by toggleNullification.
inherited
loadMarkdown() → Future<String>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
slugify(String name) → String
Converts the name to a slugified version that can be used in query parameters.
inherited
toggleNullification(BuildContext context, {required bool nullify}) → void
Adds/removes Field.nullabilitySymbol to/from all fields depending on the nullify state. If nullify is true, the Field.nullabilitySymbol is added. If nullify is false, the Field.nullabilitySymbol is removed.
inherited
toJson() → Map<String, dynamic>
Converts this composable group to a JSON representation.
inherited
toString() → String
A string representation of this object.
inherited
valueFromQueryGroup(Map<String, String> group) → bool
Converts a query group to a value of type T.
valueOf<TField>(String name, Map<String, String> group) → TField?
Decodes the value of the Field with name from the query group using the FieldCodec.toValue from Field.codec.
inherited

Operators

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