appbaseio/reactivecore

Name: reactivecore

Owner: appbase.io

Description: Core architecture of reactive UI libraries

Created: 2017-11-08 16:18:54.0

Updated: 2018-05-24 09:31:53.0

Pushed: 2018-05-24 09:31:52.0

Homepage: null

Size: 179

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

reactivecore

This is the platform agnostic core architecture of reactive UI libraries.

Installation

 add @appbaseio/reactivecore

Usage and documentation

Create store:

rt configureStore from "@appbaseio/reactivecore";

Supported actions:

Import via:

rt { <actionName> } from "@appbaseio/reactivecore/lib/actions"

| Action | Usage | |—————————|:——————————————————| | addComponent | to register a component in the store | | removeComponent | to remove a component from the store | | watchComponent | to set up component subscription | | setQuery | to set the component query in the store | | setQueryOptions | to add external query options | | logQuery | Executed automatically to log query for gatekeeping | | executeQuery | Executed automatically (whenever necessary, based on the dependency tree) when the query of a component is updated| | updateHits | updates results from elasticsearch query | | updateQuery | to update the query in the store - called when a change is triggered in the component| | loadMore | for infinte loading and pagination |

Utility methods

Import via:

rt { <methodName> } from "@appbaseio/reactivecore/lib/utils"

| Method | Usage | |———————–|:———————————————————-| | isEqual | Compare two objects/arrays | | debounce | Standard debounce | | getQueryOptions | returns applied query options (supports size & from) | | pushToAndClause | Pushes component to leaf and node. Handy for internal component registration | | checkValueChange | checks and executes before/onValueChange for sensors | | getAggsOrder | returns aggs order query based on sortBy prop | | checkPropChange | checks for props changes that would need to update the query via callback | | checkSomePropChange | checks for any prop change in the propsList and invokes the callback |

Changelog

Check the Changelog doc