FluxComponent<ActionsT, StoresT> class abstract

FluxComponents are responsible for rendering application views and turning user interactions and events into Actions. FluxComponents can use data from one or many Store instances to define the resulting component.

This FluxComponent, intended for use on the client, utilizes the BatchedRedraws mixin to throttle redraws down to one per animation frame.

Inheritance

• Object
• Component
• FluxComponent

Mixed in types

• BatchedRedraws

Constructors

FluxComponent()

Properties

actions → ActionsT

The class instance defined by ActionsT that holds all Actions that this component needs access to.

no setter, inherited

childContextKeys → Iterable<String>

The keys this component uses in its child context map (returned by getChildContext).

no setter, inherited

context ↔ dynamic

The React context map of this component, passed down from its ancestors' getChildContext value.

getter/setter pair, inherited

contextKeys → Iterable<String>

The keys of context used by this component.

no setter, inherited

didDispose → Future<Null>

A Future that will complete when this object has been disposed.

no setter, inherited

displayName → String?

Allows the ReactJS displayName property to be set for debugging purposes.

no setter, inherited

disposableTypeName → String

A type name, similar to runtimeType but intended to work with minified code.

no setter, inherited

disposalTreeSize → int

The total size of the disposal tree rooted at the current Disposable instance.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

isDisposed → bool

Whether this object has been disposed.

no setter, inherited

isLeakFlagSet → bool

Whether the leak flag for this object has been set.

no setter, inherited

isOrWillBeDisposed → bool

Whether the disposal of this object has been requested, is in progress, or is complete.

no setter, inherited

jsThis → dynamic

The JavaScript ReactComponent instance of this Component returned by render.

no setter, inherited

nextContext ↔ Map?

Private reference to the value of context for the upcoming render cycle.

getter/setter pair, inherited

nextProps ↔ Map?

Reference to the value of props for the upcoming render cycle.

getter/setter pair, inherited

nextState → Map

Public getter for _nextState.

no setter, inherited

prevContext ↔ Map?

Reference to the value of context from the previous render cycle, used internally for proxying the ReactJS lifecycle method.

getter/setter pair, inherited

prevState ↔ Map?

Reference to the value of state from the previous render cycle, used internally for proxying the ReactJS lifecycle method and componentDidUpdate.

getter/setter pair, inherited

props ↔ Map

ReactJS Component props.

getter/setter pair, inherited

ref ↔ RefMethod

DEPRECATED.

getter/setter pair, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

setStateCallbacks → List

The List of callbacks to be called after the component has been updated from a call to setState.

no setter, inherited

shouldBatchRedraw ↔ bool

getter/setter pair, inherited

state ↔ Map

ReactJS Component state.

getter/setter pair, inherited

store → StoresT

The class instance defined by StoresT. This object should either be an instance of Store or should provide access to one or more Stores.

no setter, inherited

transactionalSetStateCallbacks → List

The List of transactional setState callbacks to be called before the component updates.

no setter, inherited

Methods

addSubscription(StreamSubscription subscription) → void

Register a subscription that should be canceled when the component unmounts. Cancellation will be handled automatically by componentWillUnmount.

inherited

awaitBeforeDispose<T>(Future<T> future) → Future<T>

Add future to a list of futures that will be awaited before the object is disposed.

inherited

componentDidMount() → void

ReactJS lifecycle method that is invoked once, only on the client (not on the server), immediately after the initial rendering occurs.

inherited

componentDidUpdate(Map prevProps, Map prevState) → void

ReactJS lifecycle method that is invoked immediately after the Component's updates are flushed to the DOM.

inherited

componentWillMount() → void

ReactJS lifecycle method that is invoked once, both on the client and server, immediately before the initial rendering occurs.

inherited

componentWillReceiveProps(Map newProps) → void

ReactJS lifecycle method that is invoked when a Component is receiving newProps.

inherited

componentWillReceivePropsWithContext(Map newProps, dynamic nextContext) → void

UNSUPPORTED IN COMPONENT2

This API was never stable in any version of ReactJS, and was replaced with a new, incompatible context API in ReactJS 16.

This will be completely removed alongside the Component class.

inherited

componentWillUnmount() → void

ReactJS lifecycle method that is invoked immediately before a Component is unmounted from the DOM.

