react-cauldron
Version:
We have a library of components to display that you can expand on. We provide basic props and you can add in any extra props you wish.
68 lines (56 loc) • 3.32 kB
HTML
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl">
<title data-ice="title">React-Cauldron API Document</title>
<link type="text/css" rel="stylesheet" href="css/style.css">
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
<script src="script/prettify/prettify.js"></script>
<script src="script/manual.js"></script>
</head>
<body class="layout-container" data-ice="rootContainer">
<header>
<a href="./">Home</a>
<a href="identifiers.html">Reference</a>
<a href="source.html">Source</a>
<div class="search-box">
<span>
<img src="./image/search.png">
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
</span>
<ul class="search-result"></ul>
</div>
</header>
<nav class="navigation" data-ice="nav"><div>
<ul>
<li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">atoms</div><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/atoms/H1.js~H1.html">H1</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/atoms/H2.js~H2.html">H2</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/atoms/H3.js~H3.html">H3</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/atoms/H4.js~H4.html">H4</a></span></span></li>
<li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">molecules</div><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/molecules/Banner.js~Banner.html">Banner</a></span></span></li>
</ul>
</div>
</nav>
<div class="content" data-ice="content"><div data-ice="index" class="github-markdown"><h1 id="react-cauldron-a-react-component-library">React-Cauldron, a React Component Library</h1>
<p>We have a library of components to display that you can expand on. We provide basic props and you can add in any extra props you wish.</p>
<h2 id="commands">Commands</h2>
<p><code>npm run docs</code> will generate a documentation page for each component in a HTML file that you can open up. Currently working on an express server</p>
<h3 id="patterns">Patterns</h3>
<p>React-Cauldron follows the Atomic Design principle. Higher Order Components (HOC) are organized in the <code>src</code> folder.</p>
<h4 id="browser-support">Browser support</h4>
<p>Because we use flex to display components, React-Cauldron is supported by IE11+, Edge 14+, Firefox 50+, Chrome 49+, Safari 10+, Opera 42+, iOS Safari 9.3+, Android browser 4.4+, and Chrome for Android 56.</p>
</div>
</div>
<footer class="footer">
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(0.5.2)</span><img src="./image/esdoc-logo-mini-black.png"></a>
</footer>
<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>