DevicePreviewStore class

The store is a container for the current state of the device preview.

Whenever the state changes, it notifies its listener so that they can update themselves.

Inheritance
Available extensions

Constructors

DevicePreviewStore({required DeviceInfo defaultDevice, List<Locale>? locales, List<DeviceInfo>? devices, required DevicePreviewStorage storage})
Create a new store with the given locales, device and storage.

Properties

data ↔ DevicePreviewData

Available on DevicePreviewStore, provided by the DevicePreviewStateHelperExtensions extension

Access to the current state's data.
getter/setter pair
defaultDevice → DeviceInfo
final
deviceInfo → DeviceInfo

Available on DevicePreviewStore, provided by the DevicePreviewStateHelperExtensions extension

The currently selected device from the availableDevices.
no setter
devices → List<DeviceInfo>

Available on DevicePreviewStore, provided by the DevicePreviewStateHelperExtensions extension

Access to all available devices.
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
isCustomDevice → bool

Available on DevicePreviewStore, provided by the DevicePreviewStateHelperExtensions extension

Indicate whether the current device is a custom one.
no setter
locale → Locale

Available on DevicePreviewStore, provided by the DevicePreviewStateHelperExtensions extension

Get the currently selected locale from state's data.
no setter
locales → List<NamedLocale>

Available on DevicePreviewStore, provided by the DevicePreviewStateHelperExtensions extension

Access to all available locales.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
settings ↔ DevicePreviewSettingsData

Available on DevicePreviewStore, provided by the DevicePreviewStateHelperExtensions extension

Access to device preview settings from state's data.
getter/setter pair
state ↔ DevicePreviewState
The curren state of the device preview.
getter/setter pair
storage → DevicePreviewStorage
The storage used to persist the states's data.
final

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
dispose() → void
Discards any resources used by the object.
inherited
enableCustomDevice() → void

Available on DevicePreviewStore, provided by the DevicePreviewStateHelperExtensions extension

Activate the custom device mode.
initialize({List<Locale>? locales, List<DeviceInfo>? devices}) → Future<void>
Initializes the state by loading data from storage (if useStorage)
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
rotate() → void

Available on DevicePreviewStore, provided by the DevicePreviewStateHelperExtensions extension

Change the simulated device orientation between portrait and landscape.
selectDevice(DeviceIdentifier id) → void

Available on DevicePreviewStore, provided by the DevicePreviewStateHelperExtensions extension

Select the current device.
toggleDarkMode() → void

Available on DevicePreviewStore, provided by the DevicePreviewStateHelperExtensions extension

Switch from light to dark mode.
toggleFrame() → void

Available on DevicePreviewStore, provided by the DevicePreviewStateHelperExtensions extension

Hide or show the current device frame.
toggleVirtualKeyboard() → void

Available on DevicePreviewStore, provided by the DevicePreviewStateHelperExtensions extension

Hide or show the virtual keyboard.
toString() → String
A string representation of this object.
inherited
updateCustomDevice(CustomDeviceInfoData data) → void

Available on DevicePreviewStore, provided by the DevicePreviewStateHelperExtensions extension

Updates the custom device configuration.

Operators

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