componentWillUpdate(Map nextProps, Map nextState) → void

ReactJS lifecycle method that is invoked immediately before rendering when nextProps or nextState are being received.

inherited

componentWillUpdateWithContext(Map nextProps, Map nextState, Map? nextContext) → void

DEPRECATED - DO NOT USE

This API was never stable in any version of ReactJS, and was replaced with a new, incompatible context API in ReactJS 16.

This will be completely removed alongside the Component class.

inherited

dispose() → Future<Null>

Dispose of the object, cleaning up to prevent memory leaks.

inherited

flagLeak([String? description]) → void

Flag the object as having been disposed in a way that allows easier profiling.

inherited

getChildContext() → Map<String, dynamic>

Returns a Map of context to be passed to descendant components.

inherited

getDefaultProps() → Map

Invoked once and cached when registerComponent is called. Values in the mapping will be set on props if that prop is not specified by the parent component.

inherited

getInitialState() → Map

Invoked once before the Component is mounted. The return value will be used as the initial value of state.

inherited

getManagedDelayedFuture<T>(Duration duration, T callback()) → Future<T>

Creates a Future that will complete, with the value returned by callback, after the given amount of time has elapsed.

inherited

getManagedDisposer(Disposer disposer) → ManagedDisposer

Automatically handle arbitrary disposals using a callback.

inherited

getManagedPeriodicTimer(Duration duration, void callback(Timer timer)) → Timer

Creates a periodic Timer that will be cancelled if active upon disposal.

inherited

getManagedTimer(Duration duration, void callback()) → Timer

Creates a Timer instance that will be cancelled if active upon disposal.

inherited

getStoreHandlers() → Map<Store, StoreHandler>

If you need more fine-grained control over store trigger handling, override this method to return a Map of stores to handlers. Whenever a store in the returned map triggers, the respective handler will be called.

inherited

handleRedrawOn(Store store) → void

Redraws the component for a given store.

inherited

initComponentInternal(Map props, void _jsRedraw(), [RefMethod? ref, dynamic _jsThis, Map? context]) → dynamic

inherited

initStateInternal() → dynamic

inherited

listenToStoreForRedraw(Store store) → void

Used to register handleRedrawOn as a listeners for the given store.

inherited

listenToStream<T>(Stream<T> stream, void onData(T event), {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<T>

Returns a StreamSubscription which handles events from the stream using the provided onData, onError and onDone handlers.

inherited

manageAndReturnTypedDisposable<T extends Disposable>(T disposable) → T

Automatically dispose another object when this object is disposed.

inherited

manageCompleter<T>(Completer<T> completer) → Completer<T>

Ensure that a completer is completed when the object is disposed.

inherited

manageDisposable(Disposable disposable) → void

inherited

manageStreamController(StreamController controller) → void

Automatically cancel a stream controller when this object is disposed.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onDispose() → Future<Null>

Callback to allow arbitrary cleanup on dispose.

inherited

onWillDispose() → Future<Null>

Callback to allow arbitrary cleanup as soon as disposal is requested (i.e. dispose is called) but prior to disposal actually starting.

inherited

redraw([dynamic callback()?]) → void

inherited

redrawOn() → List<Store>

Define the list of Store instances that this component should listen to. When any of the returned Stores update their state, this component will redraw.

inherited

render() → dynamic

Required.

inherited

replaceState(Map? newState, [dynamic callback()?]) → void

Set _nextState to provided newState value and force a re-render.

inherited

setState(covariant dynamic newState, [dynamic callback()?]) → void

Triggers a rerender with new state obtained by shallow-merging newState into the current state.

inherited

shouldComponentUpdate(Map nextProps, Map nextState) → bool

ReactJS lifecycle method that is invoked before rendering when nextProps or nextState are being received.

inherited

shouldComponentUpdateWithContext(Map nextProps, Map nextState, Map? nextContext) → bool?

DEPRECATED - DO NOT USE

This API was never stable in any version of ReactJS, and was replaced with a new, incompatible context API in ReactJS 16.

This will be completely removed alongside the Component class.

inherited

toString() → String

A string representation of this object.

inherited

transferComponentState() → void

Transfers Component _nextState to state, and state to prevState.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited