FluxComponent<ActionsT, StoresT> class

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
Mixed in types

Constructors

FluxComponent()

Properties

actions → ActionsT
The class instance defined by ActionsT that holds all Actions that this component needs access to.
read-only, inherited
childContextKeys Iterable<String>
The keys this component uses in its child context map (returned by getChildContext). [...]
read-only, inherited
context Map
The React context map of this component, passed down from its ancestors' getChildContext value. [...]
read / write, inherited
contextKeys Iterable<String>
The keys of context used by this component. [...]
read-only, inherited
didDispose Future<Null>
A Future that will complete when this object has been disposed.
read-only, inherited
displayName String
Allows the ReactJS displayName property to be set for debugging purposes.
read-only, inherited
disposalTreeSize int
The total size of the disposal tree rooted at the current Disposable instance. [...]
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
isDisposed bool
Whether this object has been disposed.
read-only, inherited
isDisposedOrDisposing bool
Whether this object has been disposed or is currently disposing. [...]
read-only, inherited
isDisposing bool
Whether this object is in the process of being disposed. [...]
read-only, inherited
isLeakFlagSet bool
Whether the leak flag for this object has been set. [...]
read-only, inherited
isOrWillBeDisposed bool
Whether the disposal of this object has been requested, is in progress, or is complete. [...]
read-only, inherited
jsThis → dynamic
The JavaScript ReactComponent instance of this Component returned by render.
read-only, inherited
nextContext Map
Private reference to the value of context for the upcoming render cycle. [...]
read / write, inherited
nextProps Map
Reference to the value of props for the upcoming render cycle. [...]
read / write, inherited
nextState Map
Public getter for _nextState. [...]
read-only, inherited
prevContext Map
Reference to the value of context from the previous render cycle, used internally for proxying the ReactJS lifecycle method. [...]
read / write, inherited
prevState Map
Reference to the value of state from the previous render cycle, used internally for proxying the ReactJS lifecycle method and componentDidUpdate. [...]
read / write, inherited
props Map
ReactJS Component props. [...]
read / write, inherited
ref ↔ Ref
A function that returns a component reference: [...]
read / write, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
setStateCallbacks List
The List of callbacks to be called after the component has been updated from a call to setState.
read-only, inherited
shouldBatchRedraw bool
read / write, inherited
state Map
ReactJS Component state. [...]
read / write, 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.
read-only, inherited
transactionalSetStateCallbacks List
The List of transactional setState callbacks to be called before the component updates.
read-only, inherited

Methods

componentWillUnmount() → void
ReactJS lifecycle method that is invoked immediately before a Component is unmounted from the DOM. [...]
@mustCallSuper
addSubscription(StreamSubscription subscription) → void
Register a subscription that should be canceled when the component unmounts. Cancellation will be handled automatically by componentWillUnmount.
@Deprecated('Subscriptions are now managed by the Disposable mixin. $v3Deprecation'), inherited
awaitBeforeDispose<T>(Future<T> future) Future<T>
Add future to a list of futures that will be awaited before the object is disposed. [...]
@mustCallSuper, inherited
bind(dynamic key) → dynamic
Bind the value of input to [statekey].
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.
@mustCallSuper, inherited
componentWillReceiveProps(Map newProps) → void
ReactJS lifecycle method that is invoked when a Component is receiving newProps. [...]
inherited
componentWillReceivePropsWithContext(Map newProps, dynamic nextContext) → void
ReactJS lifecycle method that is invoked when a Component is receiving newProps. [...]
inherited
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
ReactJS lifecycle method that is invoked immediately before rendering when nextProps, nextState, or nextContext are being received. [...]
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. [...]
@mustCallSuper, inherited
getChildContext() Map<String, dynamic>
Returns a Map of context to be passed to descendant components. [...]
inherited
getDefaultProps() Map
Invoked once and cached when reactComponentClass 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. [...]
@mustCallSuper, inherited
getManagedDisposer(Disposer disposer) ManagedDisposer
Automatically handle arbitrary disposals using a callback. [...]
@mustCallSuper, inherited
getManagedPeriodicTimer(Duration duration, void callback(Timer timer)) Timer
Creates a periodic Timer that will be cancelled if active upon disposal.
@mustCallSuper, inherited
getManagedTimer(Duration duration, void callback()) Timer
Creates a Timer instance that will be cancelled if active upon disposal.
@mustCallSuper, 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.
@mustCallSuper, @protected, inherited
initComponentInternal(dynamic props, dynamic _jsRedraw, [ Ref ref, dynamic _jsThis, dynamic context ]) → dynamic
inherited
initStateInternal() → dynamic
inherited
listenToStoreForRedraw(Store store) → void
Used to register handleRedrawOn as a listeners for the given store.
@protected, 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. [...]
@mustCallSuper, inherited
manageAndReturnDisposable(Disposable disposable) Disposable
Automatically dispose another object when this object is disposed. [...]
@mustCallSuper, inherited
manageAndReturnTypedDisposable<T extends Disposable>(T disposable) → T
Automatically dispose another object when this object is disposed. [...]
@mustCallSuper, inherited
manageCompleter<T>(Completer<T> completer) Completer<T>
Ensure that a completer is completed when the object is disposed. [...]
@mustCallSuper, inherited
manageDisposable(Disposable disposable) → void
Automatically dispose another object when this object is disposed. [...]
@mustCallSuper, inherited
manageDisposer(Disposer disposer) → void
Automatically handle arbitrary disposals using a callback. [...]
@mustCallSuper, inherited
manageStreamController(StreamController controller) → void
Automatically cancel a stream controller when this object is disposed. [...]
@mustCallSuper, inherited
manageStreamSubscription(StreamSubscription subscription) → void
Automatically cancel a stream subscription when this object is disposed. [...]
@mustCallSuper, inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
onDispose() Future<Null>
Callback to allow arbitrary cleanup on dispose.
@protected, 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. [...]
@protected, 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(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
ReactJS lifecycle method that is invoked before rendering when nextProps, nextState, or nextContext are being received. [...]
inherited
toString() String
Returns a string representation of this object.
inherited
transferComponentState() → void
Transfers Component _nextState to state, and state to prevState.
inherited

Operators

operator ==(dynamic other) bool
The equality operator. [...]
inherited