Skip to content

Commit e5b0c4d

Browse files
author
farfromrefug
committed
readme/doc
1 parent 8e2210c commit e5b0c4d

File tree

11 files changed

+29
-103
lines changed

11 files changed

+29
-103
lines changed

‎README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -603,7 +603,6 @@ If you have any questions/issues/comments please feel free to create an issue or
603603
## Table of Contents
604604
605605
* [Installation](#installation)
606-
* [Configuration](#configuration)
607606
* [NativeScript + Vue](#nativescript--vue)
608607
* [NativeScript + Svelte](#nativescript--svelte)
609608
* [Examples:](#examples)
@@ -630,27 +629,29 @@ Run the following command from the root of your project:
630629
631630
`ns plugin add @nativescript-community/ui-svg`
632631
633-
634-
[](#configuration)
635-
636-
637-
[](#configuration)
638-
639-
## Configuration
640-
641-
For now only `vue` (and core) is supported.
642632
643633
### NativeScript + Vue
644634
645635
```ts
646-
import CanvasSVG from '@nativescript-community/ui-svg/vue';
647-
Vue.use(CanvasSVG);
636+
import SVGPlugin from '@nativescript-community/ui-svg/vue';
637+
Vue.use(SVGPlugin);
638+
// or if you want the canvas version
639+
import CanvasSVGPlugin from '@nativescript-community/ui-svg/vue/canvas';
640+
Vue.use(CanvasSVGPlugin);
641+
```
642+
643+
For other flavors you need to register the components directly:
644+
```ts
645+
import { SVGView } from '@nativescript-community/ui-svg';
646+
import { CanvasSVG, SVG } from '@nativescript-community/ui-svg/canvas';
647+
648648
```
649649
650650
It works in 3 ways!.
651651
652652
`CanvasSVG` extending `Canvas`
653653
654+
654655
```html
655656
<CanvasSVG>
656657
<CSVG horizontalAlignment="left" src="~/assets/svgs/Ghostscript_Tiger.svg" height="100%" stretch="aspectFit" />

‎docs/assets/navigation.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/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/classes/ui_canvas.CanvasView.html

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

‎docs/classes/ui_svg.CanvasSVG.html

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎docs/classes/ui_svg.SVG.html

Lines changed: 0 additions & 58 deletions
This file was deleted.

‎docs/classes/ui_svg.SVGView.html

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

‎docs/functions/ui_svg.getSVG.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>getSVG | Documentation</title><meta name="description" content="Documentation for Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://docs.nativescript.org">Nativescript Doc</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Documentation</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Documentation</a></li><li><a href="../modules/ui_svg.html">ui-svg</a></li><li><a href="ui_svg.getSVG.html">getSVG</a></li></ul><h1>Function getSVG</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getSVG" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getSVG</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">com.caverock.androidsvg.SVG</span><a href="#getSVG" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ImageAsset</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">File</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">com.caverock.androidsvg.SVG</span></h4><aside class="tsd-sources"><ul><li>Defined in packages/ui-svg/index.android.d.ts:3</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Documentation</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

0 commit comments

Comments
 (0)