ConnectPropsMixin class abstract

Implemented types
Available extensions

Constructors

ConnectPropsMixin()

Properties

$isClassGenerated → bool
Whether this class has been generated.
no setterinherited
aria → AriaPropsMixin
A view into this map that can be used to access aria- props, for convenience.
latefinalinherited
children ↔ List?
The children that were passed in to this component when it was built.
getter/setter pairinherited
className ↔ String?
String of space-delimited CSS classes to be added to the resultant DOM.
getter/setter pairinherited
classNameBlacklist ↔ String?
String of space-delimited CSS classes to be blacklisted from being added to the resultant DOM.
getter/setter pairinherited
componentDefaultProps → Map
An unmodifiable map view of the default props for this component brought in from the componentFactory.
no setterinherited
componentFactory ↔ ReactComponentFactoryProxy?
The react-dart factory associated with this props class's component, used to create a ReactElement with these props within build/call.
getter/setter pairinherited
dispatch ↔ dynamic Function(dynamic action)
getter/setter pair
dom → DomPropsMixin
A view into this map that can be used to access DOM props, for convenience.
latefinalinherited
entries → Iterable<MapEntry>
The map entries of this Map.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ String?
Unique identifier. Must be unique amongst all the ids, and contain at least one character.
getter/setter pairinherited
isEmpty → bool
Whether there is no key/value pair in the map.
no setterinherited
isNotEmpty → bool
Whether there is at least one key/value pair in the map.
no setterinherited
key ↔ String?
A String that differentiates a component from its siblings.
getter/setter pairinherited
keys → Iterable
The keys of this Map.
no setterinherited
length → int
The number of key/value pairs in the map.
no setterinherited
onAnimationEnd ↔ AnimationEventCallback?
Callback for when a CSS Animation has completed.
getter/setter pairinherited
onAnimationIteration ↔ AnimationEventCallback?
Callback for when an iteration of a CSS Animation ends, and another one begins.
getter/setter pairinherited
onAnimationStart ↔ AnimationEventCallback?
Callback for when a CSS animation has started.
getter/setter pairinherited
onBlur ↔ FocusEventCallback?
Callback for when an element loses focus
getter/setter pairinherited
onChange ↔ FormEventCallback?
Callback for when the content of a form element, the selection, or the checked state have changed (for , ,
getter/setter pairinherited
onClick ↔ MouseEventCallback?
Callback for when the user clicks on an element
getter/setter pairinherited
onContextMenu ↔ MouseEventCallback?
Callback for when the user right-clicks on an element to open a context menu
getter/setter pairinherited
onCopy ↔ ClipboardEventCallback?
Callback for when the user copies the content of an element
getter/setter pairinherited
onCut ↔ ClipboardEventCallback?
Callback for when the user cuts the content of an element
getter/setter pairinherited
onDoubleClick ↔ MouseEventCallback?
Callback for when the user double-clicks on an element
getter/setter pairinherited
onDrag ↔ MouseEventCallback?
Callback for when an element is being dragged
getter/setter pairinherited
onDragEnd ↔ MouseEventCallback?
Callback for when the user has finished dragging an element
getter/setter pairinherited
onDragEnter ↔ MouseEventCallback?
Callback for when the dragged element enters the drop target
getter/setter pairinherited
onDragExit ↔ MouseEventCallback?
Callback for when the dragged element exits the drop target
getter/setter pairinherited
onDragLeave ↔ MouseEventCallback?
Callback for when the dragged element leaves the drop target
getter/setter pairinherited
onDragOver ↔ MouseEventCallback?
Callback for when the dragged element is over the drop target
getter/setter pairinherited
onDragStart ↔ MouseEventCallback?
Callback for when the user starts to drag an element
getter/setter pairinherited
onDrop ↔ MouseEventCallback?
Callback for when the dragged element is dropped on the drop target
getter/setter pairinherited
onFocus ↔ FocusEventCallback?
Callback for when an element gets focus
getter/setter pairinherited
onInput ↔ FormEventCallback?
Callback for when an element gets user input
getter/setter pairinherited
onKeyDown ↔ KeyboardEventCallback?
Callback for when the user is pressing a key
getter/setter pairinherited
onKeyPress ↔ KeyboardEventCallback?
Callback for when the user presses a key
getter/setter pairinherited
onKeyUp ↔ KeyboardEventCallback?
Callback for when the user releases a key
getter/setter pairinherited
onMouseDown ↔ MouseEventCallback?
Callback for when the user presses a mouse button over an element
getter/setter pairinherited
onMouseEnter ↔ MouseEventCallback?
Callback for when the pointer is moved onto an element
getter/setter pairinherited
onMouseLeave ↔ MouseEventCallback?
Callback for when the pointer is moved out of an element
getter/setter pairinherited
onMouseMove ↔ MouseEventCallback?
Callback for when the pointer is moving while it is over an element
getter/setter pairinherited
onMouseOut ↔ MouseEventCallback?
Callback for when a user moves the mouse pointer out of an element, or out of one of its children
getter/setter pairinherited
onMouseOver ↔ MouseEventCallback?
Callback for when the pointer is moved onto an element, or onto one of its children
getter/setter pairinherited
onMouseUp ↔ MouseEventCallback?
Callback for when a user releases a mouse button over an element
getter/setter pairinherited
onPaste ↔ ClipboardEventCallback?
Callback for when the user pastes some content in an element
getter/setter pairinherited
onPointerCancel ↔ PointerEventCallback?
Callback for when the pointing device is interrupted
getter/setter pairinherited
onPointerDown ↔ PointerEventCallback?
Callback for when the pointer becomes active over an element
getter/setter pairinherited
onPointerEnter ↔ PointerEventCallback?
Callback for when the pointer is moved onto an element
getter/setter pairinherited
onPointerLeave ↔ PointerEventCallback?
Callback for when the pointer is moved out of an element
getter/setter pairinherited
onPointerMove ↔ PointerEventCallback?
Callback for when the pointer is moving while it is over an element
getter/setter pairinherited
onPointerOut ↔ PointerEventCallback?
Callback for when the pointer is moved out of an element, or out of one of its children
getter/setter pairinherited
onPointerOver ↔ PointerEventCallback?
Callback for when the pointer is moved onto an element, or onto one of its children
getter/setter pairinherited
onPointerUp ↔ PointerEventCallback?
Callback for when the pointer becomes inactive over an element
getter/setter pairinherited
onReset ↔ FormEventCallback?
Callback for when a form is reset
getter/setter pairinherited
onScroll ↔ UIEventCallback?
Callback for when an element's scrollbar is being scrolled
getter/setter pairinherited
onSubmit ↔ FormEventCallback?
Callback for when a form is submitted
getter/setter pairinherited
onTouchCancel ↔ TouchEventCallback?
Callback for when the touch is interrupted
getter/setter pairinherited
onTouchEnd ↔ TouchEventCallback?
Callback for when a finger is removed from a touch screen
getter/setter pairinherited
onTouchMove ↔ TouchEventCallback?
Callback for when a finger is dragged across the screen
getter/setter pairinherited
onTouchStart ↔ TouchEventCallback?
Callback for when a finger is placed on a touch screen
getter/setter pairinherited
onTransitionEnd ↔ TransitionEventCallback?
Callback for when a CSS transition has completed.
getter/setter pairinherited
onWheel ↔ WheelEventCallback?
Callback for when the mouse wheel rolls up or down over an element
getter/setter pairinherited
propKeyNamespace → String?
no setterinherited
props → Map
The props maintained by this builder and used passed into the component when built. In this case, it's the current MapView object.
no setter
ref ↔ dynamic
Either a String used to retrieve the element at a later time via react.Component.ref, or a Function that gets called with the element when it is mounted.
getter/setter pairinherited
requiredPropNamesToSkipValidation → Set<String>
Names of props to opt out of required prop validation for.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
staticMeta → PropsMetaCollection
A collection of metadata for the prop fields in all prop mixins used by this props instance's generated props class.
no setterinherited
style ↔ Map<String, dynamic>?
An inline CSS style for the element.
getter/setter pairinherited
tabIndex ↔ dynamic
Whether the element if focusable. Must be a valid integer or String of valid integer.
getter/setter pairinherited
testId → String?
Gets the data-test-id prop key for use in a testing environment.
no setterinherited
title ↔ String?
Represents advisory information about the element.
getter/setter pairinherited
values → Iterable
The values of this Map.
no setterinherited

Methods

$getPropKey(void accessMap(Map m)) → String
The base implementation for UiPropsSelfTypedExtension.getPropKey, which wraps this with better generic typing, since we can't generically express the type of the current class in this declaration.
inherited
addAll(Map other) → void
Adds all key/value pairs of other to this map.
inherited
addEntries(Iterable<MapEntry> newEntries) → void
Adds all key/value pairs of newEntries to this map.
inherited
addProp(dynamic propKey, dynamic value, [bool shouldAdd = true]) → void
Adds an arbitrary propKey/value pair if shouldAdd is true.
inherited
addProps(Map? propMap, [bool shouldAdd = true]) → void
Adds an arbitrary propMap of arbitrary props if shouldAdd is true.
inherited
addPropsToForward({Set<Type>? exclude, bool domOnly = false}) → PropsModifier

Available on T, provided by the PropsToForward extension

A utility function to be used with modifyProps to add props excluding the keys found in exclude.
addTestId(String? value, {String key = defaultTestIdKey}) → void
Adds value to the prop key (delimited with a single space).
inherited
addUnconsumedDomProps(Map props, Iterable<PropsMeta> consumedProps) → void
Copies DOM only key-value pairs from the provided props map into this map, excluding those with keys found in consumedProps.
inherited
addUnconsumedProps(Map props, Iterable<PropsMeta> consumedProps) → void
Copies key-value pairs from the provided props map into this map, excluding those with keys found in consumedProps.
inherited
build([ReactNode? children]) → ReactElement
Returns a new component with this builder's props and the specified children.
inherited
call([dynamic c1 = notSpecified, dynamic c2 = notSpecified, dynamic c3 = notSpecified, dynamic c4 = notSpecified, dynamic c5 = notSpecified, dynamic c6 = notSpecified, dynamic c7 = notSpecified, dynamic c8 = notSpecified, dynamic c9 = notSpecified, dynamic c10 = notSpecified, dynamic c11 = notSpecified, dynamic c12 = notSpecified, dynamic c13 = notSpecified, dynamic c14 = notSpecified, dynamic c15 = notSpecified, dynamic c16 = notSpecified, dynamic c17 = notSpecified, dynamic c18 = notSpecified, dynamic c19 = notSpecified, dynamic c20 = notSpecified, dynamic c21 = notSpecified, dynamic c22 = notSpecified, dynamic c23 = notSpecified, dynamic c24 = notSpecified, dynamic c25 = notSpecified, dynamic c26 = notSpecified, dynamic c27 = notSpecified, dynamic c28 = notSpecified, dynamic c29 = notSpecified, dynamic c30 = notSpecified, dynamic c31 = notSpecified, dynamic c32 = notSpecified, dynamic c33 = notSpecified, dynamic c34 = notSpecified, dynamic c35 = notSpecified, dynamic c36 = notSpecified, dynamic c37 = notSpecified, dynamic c38 = notSpecified, dynamic c39 = notSpecified, dynamic c40 = notSpecified]) → ReactElement
Creates a new component with this builder's props and the specified children.
inherited
cast<RK, RV>() → Map<RK, RV>
Provides a view of this map as having RK keys and RV instances, if necessary.
inherited
clear() → void
Removes all entries from the map.
inherited
containsKey(Object? key) → bool
Whether this map contains the given key.
inherited
containsProp(void accessProp(T spiedView)) → bool

Available on T, provided by the UiPropsSelfTypedExtension extension

Returns whether the prop read within accessProp is specified.
containsValue(Object? value) → bool
Whether this map contains the given value.
inherited
disableRequiredPropValidation() → void
Disables all prop validation for this builder, both at runtime (skipping validateRequiredProps) and within the OverReact analyzer plugin's required props lint.
inherited
forEach(void action(dynamic key, dynamic value)) → void
Applies action to each key/value pair of the map.
inherited
getPropKey(void accessProp(T)) → String

Available on T, provided by the UiPropsSelfTypedExtension extension

Returns the key used to store the prop read within accessProp.
getPropsToForward({Set<Type>? exclude, bool domOnly = false}) → Map

Available on T, provided by the PropsToForward extension

Returns a copy of this instance's props excluding the keys found in exclude.
getRequiredProp<V>(V accessProp(T spiedView), {required V orElse()}) → V

Available on T, provided by the UiPropsSelfTypedExtension extension

Returns the value of the prop read within accessProp if it's specified, or the result of orElse otherwise.
getRequiredPropOrNull<V>(V accessProp(T spiedView)) → V?

Available on T, provided by the UiPropsSelfTypedExtension extension

Returns the value of the prop read within accessProp if it's specified, or null otherwise.
getTestId({String key = defaultTestIdKey}) → String?
Gets the defaultTestIdKey prop value, or one testId from the prop (or custom key prop value).
inherited
map<K2, V2>(MapEntry<K2, V2> f(dynamic key, dynamic value)) → Map<K2, V2>
Returns a new map where all entries of this map are transformed by the given convert function.
inherited
modifyProps(PropsModifier? modifier, [bool shouldModify = true]) → void
Allows modifier to alter the instance if shouldModify is true.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putIfAbsent(dynamic key, dynamic ifAbsent()) → dynamic
Look up the value of key, or add a new entry if it isn't there.
inherited
remove(Object? key) → dynamic
Removes key and its associated value, if present, from the map.
inherited
removeWhere(bool predicate(dynamic key, dynamic value)) → void
Removes all entries of this map that satisfy the given test.
inherited
toString() → String
A string representation of this object.
inherited
update(dynamic key, dynamic update(dynamic value), {dynamic ifAbsent()?}) → dynamic
Updates the value for the provided key.
inherited
updateAll(dynamic update(dynamic key, dynamic value)) → void
Updates all values.
inherited
validateRequiredProps() → void
Validate at run-time that all required props are set.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited
operator [](Object? key) → dynamic
The value for the given key, or null if key is not in the map.
inherited
operator []=(dynamic key, dynamic value) → void
Associates the key with the given value.
inherited

Constants

$propKeys → const List<String>
$props → const List<PropDescriptor>
meta → const PropsMeta