MParam class

A user-editable parameter a widget declares for OS configuration.

When the user adds or edits the widget, the OS presents an editor for each declared parameter (iOS via an AppIntentConfiguration whose AppIntent exposes the parameters; Android via a configuration Activity). The value the user picks is exposed to the widget tree under the same bind namespace as live data: reference it with MBind(key). A param key therefore shadows/feeds the bind key of the same name (resolved at render).

Constructors

MParam({required String key, required String label, MParamType type = MParamType.text, Object? defaultValue, List<String>? choices})
const

Properties

choices → List<String>?
Allowed values for MParamType.choice; null for other types.
final
defaultValue → Object?
Optional initial value used until the user picks one.
final
hashCode → int
The hash code for this object.
no setterinherited
key → String
Stable identifier; also the bind key the chosen value is exposed under.
final
label → String
Human-readable label shown in the OS configuration UI.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
type → MParamType
The kind of editor/control to present.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

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