ManagedComponentContract class final

What a managed component lets an instance customize, and what it needs: the schema the editor's instance panel is generated from.

JSON: {"settings": [ComponentSetting…], "slots": [ManagedSlot…], "events": [ManagedEvent…], "tokens": ["primary", …], "variables": [Variable…], "requires": {"auth": ["password"]}}. Setting targets and slot nodes name the version's node ids.

Annotations
  • @immutable

Constructors

ManagedComponentContract({List<ComponentSetting> settings = const [], List<ManagedSlot> slots = const [], List<ManagedEvent> events = const [], List<String> tokens = const [], List<Variable> variables = const [], Json requires = const {}, Json extra = const {}})
const

Properties

events → List<ManagedEvent>
final
extra → Json
final
flatSettings → Iterable<ComponentSetting>
Every setting, groups flattened.
no setter
hashCode → int
The hash code for this object.
no setteroverride
requires → Json
What it needs of the project ({"auth": ["password"]}).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
settings → List<ComponentSetting>
final
slots → List<ManagedSlot>
final
tokens → List<String>
The theme tokens (ThemeTokens JSON keys) its nodes bind (${theme.primary}).
final
variables → List<Variable>
The variables its nodes and actions use, declared on the canvas it is placed on.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setting(String key) → ComponentSetting?
The setting with key key.
toJson() → Json
toString() → String
A string representation of this object.
inherited

Operators

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

Static Methods

fromJson(Object? json) → ManagedComponentContract