docs/dist/flummox/docs/api.md/index.html
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>Flummox | Minimal, isomorphic Flux</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="/flummox/css/app.min.css">
</head>
<body>
<div id="app"><div data-reactid=".27d0epwuvpc" data-react-checksum="-1207867976"><div style="height:2.25rem;" class="View" data-reactid=".27d0epwuvpc.0"><div class="View" style="background-color:#2083E0;position:fixed;width:100%;z-index:9999;" data-reactid=".27d0epwuvpc.0.0"><div class="View" data-reactid=".27d0epwuvpc.0.0.0"><div class="View" data-reactid=".27d0epwuvpc.0.0.0.0"><a href="/" style="padding:0.375rem 0.75rem;color:#fff;width:100%;text-decoration:none;border:inherit solid 1px;border-width:;border-style:;" data-reactid=".27d0epwuvpc.0.0.0.0.0">Flummox</a></div></div><div class="View View--justifyContentFlexEnd View--flexGrow" data-reactid=".27d0epwuvpc.0.0.1"><div class="View" data-reactid=".27d0epwuvpc.0.0.1.0"><a href="/flummox/docs/guides" style="padding:0.375rem 0.75rem;color:#fff;width:100%;text-decoration:none;border:inherit solid 1px;border-width:;border-style:;" data-reactid=".27d0epwuvpc.0.0.1.0.0">Guides</a><div class="View View--flexDirectionColumn" style="display:none;background-color:#2083E0;position:absolute;right:0;top:100%;width:16em;text-align:right;" data-reactid=".27d0epwuvpc.0.0.1.0.1"><div class="View" data-reactid=".27d0epwuvpc.0.0.1.0.1.0"><a href="/flummox/docs/guides/quick-start" style="padding:0.375rem 0.75rem;color:#fff;width:100%;text-decoration:none;border:inherit solid 1px;border-width:;border-style:;" data-reactid=".27d0epwuvpc.0.0.1.0.1.0.0">Quick Start</a></div><div class="View" data-reactid=".27d0epwuvpc.0.0.1.0.1.1"><a href="/flummox/docs/guides/react-integration" style="padding:0.375rem 0.75rem;color:#fff;width:100%;text-decoration:none;border:inherit solid 1px;border-width:;border-style:;" data-reactid=".27d0epwuvpc.0.0.1.0.1.1.0">React Integration</a></div><div class="View" data-reactid=".27d0epwuvpc.0.0.1.0.1.2"><a href="/flummox/docs/guides/why-flux-component-is-better-than-flux-mixin" style="padding:0.375rem 0.75rem;color:#fff;width:100%;text-decoration:none;border:inherit solid 1px;border-width:;border-style:;" data-reactid=".27d0epwuvpc.0.0.1.0.1.2.0">Why FluxComponent > fluxMixin</a></div></div></div><div class="View" data-reactid=".27d0epwuvpc.0.0.1.1"><a href="/flummox/docs/api" style="padding:0.375rem 0.75rem;color:#fff;width:100%;text-decoration:none;border:inherit solid 1px;border-width:;border-style:;" data-reactid=".27d0epwuvpc.0.0.1.1.0">API</a><div class="View View--flexDirectionColumn" style="display:none;background-color:#2083E0;position:absolute;right:0;top:100%;width:16em;text-align:right;" data-reactid=".27d0epwuvpc.0.0.1.1.1"><div class="View" data-reactid=".27d0epwuvpc.0.0.1.1.1.0"><a href="/flummox/docs/api/store" style="padding:0.375rem 0.75rem;color:#fff;width:100%;text-decoration:none;border:inherit solid 1px;border-width:;border-style:;" data-reactid=".27d0epwuvpc.0.0.1.1.1.0.0">Store</a></div><div class="View" data-reactid=".27d0epwuvpc.0.0.1.1.1.1"><a href="/flummox/docs/api/flux" style="padding:0.375rem 0.75rem;color:#fff;width:100%;text-decoration:none;border:inherit solid 1px;border-width:;border-style:;" data-reactid=".27d0epwuvpc.0.0.1.1.1.1.0">Flux</a></div><div class="View" data-reactid=".27d0epwuvpc.0.0.1.1.1.2"><a href="/flummox/docs/api/actions" style="padding:0.375rem 0.75rem;color:#fff;width:100%;text-decoration:none;border:inherit solid 1px;border-width:;border-style:;" data-reactid=".27d0epwuvpc.0.0.1.1.1.2.0">Actions</a></div><div class="View" data-reactid=".27d0epwuvpc.0.0.1.1.1.3"><a href="/flummox/docs/api/fluxcomponent" style="padding:0.375rem 0.75rem;color:#fff;width:100%;text-decoration:none;border:inherit solid 1px;border-width:;border-style:;" data-reactid=".27d0epwuvpc.0.0.1.1.1.3.0">FluxComponent</a></div><div class="View" data-reactid=".27d0epwuvpc.0.0.1.1.1.4"><a href="/flummox/docs/api/higher-order-component" style="padding:0.375rem 0.75rem;color:#fff;width:100%;text-decoration:none;border:inherit solid 1px;border-width:;border-style:;" data-reactid=".27d0epwuvpc.0.0.1.1.1.4.0">Higher-order component</a></div><div class="View" data-reactid=".27d0epwuvpc.0.0.1.1.1.5"><a href="/flummox/docs/api/fluxmixin" style="padding:0.375rem 0.75rem;color:#fff;width:100%;text-decoration:none;border:inherit solid 1px;border-width:;border-style:;" data-reactid=".27d0epwuvpc.0.0.1.1.1.5.0">fluxMixin</a></div></div></div><div class="View" data-reactid=".27d0epwuvpc.0.0.1.2"><a href="https://github.com/acdlite/flummox" style="padding:0.375rem 0.75rem;color:#fff;width:100%;text-decoration:none;border:inherit solid 1px;border-width:;border-style:;" data-reactid=".27d0epwuvpc.0.0.1.2.0">GitHub</a></div></div></div></div><span data-reactid=".27d0epwuvpc.1"><div data-reactid=".27d0epwuvpc.1.$=1$/flummox/docs/api"><article class="Doc" style="padding:3rem 0;" data-reactid=".27d0epwuvpc.1.$=1$/flummox/docs/api.0"><div class="Container" data-reactid=".27d0epwuvpc.1.$=1$/flummox/docs/api.0.0"><div class="Doc-content" data-reactid=".27d0epwuvpc.1.$=1$/flummox/docs/api.0.0.0"><h1>API</h1>
<p>Flummox has three exports:</p>
<ul>
<li><a href="api/actions.md">Actions</a></li>
<li><a href="api/store.md">Store</a></li>
<li><a href="api/flux.md">Flux</a> (also available as <code>Flummox</code>) This is the default export.</li>
</ul>
<p>If you’re using ES6 module syntax:</p>
<pre><code class="language-js">import { Flux } from 'flummox';
</code></pre>
<p>Or multiple classes at once:</p>
<pre><code class="language-js">import { Flux, Store, Actions } from 'flummox';
</code></pre>
<h2>Addons</h2>
<p>Flummox also comes with some addons. These are not part of the main export. That way, if you don’t use them, they won’t increase the size of your bundle.</p>
<ul>
<li><a href="api/fluxcomponent.md">FluxComponent</a></li>
<li><a href="api/fluxmixin.md">fluxMixin</a></li>
<li><a href="api/higher-order-component.md">Higher-order component</a></li>
</ul>
<p>Refer to the <a href="../guides/react-integration.md">React integration guide</a> for details.</p>
<pre><code class="language-js">import fluxMixin from 'flummox/mixin';
import FluxComponent from 'flummox/component';
import connectToStores from 'flummox/connect';
</code></pre>
</div></div></article></div></span></div></div>
<script src="/flummox/js/app.min.js" defer></script>
</body>
</html>