API Documentation

The coflux API is simple. There are 2 parts to it. The Provider HOC, and the wrap function which generates a HOC wrapped around your components.

The idea with coflux is that at the top of your React tree, is the coflux Provider. This is nearly the same as react-redux's Provider component in which it provides the state for the entire app. However, once you define your state, the only aspect you need to know about it is the path to key's you want the values from. This will be explained in more depth later. For now, let's look at the Provider API.