ViewerSectionUnion class

Union class for sections on ViewerDocumentPage.

Implemented types

• Searchable

Implementers

• ViewerApiDocsSection
• ViewerComponentSection
• ViewerParagraphSection

Annotations

• @freezed

Constructors

ViewerSectionUnion.apiDocs({required String id, required String title, String? description})

API reference section. The actual API information will be retrieved from the constructor, via ViewerWidgetBuilder.

const

factory

ViewerSectionUnion.component({required String id, required String title, String? description, required String ctorName, String? designLink, required ViewerWidgetBuilder builder, @Default([]) List<ViewerComponentExample> examples, required ViewerSourceCode sourceCode})

const

factory

ViewerSectionUnion.paragraph({required String id, required String title, String? description, @Default([]) List<ViewerCollectionItemUnion> contents})

Paragraph section with possible list of content items.

const

factory

Properties

copyWith → $ViewerSectionUnionCopyWith<ViewerSectionUnion>

no setter, inherited

description → String?

Description of the section.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → String

Id of the section.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

searchableElements → List<SearchableElement>

Get all searchable elements

no setter, override

title → String

Title of the section.

no setter, inherited

Methods

map<TResult extends Object?>({required TResult paragraph(ViewerParagraphSection value), required TResult component(ViewerComponentSection value), required TResult apiDocs(ViewerApiDocsSection value)}) → TResult

inherited

mapOrNull<TResult extends Object?>({TResult paragraph(ViewerParagraphSection value)?, TResult component(ViewerComponentSection value)?, TResult apiDocs(ViewerApiDocsSection value)?}) → TResult?

inherited

maybeMap<TResult extends Object?>({TResult paragraph(ViewerParagraphSection value)?, TResult component(ViewerComponentSection value)?, TResult apiDocs(ViewerApiDocsSection value)?, required TResult orElse()}) → TResult

inherited

maybeWhen<TResult extends Object?>({TResult paragraph(String id, String title, String? description, List<ViewerCollectionItemUnion> contents)?, TResult component(String id, String title, String? description, String ctorName, String? designLink, ViewerWidgetBuilder builder, List<ViewerComponentExample> examples, ViewerSourceCode sourceCode)?, TResult apiDocs(String id, String title, String? description)?, 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 paragraph(String id, String title, String? description, List<ViewerCollectionItemUnion> contents), required TResult component(String id, String title, String? description, String ctorName, String? designLink, ViewerWidgetBuilder builder, List<ViewerComponentExample> examples, ViewerSourceCode sourceCode), required TResult apiDocs(String id, String title, String? description)}) → TResult

inherited

whenOrNull<TResult extends Object?>({TResult paragraph(String id, String title, String? description, List<ViewerCollectionItemUnion> contents)?, TResult component(String id, String title, String? description, String ctorName, String? designLink, ViewerWidgetBuilder builder, List<ViewerComponentExample> examples, ViewerSourceCode sourceCode)?, TResult apiDocs(String id, String title, String? description)?}) → TResult?

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited