Route class final

Inheritance

• Object
• ContentItem
• RouteBase
• Route

Available extensions

• RegionItems

Annotations

• @JsonSerializable()

Constructors

Route({required String title, required RouteTypeConfiguration? routeType, required String path, required List<Region> regions, required DateTime createdAt, required DateTime updatedAt, required String id, Category? category, LayoutConfiguration<ContentItem>? layout, List<ContentModifierConfiguration>? modifiers, List<RouteLifecycleConfiguration>? lifecycleHandlers})

Route.fromJson(Map<String, dynamic> json)

factory

Properties

category → Category?

final, inherited

createdAt → DateTime

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → String

final, inherited

layout → LayoutConfiguration<ContentItem>?

The layout configuration for the content item.

final, inherited

lifecycleHandlers → List<RouteLifecycleConfiguration>?

final

modifiers → List<ContentModifierConfiguration>?

final, inherited

parent ↔ ContentItem?

The parent content item of this content item. This is used internally by the content system.

getter/setter pair, inherited

path → String

final, inherited

regions → List<Region>

final

routeType → RouteTypeConfiguration?

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

schemaType → String

The schema type of the content item.

final, inherited

title → String

final, inherited

updatedAt → DateTime

final, inherited

Methods

createPage<T>(BuildContext context, [LocalKey? pageKey]) → Page<T>

inherited

dispose() → Future<void>

override

getLayout() → LayoutConfiguration<ContentItem>?

Gets the layout to use for the ContentItem. By default its the layout itself. However this acts as an extension point for custom ContentItems that may have a different strategy for applying layouts.

inherited

getModifiers() → List<ContentModifierConfiguration>?

Gets the modifiers to use for the ContentItem. By default its the modifiers itself. However this acts as an extension point for custom ContentItems that may have a different strategy for applying modifiers.

inherited

init(BuildContext context) → Future<RouteBase?>

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

regionItems(String regionName) → dynamic

Available on Route, provided by the RegionItems extension

setParent(Iterable<ContentItem?> children) → void

Sets the parent content item for the given list of children.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

contentBuilder → _RouteContentBuilder

final

typeDescriptor → TypeDescriptor<Route>

final

Static Methods

lifecycleHandlersFromJson(dynamic json) → List<RouteLifecycleConfiguration>?

Constants

schemaName → const String