UiProps class abstract

A dart.collection.MapView-like class with strongly-typed getters/setters for React props that is also capable of creating React component instances.

For use as a typed view into existing props Maps, or as a builder to create new component instances via a fluent-style interface.

Note: Implements MapViewMixin instead of extending it so that the abstract Props declarations don't need a constructor. The generated implementations can mix that functionality in.

Inheritance

• Object
• MapBase
• UiProps

Implemented types

• Map

Mixed-in types

• MapViewMixin
• PropsMapViewMixin
• ReactPropsMixin
• UbiquitousDomPropsMixin
• CssClassPropsMixin

Implementers

• UiProps

Constructors

UiProps()

Properties

aria → AriaPropsMixin

A view into this map that can be used to access aria- props, for convenience.

late, final, inherited

children ↔ List?

The children that were passed in to this component when it was built.

getter/setter pair, inherited

className ↔ String?

String of space-delimited CSS classes to be added to the resultant DOM.

getter/setter pair, inherited

classNameBlacklist ↔ String?

String of space-delimited CSS classes to be blacklisted from being added to the resultant DOM.

getter/setter pair, inherited

componentDefaultProps → Map

An unmodifiable map view of the default props for this component brought in from the componentFactory.

no setter

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 pair

dom → DomPropsMixin

A view into this map that can be used to access DOM props, for convenience.

late, final, inherited

entries → Iterable<MapEntry>

The map entries of this Map.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ String?

Unique identifier. Must be unique amongst all the ids, and contain at least one character.

getter/setter pair, inherited

isEmpty → bool

Whether there is no key/value pair in the map.

no setter, inherited

isNotEmpty → bool

Whether there is at least one key/value pair in the map.

no setter, inherited

key ↔ String?

A String that differentiates a component from its siblings.

getter/setter pair, inherited

keys → Iterable

The keys of this Map.

no setter, inherited

length → int

The number of key/value pairs in the map.

no setter, inherited

onAnimationEnd ↔ AnimationEventCallback?

Callback for when a CSS Animation has completed.

getter/setter pair, inherited

onAnimationIteration ↔ AnimationEventCallback?

Callback for when an iteration of a CSS Animation ends, and another one begins.

getter/setter pair, inherited

onAnimationStart ↔ AnimationEventCallback?

Callback for when a CSS animation has started.

getter/setter pair, inherited

onBlur ↔ FocusEventCallback?

Callback for when an element loses focus

getter/setter pair, inherited

onChange ↔ FormEventCallback?

