vidom-redux

Redux bindings for Vidom

Usage no npm install needed!

<script type="module">
  import vidomRedux from 'https://cdn.skypack.dev/vidom-redux';
</script>

README

vidom-redux

Build Status NPM Version

What is it?

This module provides Redux bindings for Vidom.

Installation

npm i vidom-redux

API

This module provides:

  • <Provider> to make store available in the component hierarchy below
  • connect to connect arbitrary Vidom component to a Redux store

Provider

Provider expects store attribute to be passed.

import { mount } from 'vidom';
import { createStore } from 'redux';
import { Provider } from 'vidom-redux';
import App from './components/App';
import reducer from './reducers';

const store = createStore(reducer);

mount(
    document.getElementById('root'),
    <Provider store={ store }>
        <App/>
    </Provider>);

connect

connect wraps and connects given component to a new one which is connected to a store.

  • [{Function(storeState, ownAttrs): Object}] storeStateToAttrs maps store state to attributes of wrapped component
  • [{Object}] actionCreators action creators to be bound to store

It returns a function to wrap given component.

import { Component } from 'vidom';
import { connect } from 'vidom-redux';
import * as actions from '../actions';

class MyComponent extends Component {
    ...
}

const storeStateToAttrs = ({ subState1, subState2 }) => ({ subState1, subState2 }),
    MyConnectedComponent = connect(storeStateToAttrs, actions)(MyComponent);