Skip to content

Commit

Permalink
readme/doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@farfromrefug
farfromrefug committed Aug 30, 2023
1 parent 73fd9c4 commit a7cdcbc
Show file tree
Hide file tree
Showing 29 changed files with 40 additions and 2,966 deletions.
2 changes: 1 addition & 1 deletion docs/assets/search.js
View file

Large diffs are not rendered by default.

1,001 changes: 0 additions & 1,001 deletions docs/classes/Drawer.html
View file

This file was deleted.

75 changes: 0 additions & 75 deletions docs/functions/install.html
View file

This file was deleted.

66 changes: 37 additions & 29 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,15 @@
<div class="col-8 col-content">
<div class="tsd-page-title">
<h2>@nativescript-community/ui-drawer</h2></div>
<div class="tsd-panel tsd-typography"><!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️--><!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
<div class="tsd-panel tsd-typography"><!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->This monorepo contains multiple packages:<br><br><details>
<summary><b>demo-snippets</b></summary>
{{ load:packages/demo-snippets/README.md }}
</details><details>
<summary><b>src</b></summary>
{{ load:packages/src/README.md }}
</details><details>
<summary><b>ui-drawer</b></summary>
<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
Expand Down Expand Up @@ -89,6 +97,10 @@ <h2>Table of Contents</h2>
<li><a href="#examples-3">Examples:</a></li>
</ul>
</li>
<li><a href="#usage-in-vue3">Usage in Vue3</a><ul>
<li><a href="#examples-4">Examples:</a></li>
</ul>
</li>
<li><a href="#demos-and-development">Demos and Development</a><ul>
<li><a href="#repo-setup">Repo Setup</a></li>
<li><a href="#build">Build</a></li>
Expand Down Expand Up @@ -410,6 +422,29 @@ <h3>Examples:</h3>
</ul>
</li>
</ul>
<p><a href="#usage-in-vue3"></a></p>
<p><a href="#usage-in-vue3"></a></p>

<a href="#usage-in-vue3" id="usage-in-vue3" style="color: inherit; text-decoration: none;">
<h2>Usage in Vue3</h2>
</a>
<p>Register the plugin in your <code>app.js</code>.</p>
<pre><code class="language-typescript"><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">DrawerPlugin</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@nativescript-community/ui-drawer/vue3&#39;</span><br/><br/><span class="hl-2">app</span><span class="hl-1">.</span><span class="hl-4">use</span><span class="hl-1">(</span><span class="hl-2">DrawerPlugin</span><span class="hl-1">);</span>
</code></pre>

<a href="#examples-4" id="examples-4" style="color: inherit; text-decoration: none;">
<h3>Examples:</h3>
</a>
<ul>
<li><a href="demo-snippets/vue3/BasicDrawer.vue">Basic Drawer</a><ul>
<li>A basic sliding drawer.</li>
</ul>
</li>
<li><a href="demo-snippets/vue3/AllSides.vue">All Sides</a><ul>
<li>An example of drawers on all sides: left, right, top, bottom.</li>
</ul>
</li>
</ul>
<p><a href="#demos-and-development"></a></p>
<p><a href="#demos-and-development"></a></p>

Expand Down Expand Up @@ -606,34 +641,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<ul>
<li class="current selected"><a href="modules.html">@nativescript-<wbr/>community/ui-<wbr/>drawer</a>
<ul></ul></li></ul></div></details></nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul>
<li class="tsd-kind-class"><a href="classes/Drawer.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg>Drawer</a></li>
<li class="tsd-kind-interface"><a href="interfaces/DrawerEventData.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>Drawer<wbr/>Event<wbr/>Data</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TrData.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Tr<wbr/>Data</a></li>
<li class="tsd-kind-type-alias"><a href="types/AnimationFunctionType.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>Animation<wbr/>Function<wbr/>Type</a></li>
<li class="tsd-kind-type-alias"><a href="types/Mode.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Mode</a></li>
<li class="tsd-kind-type-alias"><a href="types/Side.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Side</a></li>
<li class="tsd-kind-type-alias"><a href="types/TranslationFunctionType.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Translation<wbr/>Function<wbr/>Type</a></li>
<li class="tsd-kind-type-alias"><a href="types/VerticalSide.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Vertical<wbr/>Side</a></li>
<li class="tsd-kind-variable"><a href="variables/PAN_GESTURE_TAG.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>PAN_<wbr/>GESTURE_<wbr/>TAG</a></li>
<li class="tsd-kind-variable"><a href="variables/animationFunctionProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>animation<wbr/>Function<wbr/>Property</a></li>
<li class="tsd-kind-variable"><a href="variables/backDropEnabledProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>back<wbr/>Drop<wbr/>Enabled<wbr/>Property</a></li>
<li class="tsd-kind-variable"><a href="variables/backdropColorProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>backdrop<wbr/>Color<wbr/>Property</a></li>
<li class="tsd-kind-variable"><a href="variables/bottomDrawerContentProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>bottom<wbr/>Drawer<wbr/>Content<wbr/>Property</a></li>
<li class="tsd-kind-variable"><a href="variables/bottomDrawerModeProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>bottom<wbr/>Drawer<wbr/>Mode<wbr/>Property</a></li>
<li class="tsd-kind-variable"><a href="variables/gestureEnabledProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>gesture<wbr/>Enabled<wbr/>Property</a></li>
<li class="tsd-kind-variable"><a href="variables/gestureHandlerOptionsProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>gesture<wbr/>Handler<wbr/>Options<wbr/>Property</a></li>
<li class="tsd-kind-variable"><a href="variables/leftDrawerContentProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>left<wbr/>Drawer<wbr/>Content<wbr/>Property</a></li>
<li class="tsd-kind-variable"><a href="variables/leftDrawerModeProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>left<wbr/>Drawer<wbr/>Mode<wbr/>Property</a></li>
<li class="tsd-kind-variable"><a href="variables/mainContentProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>main<wbr/>Content<wbr/>Property</a></li>
<li class="tsd-kind-variable"><a href="variables/rightDrawerContentProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>right<wbr/>Drawer<wbr/>Content<wbr/>Property</a></li>
<li class="tsd-kind-variable"><a href="variables/rightDrawerModeProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>right<wbr/>Drawer<wbr/>Mode<wbr/>Property</a></li>
<li class="tsd-kind-variable"><a href="variables/startingSideProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>starting<wbr/>Side<wbr/>Property</a></li>
<li class="tsd-kind-variable"><a href="variables/topDrawerContentProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>top<wbr/>Drawer<wbr/>Content<wbr/>Property</a></li>
<li class="tsd-kind-variable"><a href="variables/topDrawerModeProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>top<wbr/>Drawer<wbr/>Mode<wbr/>Property</a></li>
<li class="tsd-kind-variable"><a href="variables/translationFunctionProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>translation<wbr/>Function<wbr/>Property</a></li>
<li class="tsd-kind-function"><a href="functions/install.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>install</a></li></ul></nav></div></div>
<nav class="tsd-navigation secondary menu-sticky"></nav></div></div>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
<div class="overlay"></div><script src="assets/main.js"></script></body></html>
Loading

0 comments on commit a7cdcbc

Please sign in to comment.