Skip to content

Commit fd1aead

Browse files
authored
chore: update docs (#166)
1 parent 532e8a4 commit fd1aead

16 files changed

+96
-95
lines changed

docs/latest/classes/Marker.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
2020
<ul class="tsd-hierarchy">
2121
<li><span class="target">Marker</span></li></ul></section><aside class="tsd-sources">
2222
<ul>
23-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L825">index.ts:825</a></li></ul></aside>
23+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L825">index.ts:825</a></li></ul></aside>
2424
<section class="tsd-panel-group tsd-index-group">
2525
<section class="tsd-panel tsd-index-panel">
2626
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -53,7 +53,7 @@ <h4>Example</h4><pre><code class="language-ts"><span class="hl-4">const</span><s
5353
</code><button>Copy</button></pre>
5454
</div><aside class="tsd-sources">
5555
<ul>
56-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L978">index.ts:978</a></li></ul></aside></li></ul></section>
56+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L978">index.ts:978</a></li></ul></aside></li></ul></section>
5757
<section class="tsd-panel tsd-member"><a id="markText" class="tsd-anchor"></a>
5858
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>mark<wbr/>Text</span><a href="#markText" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
5959
<ul class="tsd-signatures">
@@ -74,7 +74,7 @@ <h4>Example</h4><pre><code class="language-ts"><span class="hl-4">const</span><s
7474
</code><button>Copy</button></pre>
7575
</div><aside class="tsd-sources">
7676
<ul>
77-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L910">index.ts:910</a></li></ul></aside></li></ul></section></section></div>
77+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L910">index.ts:910</a></li></ul></aside></li></ul></section></section></div>
7878
<div class="col-sidebar">
7979
<div class="page-menu">
8080
<div class="tsd-navigation settings">

docs/latest/enums/ImageFormat.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ <h1>Enumeration ImageFormat</h1></div>
2020
<h4>Description</h4><p>ImageFormat enum for save image format</p>
2121
</div></section><aside class="tsd-sources">
2222
<ul>
23-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L38">index.ts:38</a></li></ul></aside>
23+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L38">index.ts:38</a></li></ul></aside>
2424
<section class="tsd-panel-group tsd-index-group">
2525
<section class="tsd-panel tsd-index-panel">
2626
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -38,17 +38,17 @@ <h2>Enumeration Members</h2>
3838
<h3 class="tsd-anchor-link"><span>base64</span><a href="#base64" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
3939
<div class="tsd-signature"><span class="tsd-kind-enum-member">base64</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;base64&quot;</span></div><aside class="tsd-sources">
4040
<ul>
41-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L42">index.ts:42</a></li></ul></aside></section>
41+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L42">index.ts:42</a></li></ul></aside></section>
4242
<section class="tsd-panel tsd-member"><a id="jpg" class="tsd-anchor"></a>
4343
<h3 class="tsd-anchor-link"><span>jpg</span><a href="#jpg" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
4444
<div class="tsd-signature"><span class="tsd-kind-enum-member">jpg</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;jpg&quot;</span></div><aside class="tsd-sources">
4545
<ul>
46-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L40">index.ts:40</a></li></ul></aside></section>
46+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L40">index.ts:40</a></li></ul></aside></section>
4747
<section class="tsd-panel tsd-member"><a id="png" class="tsd-anchor"></a>
4848
<h3 class="tsd-anchor-link"><span>png</span><a href="#png" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
4949
<div class="tsd-signature"><span class="tsd-kind-enum-member">png</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;png&quot;</span></div><aside class="tsd-sources">
5050
<ul>
51-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L39">index.ts:39</a></li></ul></aside></section></section></div>
51+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L39">index.ts:39</a></li></ul></aside></section></section></div>
5252
<div class="col-sidebar">
5353
<div class="page-menu">
5454
<div class="tsd-navigation settings">

docs/latest/enums/Position.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ <h1>Enumeration Position</h1></div>
2020
<h4>Description</h4><p>Position enum for text watermark and image watermark</p>
2121
</div></section><aside class="tsd-sources">
2222
<ul>
23-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L14">index.ts:14</a></li></ul></aside>
23+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L14">index.ts:14</a></li></ul></aside>
2424
<section class="tsd-panel-group tsd-index-group">
2525
<section class="tsd-panel tsd-index-panel">
2626
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -42,37 +42,37 @@ <h2>Enumeration Members</h2>
4242
<h3 class="tsd-anchor-link"><span>bottom<wbr/>Center</span><a href="#bottomCenter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
4343
<div class="tsd-signature"><span class="tsd-kind-enum-member">bottom<wbr/>Center</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;bottomCenter&quot;</span></div><aside class="tsd-sources">
4444
<ul>
45-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L19">index.ts:19</a></li></ul></aside></section>
45+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L19">index.ts:19</a></li></ul></aside></section>
4646
<section class="tsd-panel tsd-member"><a id="bottomLeft" class="tsd-anchor"></a>
4747
<h3 class="tsd-anchor-link"><span>bottom<wbr/>Left</span><a href="#bottomLeft" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
4848
<div class="tsd-signature"><span class="tsd-kind-enum-member">bottom<wbr/>Left</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;bottomLeft&quot;</span></div><aside class="tsd-sources">
4949
<ul>
50-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L18">index.ts:18</a></li></ul></aside></section>
50+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L18">index.ts:18</a></li></ul></aside></section>
5151
<section class="tsd-panel tsd-member"><a id="bottomRight" class="tsd-anchor"></a>
5252
<h3 class="tsd-anchor-link"><span>bottom<wbr/>Right</span><a href="#bottomRight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
5353
<div class="tsd-signature"><span class="tsd-kind-enum-member">bottom<wbr/>Right</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;bottomRight&quot;</span></div><aside class="tsd-sources">
5454
<ul>
55-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L20">index.ts:20</a></li></ul></aside></section>
55+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L20">index.ts:20</a></li></ul></aside></section>
5656
<section class="tsd-panel tsd-member"><a id="center" class="tsd-anchor"></a>
5757
<h3 class="tsd-anchor-link"><span>center</span><a href="#center" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
5858
<div class="tsd-signature"><span class="tsd-kind-enum-member">center</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;center&quot;</span></div><aside class="tsd-sources">
5959
<ul>
60-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L21">index.ts:21</a></li></ul></aside></section>
60+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L21">index.ts:21</a></li></ul></aside></section>
6161
<section class="tsd-panel tsd-member"><a id="topCenter" class="tsd-anchor"></a>
6262
<h3 class="tsd-anchor-link"><span>top<wbr/>Center</span><a href="#topCenter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
6363
<div class="tsd-signature"><span class="tsd-kind-enum-member">top<wbr/>Center</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;topCenter&quot;</span></div><aside class="tsd-sources">
6464
<ul>
65-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L16">index.ts:16</a></li></ul></aside></section>
65+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L16">index.ts:16</a></li></ul></aside></section>
6666
<section class="tsd-panel tsd-member"><a id="topLeft" class="tsd-anchor"></a>
6767
<h3 class="tsd-anchor-link"><span>top<wbr/>Left</span><a href="#topLeft" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
6868
<div class="tsd-signature"><span class="tsd-kind-enum-member">top<wbr/>Left</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;topLeft&quot;</span></div><aside class="tsd-sources">
6969
<ul>
70-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L15">index.ts:15</a></li></ul></aside></section>
70+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L15">index.ts:15</a></li></ul></aside></section>
7171
<section class="tsd-panel tsd-member"><a id="topRight" class="tsd-anchor"></a>
7272
<h3 class="tsd-anchor-link"><span>top<wbr/>Right</span><a href="#topRight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
7373
<div class="tsd-signature"><span class="tsd-kind-enum-member">top<wbr/>Right</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;topRight&quot;</span></div><aside class="tsd-sources">
7474
<ul>
75-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L17">index.ts:17</a></li></ul></aside></section></section></div>
75+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L17">index.ts:17</a></li></ul></aside></section></section></div>
7676
<div class="col-sidebar">
7777
<div class="page-menu">
7878
<div class="tsd-navigation settings">

docs/latest/enums/TextBackgroundType.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ <h1>Enumeration TextBackgroundType</h1></div>
2020
<h4>Description</h4><p>TextBackgroundType enum for text watermark</p>
2121
</div></section><aside class="tsd-sources">
2222
<ul>
23-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L28">index.ts:28</a></li></ul></aside>
23+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L28">index.ts:28</a></li></ul></aside>
2424
<section class="tsd-panel-group tsd-index-group">
2525
<section class="tsd-panel tsd-index-panel">
2626
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -38,17 +38,17 @@ <h2>Enumeration Members</h2>
3838
<h3 class="tsd-anchor-link"><span>none</span><a href="#none" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
3939
<div class="tsd-signature"><span class="tsd-kind-enum-member">none</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;fit&quot;</span></div><aside class="tsd-sources">
4040
<ul>
41-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L31">index.ts:31</a></li></ul></aside></section>
41+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L31">index.ts:31</a></li></ul></aside></section>
4242
<section class="tsd-panel tsd-member"><a id="stretchX" class="tsd-anchor"></a>
4343
<h3 class="tsd-anchor-link"><span>stretchX</span><a href="#stretchX" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
4444
<div class="tsd-signature"><span class="tsd-kind-enum-member">stretchX</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;stretchX&quot;</span></div><aside class="tsd-sources">
4545
<ul>
46-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L29">index.ts:29</a></li></ul></aside></section>
46+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L29">index.ts:29</a></li></ul></aside></section>
4747
<section class="tsd-panel tsd-member"><a id="stretchY" class="tsd-anchor"></a>
4848
<h3 class="tsd-anchor-link"><span>stretchY</span><a href="#stretchY" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
4949
<div class="tsd-signature"><span class="tsd-kind-enum-member">stretchY</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;stretchY&quot;</span></div><aside class="tsd-sources">
5050
<ul>
51-
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L30">index.ts:30</a></li></ul></aside></section></section></div>
51+
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L30">index.ts:30</a></li></ul></aside></section></section></div>
5252
<div class="col-sidebar">
5353
<div class="page-menu">
5454
<div class="tsd-navigation settings">

docs/latest/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ <h6>Add text or icon watermarks to images</h6>
2222
<div align="center">
2323

2424
<p> <a href="https://www.npmjs.com/package/react-native-image-marker"><img src="https://img.shields.io/npm/v/react-native-image-marker.svg?logo=npm" alt="npm version"></a> <a href="https://www.npmjs.com/package/react-native-image-marker"><img src="https://img.shields.io/npm/dm/react-native-image-marker?logo=npm" alt="npm"></a> <a href="https://github.com/JimmyDaddy/react-native-image-marker"><img src="https://img.shields.io/github/stars/jimmydaddy/react-native-image-marker?style=social" alt="stars"></a> <a href="https://github.com/JimmyDaddy/react-native-image-marker/fork"><img src="https://img.shields.io/github/forks/jimmydaddy/react-native-image-marker?style=social" alt="forks"></a><a href="https://github.com/JimmyDaddy/react-native-image-marker"><img src="https://img.shields.io/badge/github-repo-blue?logo=github" alt="github"></a> <a href="https://github.com/JimmyDaddy/react-native-image-marker/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?logo=github" alt="PRs Welcome"></a> <img src="https://img.shields.io/npm/l/react-native-image-marker" alt="license">
25-
<img src="https://img.shields.io/badge/iOS-black?logo=Apple" alt="platform-iOS"> <img src="https://img.shields.io/badge/Android-black?logo=Android" alt="platform-Android">
25+
<img src="https://img.shields.io/badge/iOS-black?logo=Apple" alt="platform-iOS"> <img src="https://img.shields.io/badge/Android-black?logo=Android" alt="platform-Android"> <a href="https://github.com/JimmyDaddy/react-native-image-marker/actions/workflows/native-ci.yml"><img src="https://github.com/JimmyDaddy/react-native-image-marker/actions/workflows/native-ci.yml/badge.svg" alt="Native Build and Test"></a>
26+
<br/>
2627
<em>If this library is useful to you, pls give me a ⭐️. 🤩</em></p>
2728
</div>
2829

0 commit comments

Comments
 (0)