UNPKG

mikit-framework

Version:

A web framework for professional developers and designers alike.

312 lines (234 loc) 14.2 kB
<!DOCTYPE html> <html> <head> <title>Mikit</title> <!-- Mikit core CSS --> <link rel="stylesheet" type="text/css" href="../dist/css/mikit.min.css"/> <script type="text/javascript" src="../dist/js/jquery.min.js"></script> <script type="text/javascript" src="../dist/js/mikit.min.js"></script> <style> .component-index-box { counter-reset: count; max-width: 400px; margin: 30px auto 60px auto; padding: 32px; background: #fbfbfb; border: 1px solid rgba(0, 0, 0, 0.08); } .component-index-box li { line-height: 40px; border-bottom: 1px solid rgba(0, 0, 0, 0.06); margin-right: 24px; counter-increment: count; } .component-index-box li a { display: block; text-decoration: none; position: relative; padding-left: 10px; } .component-show { width: 1180px; margin: 0 auto; } .example { border: 1px solid rgba(0, 0, 0, 0.07); padding: 32px; margin-bottom: 16px; } #navbar-demo { display: flex; align-items: center; background: #f8f8f8; padding: 24px 20px; margin-bottom: 24px; } #navbar-brand { margin-right: 24px; } #navbar-main ul:after { content: ''; display: table; clear: both; } #navbar-main li { float: left; margin-right: 20px; } #navbar-demo.fixed { background: rgba(255, 255, 255, 0.98); box-shadow: 0 1px 2px rgba(0, 0, 0, 0.2); } #navbar-main li a { color: #000; text-decoration: none; display: block; } #navbar-main li a:hover { -moz-transition: all linear 0.2s; transition: all linear 0.2s; color: rgba(0, 0, 0, 0.6); text-decoration: underline; } @media (max-width: 768px) { #navbar-demo { flex-direction: column; text-align: center; } #navbar-brand { margin: 0; margin-bottom: 20px; } #navbar-main li { float: none; margin: 0; margin-bottom: 20px; } } </style> </head> <body> <div class="component-index-box"> <ol> <li><a href="#h-demo">Demo</a></li> <li><a href="#h-usage">Usage</a></li> <li><a href="#h-multiple-targets">Multiple targets</a></li> <li><a href="#h-settings">Settings</a></li> <li><a href="#h-callbacks">Callbacks</a></li> <li><a href="#h-api">API</a></li> </ol> </div> <div class="component-show"> <!------------------------------------------------------------------> <h3 class="section-head" id="h-demo">Demo</h3> <p>Toggleme works on mobile devices as well as on desktops. To see Toggleme in action, just resize this window or open this page on a mobile device.</p> <div class="example"> <div class="mi-show-sm"> <a href="#" data-component="toggleme" data-target="#navbar"><b>Toggle</b></a> </div> <div id="navbar" class="mi-hide-sm"> <div id="navbar-demo"> <nav id="navbar-main"> <ul> <li><a href="#">Shop</a></li> <li><a href="#">News</a></li> <li><a href="#">Contact</a></li> <li><a href="#">Blog</a></li> <li><a href="#">Account</a></li> </ul> </nav> </div> </div> <pre class="code skip"><span class="mjs-tag">&lt;<span class="mjs-name">div</span> <span class="mjs-attr">class</span>=<span class="mjs-string">"mi-show-sm"</span>&gt;</span> <span class="mjs-tag">&lt;<span class="mjs-name">a</span> <span class="mjs-attr">href</span>=<span class="mjs-string">"#"</span> <span class="mjs-attr">data-component</span>=<span class="mjs-string">"toggleme"</span> <span class="mjs-attr">data-target</span>=<span class="mjs-string">"#navbar"</span>&gt;</span>Toggle<span class="mjs-tag">&lt;/<span class="mjs-name">a</span>&gt;</span> <span class="mjs-tag">&lt;/<span class="mjs-name">div</span>&gt;</span> <span class="mjs-tag">&lt;<span class="mjs-name">nav</span> <span class="mjs-attr">id</span>=<span class="mjs-string">"navbar"</span> <span class="mjs-attr">class</span>=<span class="mjs-string">"mi-hide-sm"</span>&gt;</span> <span class="mjs-tag">&lt;<span class="mjs-name">ul</span>&gt;</span> <span class="mjs-tag">&lt;<span class="mjs-name">li</span>&gt;</span><span class="mjs-tag">&lt;<span class="mjs-name">a</span> <span class="mjs-attr">href</span>=<span class="mjs-string">"#"</span>&gt;</span>...<span class="mjs-tag">&lt;/<span class="mjs-name">a</span>&gt;</span><span class="mjs-tag">&lt;/<span class="mjs-name">li</span>&gt;</span> <span class="mjs-tag">&lt;/<span class="mjs-name">ul</span>&gt;</span> <span class="mjs-tag">&lt;/<span class="mjs-name">nav</span>&gt;</span> </pre> </div> <!------------------------------------------------------------------> <h3 class="section-head" id="h-usage">Usage</h3> <div class="example"> <p><button class="mi-button mi-button-outline" data-component="toggleme" data-target="#togglebox-target-1" data-text="Hide Me">Show Me</button></p> <div id="togglebox-target-1" class="togglebox-box mi-hide"> <h3>Ok, I'm opened. Now hide me</h3> <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p> </div> <pre class="code skip">&lt;button data-component=<span class="mjs-string">"toggleme"</span> data-target=<span class="mjs-string">"#togglebox-target"</span> data-<span class="mjs-built_in">text</span>=<span class="mjs-string">"Hide Me"</span>&gt;Show Me&lt;/button&gt; &lt;<span class="mjs-keyword">div</span> <span class="mjs-built_in">id</span>=<span class="mjs-string">"togglebox-target"</span> <span class="mjs-built_in">class</span>=<span class="mjs-string">"mi-hide"</span>&gt; ... &lt;/<span class="mjs-keyword">div</span>&gt; </pre> </div> <!------------------------------------------------------------------> <h3 class="section-head" id="h-multiple-targets">Multiple targets</h3> <div class="example"> <p><button class="button primary outline" data-component="toggleme" data-target="#togglebox-target-3, #togglebox-target-4" data-text="Hide Me">Show Me</button></p> <div id="togglebox-target-3" class="togglebox-box mi-hide"> <h3>Ok, I'm opened. Now hide me</h3> <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p> </div> <div id="togglebox-target-4" class="togglebox-box mi-hide"> <h3>... and, I'm opened too. Now hide me</h3> <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p> </div> <pre class="code skip">&lt;button data-component=<span class="mjs-string">"toggleme"</span> data-target=<span class="mjs-string">"#togglebox-target-3, #togglebox-target-4"</span> data-<span class="mjs-built_in">text</span>=<span class="mjs-string">"Hide Me"</span>&gt;Show Me&lt;/button&gt; &lt;<span class="mjs-keyword">div</span> <span class="mjs-built_in">id</span>=<span class="mjs-string">"togglebox-target-3"</span> <span class="mjs-built_in">class</span>=<span class="mjs-string">"mi-hide"</span>&gt; ... &lt;/<span class="mjs-keyword">div</span>&gt; &lt;<span class="mjs-keyword">div</span> <span class="mjs-built_in">id</span>=<span class="mjs-string">"togglebox-target-4"</span> <span class="mjs-built_in">class</span>=<span class="mjs-string">"mi-hide"</span>&gt; ... &lt;/<span class="mjs-keyword">div</span>&gt; </pre> </div> <!------------------------------------------------------------------> <h3 class="section-head" id="h-settings">Settings</h3> <h5>target</h5> <ul> <li>Type: <var>string</var></li> <li>Default: <var>null</var></li> <li>Possible values: <var>selector/selectors</var></li> </ul> <p>Defines which layer or layers should be displayed upon clicking the "open" button.</p> <pre class="code skip">&lt;<span class="mjs-keyword">button </span><span class="mjs-meta">data</span>-component=<span class="mjs-string">"toggleme"</span> <span class="mjs-meta">data</span>-target=<span class="mjs-string">"#togglebox-target"</span>&gt;Show Me&lt;/<span class="mjs-keyword">button&gt; </span> &lt;<span class="mjs-keyword">button </span><span class="mjs-meta">data</span>-component=<span class="mjs-string">"toggleme"</span> <span class="mjs-meta">data</span>-target=<span class="mjs-string">"#togglebox-target-1, #togglebox-target-2"</span>&gt;Show Me&lt;/<span class="mjs-keyword">button&gt; </span> &lt;<span class="mjs-keyword">button </span><span class="mjs-meta">data</span>-component=<span class="mjs-string">"toggleme"</span> <span class="mjs-meta">data</span>-target=<span class="mjs-string">".togglebox-target"</span>&gt;Show Me&lt;/<span class="mjs-keyword">button&gt; </span> </pre> <h5>text</h5> <ul> <li>Type: <var>string</var></li> <li>Default: <var>''</var></li> </ul> <p>Defines what text should a button have after the layer has been opened. If not set, button text will not change.</p> <pre class="code skip">&lt;<span class="mjs-keyword">button </span><span class="mjs-meta">data</span>-component=<span class="mjs-string">"toggleme"</span> <span class="mjs-meta">data</span>-target=<span class="mjs-string">"#togglebox-target"</span> <span class="mjs-meta">data</span>-text=<span class="mjs-string">"Hide Me"</span>&gt;Show Me&lt;/<span class="mjs-keyword">button&gt; </span> </pre> <!------------------------------------------------------------------> <h3 class="section-head" id="h-callbacks">Callbacks</h3> <h5>open</h5> <pre class="code skip">$(<span class="mjs-string">'#togglebox-target'</span>).on(<span class="mjs-string">'open.toggleme'</span>, <span class="mjs-function"><span class="mjs-keyword">function</span>(<span class="mjs-params"></span>) </span>{ <span class="mjs-comment">// do something...</span> }); </pre> <h5>opened</h5> <pre class="code skip">$(<span class="mjs-string">'#togglebox-target'</span>).on(<span class="mjs-string">'opened.toggleme'</span>, <span class="mjs-function"><span class="mjs-keyword">function</span>(<span class="mjs-params"></span>) </span>{ <span class="mjs-comment">// do something...</span> }); </pre> <h5>close</h5> <pre class="code skip">$(<span class="mjs-string">'#togglebox-target'</span>).on(<span class="mjs-string">'close.toggleme'</span>, <span class="mjs-function"><span class="mjs-keyword">function</span>(<span class="mjs-params"></span>) </span>{ <span class="mjs-comment">// do something...</span> }); </pre> <h5>closed</h5> <pre class="code skip">$(<span class="mjs-string">'#togglebox-target'</span>).on(<span class="mjs-string">'closed.toggleme'</span>, <span class="mjs-function"><span class="mjs-keyword">function</span>(<span class="mjs-params"></span>) </span>{ <span class="mjs-comment">// do something...</span> }); </pre> <!------------------------------------------------------------------> <h3 class="section-head" id="h-api">API</h3> <h5>toggle</h5> <pre class="code skip"><span class="mjs-variable">$(</span><span class="mjs-string">'#togglebox-target'</span>).toggleme(<span class="mjs-string">'toggle'</span>);</pre> <h5>open</h5> <pre class="code skip"><span class="mjs-variable">$(</span><span class="mjs-string">'#togglebox-target'</span>).toggleme(<span class="mjs-string">'open'</span>);</pre> <h5>close</h5> <pre class="code skip"><span class="mjs-variable">$(</span><span class="mjs-string">'#togglebox-target'</span>).toggleme(<span class="mjs-string">'close'</span>);</pre> <h5>isOpened</h5> <pre class="code skip"><span class="mjs-keyword">var</span> isOpened = $(<span class="mjs-string">'#togglebox-target'</span>).toggleme(<span class="mjs-string">'isOpened'</span>);</pre> <h5>isClosed</h5> <pre class="code skip"><span class="mjs-keyword">var</span> isClosed = $(<span class="mjs-string">'#togglebox-target'</span>).toggleme(<span class="mjs-string">'isClosed'</span>);</pre> <h5>destroy</h5> <pre class="code skip"><span class="mjs-variable">$(</span><span class="mjs-string">'#togglebox-target'</span>).toggleme(<span class="mjs-string">'destroy'</span>);</pre> </div> </body> </html>