Skip to content

Commit 94184f7

Browse files
committed
readme/doc
1 parent 0070dc0 commit 94184f7

File tree

7 files changed

+154
-91
lines changed

7 files changed

+154
-91
lines changed

docs/assets/main.js

Lines changed: 55 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/style.css

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -483,10 +483,9 @@ blockquote {
483483
.has-menu .col-menu {
484484
visibility: visible;
485485
transform: translate(0, 0);
486-
display: grid;
487-
align-items: center;
488-
grid-template-rows: auto 1fr;
489-
grid-gap: 1.5rem;
486+
display: flex;
487+
flex-direction: column;
488+
gap: 1.5rem;
490489
max-height: 100vh;
491490
padding: 1rem 2rem;
492491
}
@@ -911,7 +910,7 @@ a.tsd-index-link {
911910
margin-right: 0.8rem;
912911
}
913912

914-
@media (min-width: 1024px) {
913+
@media (min-width: 1025px) {
915914
.col-content {
916915
margin: 2rem auto;
917916
}

docs/classes/Drawer.html

Lines changed: 78 additions & 68 deletions
Large diffs are not rendered by default.

docs/functions/install.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1>Function install</h1></div>
2121
<li class="tsd-description">
2222
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
2323
<ul>
24-
<li>Defined in index.d.ts:182</li></ul></aside></li></ul></section></div>
24+
<li>Defined in index.d.ts:183</li></ul></aside></li></ul></section></div>
2525
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
2626
<div class="tsd-navigation settings">
2727
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/index.html

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -433,14 +433,14 @@ <h3>Repo Setup</h3>
433433
<a href="#build" id="build" style="color: inherit; text-decoration: none;">
434434
<h3>Build</h3>
435435
</a>
436-
<pre><code class="language-bash"><span class="hl-1">npm run build.all</span>
436+
<pre><code class="language-bash"><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">build.all</span>
437437
</code></pre>
438438
<p>WARNING: it seems <code>yarn build.all</code> wont always work (not finding binaries in <code>node_modules/.bin</code>) which is why the doc explicitly uses <code>npm run</code></p>
439439

440440
<a href="#demos" id="demos" style="color: inherit; text-decoration: none;">
441441
<h3>Demos</h3>
442442
</a>
443-
<pre><code class="language-bash"><span class="hl-1">npm run demo.[ng|react|svelte|vue].[ios|android]</span><br/><br/><span class="hl-1">npm run demo.svelte.ios </span><span class="hl-8"># Example</span>
443+
<pre><code class="language-bash"><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">demo.[ng</span><span class="hl-1">|</span><span class="hl-4">react</span><span class="hl-1">|</span><span class="hl-4">svelte</span><span class="hl-1">|</span><span class="hl-4">vue].[ios</span><span class="hl-1">|</span><span class="hl-4">android]</span><br/><br/><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">demo.svelte.ios</span><span class="hl-1"> </span><span class="hl-8"># Example</span>
444444
</code></pre>
445445
<p>Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in <code>demo-[ng|react|svelte|vue]</code>
446446
Instead you work in <code>demo-snippets/[ng|react|svelte|vue]</code>
@@ -457,32 +457,32 @@ <h3>Update repo</h3>
457457
</a>
458458
<p>You can update the repo files quite easily</p>
459459
<p>First update the submodules</p>
460-
<pre><code class="language-bash"><span class="hl-1">npm run update</span>
460+
<pre><code class="language-bash"><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">update</span>
461461
</code></pre>
462462
<p>Then commit the changes
463463
Then update common files</p>
464-
<pre><code class="language-bash"><span class="hl-1">npm run sync</span>
464+
<pre><code class="language-bash"><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">sync</span>
465465
</code></pre>
466466
<p>Then you can run <code>yarn|pnpm</code>, commit changed files if any</p>
467467

468468
<a href="#update-readme" id="update-readme" style="color: inherit; text-decoration: none;">
469469
<h3>Update readme</h3>
470470
</a>
471-
<pre><code class="language-bash"><span class="hl-1">npm run readme</span>
471+
<pre><code class="language-bash"><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">readme</span>
472472
</code></pre>
473473

474474
<a href="#update-doc" id="update-doc" style="color: inherit; text-decoration: none;">
475475
<h3>Update doc</h3>
476476
</a>
477-
<pre><code class="language-bash"><span class="hl-1">npm run doc</span>
477+
<pre><code class="language-bash"><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">doc</span>
478478
</code></pre>
479479

480480
<a href="#publish" id="publish" style="color: inherit; text-decoration: none;">
481481
<h3>Publish</h3>
482482
</a>
483483
<p>The publishing is completely handled by <code>lerna</code> (you can add <code>-- --bump major</code> to force a major release)
484484
Simply run </p>
485-
<pre><code class="language-shell"><span class="hl-1">npm run publish</span>
485+
<pre><code class="language-shell"><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">publish</span>
486486
</code></pre>
487487

488488
<a href="#modifying-submodules" id="modifying-submodules" style="color: inherit; text-decoration: none;">
@@ -521,14 +521,14 @@ <h3>Repo Setup</h3>
521521
<a href="#build-1" id="build-1" style="color: inherit; text-decoration: none;">
522522
<h3>Build</h3>
523523
</a>
524-
<pre><code class="language-bash"><span class="hl-1">npm run build.all</span>
524+
<pre><code class="language-bash"><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">build.all</span>
525525
</code></pre>
526526
<p>WARNING: it seems <code>yarn build.all</code> wont always work (not finding binaries in <code>node_modules/.bin</code>) which is why the doc explicitly uses <code>npm run</code></p>
527527

528528
<a href="#demos-1" id="demos-1" style="color: inherit; text-decoration: none;">
529529
<h3>Demos</h3>
530530
</a>
531-
<pre><code class="language-bash"><span class="hl-1">npm run demo.[ng|react|svelte|vue].[ios|android]</span><br/><br/><span class="hl-1">npm run demo.svelte.ios </span><span class="hl-8"># Example</span>
531+
<pre><code class="language-bash"><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">demo.[ng</span><span class="hl-1">|</span><span class="hl-4">react</span><span class="hl-1">|</span><span class="hl-4">svelte</span><span class="hl-1">|</span><span class="hl-4">vue].[ios</span><span class="hl-1">|</span><span class="hl-4">android]</span><br/><br/><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">demo.svelte.ios</span><span class="hl-1"> </span><span class="hl-8"># Example</span>
532532
</code></pre>
533533
<p>Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in <code>demo-[ng|react|svelte|vue]</code>
534534
Instead you work in <code>demo-snippets/[ng|react|svelte|vue]</code>
@@ -544,32 +544,32 @@ <h3>Update repo</h3>
544544
</a>
545545
<p>You can update the repo files quite easily</p>
546546
<p>First update the submodules</p>
547-
<pre><code class="language-bash"><span class="hl-1">npm run update</span>
547+
<pre><code class="language-bash"><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">update</span>
548548
</code></pre>
549549
<p>Then commit the changes
550550
Then update common files</p>
551-
<pre><code class="language-bash"><span class="hl-1">npm run sync</span>
551+
<pre><code class="language-bash"><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">sync</span>
552552
</code></pre>
553553
<p>Then you can run <code>yarn|pnpm</code>, commit changed files if any</p>
554554

555555
<a href="#update-readme-1" id="update-readme-1" style="color: inherit; text-decoration: none;">
556556
<h3>Update readme</h3>
557557
</a>
558-
<pre><code class="language-bash"><span class="hl-1">npm run readme</span>
558+
<pre><code class="language-bash"><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">readme</span>
559559
</code></pre>
560560

561561
<a href="#update-doc-1" id="update-doc-1" style="color: inherit; text-decoration: none;">
562562
<h3>Update doc</h3>
563563
</a>
564-
<pre><code class="language-bash"><span class="hl-1">npm run doc</span>
564+
<pre><code class="language-bash"><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">doc</span>
565565
</code></pre>
566566

567567
<a href="#publish-1" id="publish-1" style="color: inherit; text-decoration: none;">
568568
<h3>Publish</h3>
569569
</a>
570570
<p>The publishing is completely handled by <code>lerna</code> (you can add <code>-- --bump major</code> to force a major release)
571571
Simply run </p>
572-
<pre><code class="language-shell"><span class="hl-1">npm run publish</span>
572+
<pre><code class="language-shell"><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1"> </span><span class="hl-3">publish</span>
573573
</code></pre>
574574

575575
<a href="#modifying-submodules-1" id="modifying-submodules-1" style="color: inherit; text-decoration: none;">

docs/variables/mainContentProperty.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<h1>Variable mainContentProperty<code class="tsd-tag ts-flagConst">Const</code> </h1></div>
1818
<div class="tsd-signature">main<wbr/>Content<wbr/>Property<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Property</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/Drawer.html" class="tsd-signature-type" data-tsd-kind="Class">Drawer</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">View</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
1919
<ul>
20-
<li>Defined in index.d.ts:181</li></ul></aside></div>
20+
<li>Defined in index.d.ts:182</li></ul></aside></div>
2121
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
2222
<div class="tsd-navigation settings">
2323
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

0 commit comments

Comments
 (0)