ViewerPageUnion class

Union class that represents a "Page" in the design system viewer catalog.

Implemented types
Implementers
Annotations
  • @freezed

Constructors

ViewerPageUnion.document({required String id, required List<String> namespace, required String title, String? subtitle, String? description, @Default([]) List<ViewerSectionUnion> sections})
A leaf document page which contains multiple union sections.
const
factory
ViewerPageUnion.group({required String id, required List<String> namespace, required String title, String? description, @Default([]) List<ViewerPageUnion> children})
A group page which contains a list of children union pages.
const
factory

Properties

copyWith → $ViewerPageUnionCopyWith<ViewerPageUnion>
no setterinherited
description → String?
Description of the page.
no setterinherited
firstDocumentUri → String
Get the URI of the first document in the current page:
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → String
Id of the page.
no setterinherited
namespace → List<String>
Namespace describing the hierarchical structure of the page. It which consists of a list of ids from the root to the parent.
no setterinherited
namespaceHierarchyLabel → String
Get the namespace hierarchy user friendly label
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchableElements → List<SearchableElement>
Get all searchable elements
no setteroverride
segments → List<String>
Get the list of id segments which includes both the ids in the namespace as well as the current id
no setter
title → String
Title of the page.
no setterinherited
uri → String
Get the URI that represents the current page
no setter

Methods

map<TResult extends Object?>({required TResult group(ViewerGroupPage value), required TResult document(ViewerDocumentPage value)}) → TResult
inherited
mapOrNull<TResult extends Object?>({TResult group(ViewerGroupPage value)?, TResult document(ViewerDocumentPage value)?}) → TResult?
inherited
maybeMap<TResult extends Object?>({TResult group(ViewerGroupPage value)?, TResult document(ViewerDocumentPage value)?, required TResult orElse()}) → TResult
inherited
maybeWhen<TResult extends Object?>({TResult group(String id, List<String> namespace, String title, String? description, List<ViewerPageUnion> children)?, TResult document(String id, List<String> namespace, String title, String? subtitle, String? description, List<ViewerSectionUnion> sections)?, required TResult orElse()}) → TResult
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
when<TResult extends Object?>({required TResult group(String id, List<String> namespace, String title, String? description, List<ViewerPageUnion> children), required TResult document(String id, List<String> namespace, String title, String? subtitle, String? description, List<ViewerSectionUnion> sections)}) → TResult
inherited
whenOrNull<TResult extends Object?>({TResult group(String id, List<String> namespace, String title, String? description, List<ViewerPageUnion> children)?, TResult document(String id, List<String> namespace, String title, String? subtitle, String? description, List<ViewerSectionUnion> sections)?}) → TResult?
inherited

Operators

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