Callback for when the content of a form element, the selection, or the checked state have changed (for , ,

getter/setter pair, inherited

onClick ↔ MouseEventCallback?

Callback for when the user clicks on an element

getter/setter pair, inherited

onContextMenu ↔ MouseEventCallback?

Callback for when the user right-clicks on an element to open a context menu

getter/setter pair, inherited

onCopy ↔ ClipboardEventCallback?

Callback for when the user copies the content of an element

getter/setter pair, inherited

onCut ↔ ClipboardEventCallback?

Callback for when the user cuts the content of an element

getter/setter pair, inherited

onDoubleClick ↔ MouseEventCallback?

Callback for when the user double-clicks on an element

getter/setter pair, inherited

onDrag ↔ MouseEventCallback?

Callback for when an element is being dragged

getter/setter pair, inherited

onDragEnd ↔ MouseEventCallback?

Callback for when the user has finished dragging an element

getter/setter pair, inherited

onDragEnter ↔ MouseEventCallback?

Callback for when the dragged element enters the drop target

getter/setter pair, inherited

onDragExit ↔ MouseEventCallback?

Callback for when the dragged element exits the drop target

getter/setter pair, inherited

onDragLeave ↔ MouseEventCallback?

Callback for when the dragged element leaves the drop target

getter/setter pair, inherited

onDragOver ↔ MouseEventCallback?

Callback for when the dragged element is over the drop target

getter/setter pair, inherited

onDragStart ↔ MouseEventCallback?

Callback for when the user starts to drag an element

getter/setter pair, inherited

onDrop ↔ MouseEventCallback?

Callback for when the dragged element is dropped on the drop target

getter/setter pair, inherited

onFocus ↔ FocusEventCallback?

Callback for when an element gets focus

getter/setter pair, inherited

onInput ↔ FormEventCallback?

Callback for when an element gets user input

getter/setter pair, inherited

onKeyDown ↔ KeyboardEventCallback?

Callback for when the user is pressing a key

getter/setter pair, inherited

onKeyPress ↔ KeyboardEventCallback?

Callback for when the user presses a key

getter/setter pair, inherited

onKeyUp ↔ KeyboardEventCallback?

Callback for when the user releases a key

getter/setter pair, inherited

onMouseDown ↔ MouseEventCallback?

Callback for when the user presses a mouse button over an element

getter/setter pair, inherited

onMouseEnter ↔ MouseEventCallback?

Callback for when the pointer is moved onto an element

getter/setter pair, inherited

onMouseLeave ↔ MouseEventCallback?

Callback for when the pointer is moved out of an element

getter/setter pair, inherited

onMouseMove ↔ MouseEventCallback?

Callback for when the pointer is moving while it is over an element

getter/setter pair, inherited

onMouseOut ↔ MouseEventCallback?

Callback for when a user moves the mouse pointer out of an element, or out of one of its children

getter/setter pair, inherited

onMouseOver ↔ MouseEventCallback?

Callback for when the pointer is moved onto an element, or onto one of its children

getter/setter pair, inherited

onMouseUp ↔ MouseEventCallback?

Callback for when a user releases a mouse button over an element

getter/setter pair, inherited

onPaste ↔ ClipboardEventCallback?

Callback for when the user pastes some content in an element

getter/setter pair, inherited

onPointerCancel ↔ PointerEventCallback?

Callback for when the pointing device is interrupted

getter/setter pair, inherited

onPointerDown ↔ PointerEventCallback?

Callback for when the pointer becomes active over an element

getter/setter pair, inherited

onPointerEnter ↔ PointerEventCallback?

Callback for when the pointer is moved onto an element

getter/setter pair, inherited

onPointerLeave ↔ PointerEventCallback?

Callback for when the pointer is moved out of an element

getter/setter pair, inherited

onPointerMove ↔ PointerEventCallback?

Callback for when the pointer is moving while it is over an element

getter/setter pair, inherited

onPointerOut ↔ PointerEventCallback?

Callback for when the pointer is moved out of an element, or out of one of its children

getter/setter pair, inherited

onPointerOver ↔ PointerEventCallback?

Callback for when the pointer is moved onto an element, or onto one of its children

getter/setter pair, inherited

onPointerUp ↔ PointerEventCallback?

Callback for when the pointer becomes inactive over an element

getter/setter pair, inherited

onReset ↔ FormEventCallback?

Callback for when a form is reset

getter/setter pair, inherited

onScroll ↔ UIEventCallback?

Callback for when an element's scrollbar is being scrolled

getter/setter pair, inherited

onSubmit ↔ FormEventCallback?

Callback for when a form is submitted

getter/setter pair, inherited

onTouchCancel ↔ TouchEventCallback?

Callback for when the touch is interrupted

getter/setter pair, inherited

onTouchEnd ↔ TouchEventCallback?

Callback for when a finger is removed from a touch screen

getter/setter pair, inherited

onTouchMove ↔ TouchEventCallback?

Callback for when a finger is dragged across the screen

getter/setter pair, inherited

onTouchStart ↔ TouchEventCallback?

Callback for when a finger is placed on a touch screen

getter/setter pair, inherited

onTransitionEnd ↔ TransitionEventCallback?

Callback for when a CSS transition has completed.

getter/setter pair, inherited

onWheel ↔ WheelEventCallback?

Callback for when the mouse wheel rolls up or down over an element

getter/setter pair, inherited

props → Map

no setter, inherited

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 pair, inherited

requiredPropNamesToSkipValidation → Set<String>

Names of props to opt out of required prop validation for.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

style ↔ Map<String, dynamic>?

An inline CSS style for the element.

getter/setter pair, inherited

tabIndex ↔ dynamic

Whether the element if focusable. Must be a valid integer or String of valid integer.

getter/setter pair, inherited

testId → String?

Gets the data-test-id prop key for use in a testing environment.

no setter

title ↔ String?

Represents advisory information about the element.

getter/setter pair, inherited

values → Iterable

The values of this Map.

no setter, inherited

Methods

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.

addProps(Map? propMap, [bool shouldAdd = true]) → void

Adds an arbitrary propMap of arbitrary props if shouldAdd is true.

addTestId(String? value, {String key = defaultTestIdKey}) → void

Adds value to the prop key (delimited with a single space).

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.

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.

build([ReactNode? children]) → ReactElement

Returns a new component with this builder's props and the specified children.

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.

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

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.

forEach(void action(dynamic key, dynamic value)) → void

Applies action to each key/value pair of the map.

inherited

getTestId({String key = defaultTestIdKey}) → String?

Gets the defaultTestIdKey prop value, or one testId from the prop (or custom key prop value).

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.

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.

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

Static Properties

testMode ↔ bool

Whether UiProps is in a testing environment.

getter/setter pair