VyuhContentWidget<T extends ContentItem> class
A versatile content widget that handles both single and list content items.
It interacts with the ContentPlugin (either directly or via VyuhBinding) to fetch content from the CMS.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- VyuhContentWidget
Constructors
-
VyuhContentWidget({Key? key, String query = _defaultSanityQuery, required FromJsonConverter<
T> fromJson, Map<String, String> ? queryParams, DocumentBuilder<T> ? builder, DocumentListBuilder<T> ? listBuilder}) -
Creates a VyuhContentWidget with the given parameters.
const
-
VyuhContentWidget.fromDocument({Key? key, required String identifier, String? query, Map<
String, String> ? queryParams, Widget builder(BuildContext, Document)?}) -
Creates a VyuhContentWidget that loads a single Document from the CMS.
If a query is not provided, it will default to a Sanity GROQ query.
This assumes that you have setup a SanityContentProvider for the
ContentPlugin.factory
Properties
-
builder
→ DocumentBuilder<
T> ? -
The builder to use when the widget is displaying a single content item.
final
-
fromJson
→ FromJsonConverter<
T> -
The converter to use when converting the raw JSON data from the CMS into a
ContentItem.final - hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
listBuilder
→ DocumentListBuilder<
T> ? -
The builder to use when the widget is displaying a list of content items.
final
- query → String
-
The query to fetch content from the CMS.
final
-
queryParams
→ Map<
String, String> ? -
The query parameters to pass to the CMS.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< VyuhContentWidget< T> > -
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
-
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