PreviewsPackage class

Inheritance

Constructors

PreviewsPackage(Pkg pkg, {String? directory, List<String>? previewAnnotations, Device? device, ScreenOrientation? orientation, List<PreviewCanvas> canvases = const [], String? setup})
const

Properties

canvases → List<PreviewCanvas>
What the previews under each subtree are framed as. See PreviewCanvas.
final
device → Device?
What this package's previews are framed as when a caller names no device — the panel's canvas, every screenshot, inspect and compare, and the page build-web writes.
final
directory → String?
Narrows the scan to one directory, relative to the package.
final
duplicateCanvasPrefix → String?
The prefix this package names twice, or null when each is named once.
no setter
hashCode → int
The hash code for this object.
no setterinherited
orientation → ScreenOrientation?
Which way up device is. Ignored when nothing can turn — every desktop size, and the plain rectangle.
final
path → String
no setterinherited
pkg → Pkg
finalinherited
previewAnnotations → List<String>?
The annotation names that mark an entry, without their @.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
setup → String?
A file whose previewSetup() runs once, before any preview in this package builds — relative to the package, e.g. 'lib/preview_setup.dart'.
final
unknownDevice → Device?
The first device in device or canvases that is not in Devices, or null when each of them is.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, Object?>
Must include path; the rest is whatever the plugin needs.
override
toString() → String
A string representation of this object.
inherited

Operators

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

Static Methods

each(List<Pkg> packages) → List<PreviewsPackage>