Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lastmjs/redux-store-element
A custom element allowing a more declarative use of Redux.
https://github.com/lastmjs/redux-store-element
angular custom-elements lit-html polymer redux skatejs vuejs webcomponents
Last synced: 2 months ago
JSON representation
A custom element allowing a more declarative use of Redux.
- Host: GitHub
- URL: https://github.com/lastmjs/redux-store-element
- Owner: lastmjs
- License: mit
- Created: 2016-03-31T22:19:36.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-12-21T22:48:49.000Z (about 5 years ago)
- Last Synced: 2024-10-13T08:33:12.695Z (2 months ago)
- Topics: angular, custom-elements, lit-html, polymer, redux, skatejs, vuejs, webcomponents
- Language: JavaScript
- Homepage:
- Size: 833 KB
- Stars: 82
- Watchers: 9
- Forks: 3
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://circleci.com/gh/lastmjs/redux-store-element) [](https://www.npmjs.com/package/redux-store-element) [](https://david-dm.org/lastmjs/redux-store-element) [](https://david-dm.org/lastmjs/redux-store-element?type=dev) [](https://www.webcomponents.org/element/lastmjs/redux-store-element)
# <redux-store>
A custom element allowing a more declarative use of Redux.
# Introduction
This custom element offers the basic Redux API declaratively. Because this is a custom element based on the [web components](https://www.webcomponents.org/) standards, it should be compatible with all major front-end JavaScript frameworks and libraries that interoperate with custom elements, including [Polymer](https://github.com/Polymer/polymer), [SkateJS](https://github.com/skatejs/skatejs), [Vue.js](https://github.com/vuejs/vue), [Angular](https://github.com/angular/angular), vanilla JavaScript, etc. See [here](https://custom-elements-everywhere.com/) for more information on interoperability of other frameworks and libraries with custom elements.
## Simple and Declarative
Before we begin, I just want to highlight how easy it is to work with this element declaratively (using Polymer data binding syntax):
* Hook up your root reducer (similar to Redux `createStore`):
```
// HTML
// JS
import {RootReducer} from '../../redux/reducers';
...
connectedCallback() {
this.rootReducer = RootReducer;
}
```
* Dispatch actions (similar to Redux `dispatch`):
```
// HTML
// JS
fireAnAction() {
this.action = {
type: 'CHANGE_THE_STATE'
};
}
```
* Listen for state changes (similar to Redux `subscribe`):
```
// HTML
[[valueToBind]]
// JS
stateChange(e) {
const state = e.detail.state;
this.valueToBind = state.valueToBind;
}
```
* Explicitly grab the state (similar to Redux `getState`):
```
// HTML
// JS
getReduxState() {
const reduxStoreElement = this.querySelector('#redux-store-element');
const state = reduxStoreElement.getState();
}
```
# Installation and Setup
Run the following:
```
npm install redux-store-element
```
Now import `redux-store-element.js`:
```
// HTML
// JavaScript
import 'redux-store-element';
```
This custom element depends on the custom elements and HTML imports web component specifications, which are not supported by all browsers yet. Include the webcomponentjs polyfills to ensure support across all modern browsers:
```
// CONSOLE
npm install --save @webcomponents/webcomponentsjs
// HTML
<script src="node_modules/webcomponentsjs/webcomponents-lite.js">
```
This custom element also depends on native ES Modules support and bare specifier support. Use a bundler like [Rollup](https://github.com/rollup/rollup) or [Webpack](https://github.com/webpack/webpack) if your environment doesn't support ES Modules. If your environment does support ES Modules and you do not wish to use a bundler, you will need to use a static file server that provides rewrites for bare specifiers like [Polyserve](https://github.com/Polymer/polyserve) or [Zwitterion](https://github.com/lastmjs/zwitterion).
The following examples are written with Polymer. It shouldn't be too hard to adapt them to other libraries and frameworks, keeping in mind their data binding systems and DOM interactions. This documentation is outdated, using HTML Imports instead of ES Modules, and will be updated in the future:
## Creating the root reducer
At some point before you begin dispatching actions, you need to pass in your root reducer to any `` element through the root-reducer attribute. From the example:
```
Polymer({
is: 'test-app',
ready: function() {
var initialState = {
temp: 'initial temp'
};
this.rootReducer = function(state, action) {
if (!state) {
return initialState;
}
switch(action.type) {
case 'CHANGE_TEMP': {
var newState = Object.assign({}, state);
newState.temp = action.newTemp;
return newState;
}
default: {
return state;
}
};
};
}
});
```
## Subscribing to state changes
If your component needs to listen to state changes, simply pop a `` element in and pass a listener function name in for the `statechange` event. From the example:
```
Text from input above will go here
Polymer({
is: 'test-text',
mapStateToThis: function(e) {
this.$.testText.innerHTML = e.detail.state.temp;
}
});
```
## Dispatching actions
To dispatch from within an element, first bind the action property of the element to the action property on ``. When you are ready to dispatch an action, set the action property on the element to the action that you want to dispatch. From the example:
```
Dispatch
Polymer({
is: 'test-input-area',
handleClick: function(e) {
this.action = {
type: 'CHANGE_TEMP',
newTemp: this.$.testInput.value
};
}
});
```
## Multiple Stores
By default, there is one store for the entire application, meaning that each instance of a `` will use the same store. You can however use multiple stores if you've determined it is necessary for your application. Simply reference the store name as follows:
* Hook up your root reducer: ``
* Dispatch actions: ``
* Listen for state changes: ``
## Important Things to Know:
* Your runtime environment must support ES Modules natively. Check [here](https://caniuse.com/#feat=es6-module) for compatibility
* You must pass in your root reducer to any `` before actions will be dispatched and state change events raised
* By default there is one store for the entire application. Each instance of a `` will use the same store
* The `statechange` event supplies the redux state in the `detail.state` property of the event
## Development
```
npm install
npm run test-window
```