Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jimsparkman/RiotControl
Event Controller / Dispatcher For RiotJS, Inspired By Flux
https://github.com/jimsparkman/RiotControl
Last synced: 5 days ago
JSON representation
Event Controller / Dispatcher For RiotJS, Inspired By Flux
- Host: GitHub
- URL: https://github.com/jimsparkman/RiotControl
- Owner: jimsparkman
- License: mit
- Created: 2015-01-24T20:21:29.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-09-08T16:47:43.000Z (about 7 years ago)
- Last Synced: 2024-10-27T19:55:40.546Z (12 days ago)
- Language: JavaScript
- Homepage: http://jimsparkman.github.io/RiotControl/routing_demo/
- Size: 125 KB
- Stars: 598
- Watchers: 28
- Forks: 48
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-starred - jimsparkman/RiotControl - Event Controller / Dispatcher For RiotJS, Inspired By Flux (others)
README
RiotControl
============
__UPDATE:__ Experimental multi-threaded version under [dev branch](https://github.com/jimsparkman/RiotControl/tree/dev).
```
npm install riotcontrol
```
A Simplistic Central Event Controller / Dispatcher For [RiotJS](https://github.com/muut/riotjs), Inspired By Facebook's [Flux](https://github.com/facebook/flux) Architecture Pattern.
RiotControl is, in the spirit of Riot itself, extremely lightweight. It forgoes elements of Flux, to favor small and simple applications. RiotControl passes events from views to stores, and back, relying heavily on Riot's observerable API. Stores can talk to many views, and views can talk to many stores.
Example data flow
-------
Given the following:
- A TodoList view (Riot tag)
- Triggers actions/events through RiotControl and listens for data change events.
- A TodoStore (generic JS data store)
- Mix of model manager/MVC-pattern controller that listens for actions/events, performs business logic, and dispatches data changed events.
Possible data flow:
1. TodoList view triggers 'todo_remove' event to RiotControl.
2. RiotControl passes event along to stores.
3. TodoStore implements a 'todo_remove' event handler, talks to back-end server.
4. TodoStore triggers 'todos_changed' event, with new data. (new list with the todo removed)
5. TodoList view implements a 'todos_changed' event handler, receiving new data, and updating the UI.
This encourages loosely coupled components. Stores house application logic and domain-specific data. Views comprise the user interface. Either side can be swapped out without interfering with the other. For example, a store that saves to local storage can be easily swapped for one that saves to a back-end service instead.
Demos
============
[TodoList](http://jimsparkman.github.io/RiotControl/demo/)
Reference demo/todostore.js and todo.tag to understand how this works.
[URL Routing Example](http://jimsparkman.github.io/RiotControl/routing_demo/)
Reference routing_demo/index.html, itemstore.js, and item-app.tag
[Binary Calculator](http://jimsparkman.github.io/RiotControl/binary_demo/)
Things People Have Built
============
[Flux Catalog](https://github.com/txchen/feplay/tree/gh-pages/riot_flux)
RiotJS version of the flux-comparison catalog.
[Where Da Movies At](https://github.com/derekr/wheredamoviesat)
Map of all movies in a given location.
Usage
============
Requires Riot 2.0+
Include riotcontrol.js, or it's few lines of code, in your project.
API
============
Register the store in central dispatch, where store is a riot.observable(). Generally, all stores should be created and registered before the Riot app is mounted.
```javascript
RiotControl.addStore(store)
// Example, at start of application:
var todoStore = new TodoStore() // Create a store instance.
RiotControl.addStore(todoStore) // Register the store in central dispatch.
```
Trigger event on all stores registered in central dispatch. Essentially, a 'broadcast' version of Riot's el.trigger() API.
```javascript
RiotControl.trigger(event)
RiotControl.trigger(event, arg1 ... argN)
// Example, inside Riot view (tag):
RiotControl.trigger('todo_add', { title: self.text })
```
Listen for event, and execute callback when it is triggered. This applies to all stores registered, so that you may receive the same event from multiple sources.
```javascript
RiotControl.on(event, callback)
// Example, inside Riot view (tag):
RiotControl.on('todos_changed', function(items) {
self.items = items
self.update()
})
```
Remove event listener.
```javascript
RiotControl.off(event)
RiotControl.off(event, callback)
```
Same as RiotControl.on(), executes once.
```javascript
RiotControl.one(event, callback)
```