Skip to content

Commit 054418f

Browse files
committed
Update API doc link
1 parent c318717 commit 054418f

File tree

10 files changed

+10
-10
lines changed

10 files changed

+10
-10
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ yarn test:docker
3535
```
3636

3737
## Documentation
38-
Refer to each of the packages listed above for framework specific documentation and examples. For more information about available configuration settings and and functions available, see our [Javascript API](https://support.userback.io/en/articles/5209252-javascript-api)
38+
Refer to each of the packages listed above for framework specific documentation and examples. For more information about available configuration settings and and functions available, see our [Javascript API](https://docs.userback.io/reference/javascript-api-overview)
3939

4040
## Release Process
4141

docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ <h3>End to End Testing</h3>
5555
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
5656
<h2>Documentation</h2>
5757
</a>
58-
<p>Refer to each of the packages listed above for framework specific documentation and examples. For more information about available configuration settings and and functions available, see our <a href="https://support.userback.io/en/articles/5209252-javascript-api">Javascript API</a></p>
58+
<p>Refer to each of the packages listed above for framework specific documentation and examples. For more information about available configuration settings and and functions available, see our <a href="https://docs.userback.io/reference/javascript-api-overview">Javascript API</a></p>
5959

6060
<a href="#release-process" id="release-process" style="color: inherit; text-decoration: none;">
6161
<h2>Release Process</h2>

docs/modules/_userback_react.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ <h3>Class based components</h3>
5656
<p>If you are using class based components and need an alternative to hooks, you can use the <code>withUserback</code> Higher Order Component:</p>
5757
<pre><code class="language-jsx"><span class="hl-1">import</span><span class="hl-0"> { </span><span class="hl-2">withUserback</span><span class="hl-0"> } </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&#39;@userback/react&#39;</span><br/><br/><span class="hl-8">class</span><span class="hl-0"> </span><span class="hl-6">App</span><span class="hl-0"> </span><span class="hl-8">extends</span><span class="hl-0"> </span><span class="hl-6">React</span><span class="hl-0">.</span><span class="hl-6">Component</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-4">render</span><span class="hl-0">() {</span><br/><span class="hl-0"> </span><span class="hl-1">return</span><span class="hl-0"> (</span><br/><span class="hl-0"> </span><span class="hl-5">&lt;</span><span class="hl-10">div</span><span class="hl-0"> </span><span class="hl-7">id</span><span class="hl-0">=</span><span class="hl-3">&quot;app&quot;</span><span class="hl-5">&gt;</span><br/><span class="hl-0"> </span><span class="hl-5">&lt;</span><span class="hl-10">button</span><span class="hl-0"> </span><span class="hl-7">type</span><span class="hl-0">=</span><span class="hl-3">&quot;button&quot;</span><span class="hl-0"> </span><span class="hl-7">onClick</span><span class="hl-0">=</span><span class="hl-8">{</span><span class="hl-11">() </span><span class="hl-8">=&gt;</span><span class="hl-11"> </span><span class="hl-8">this</span><span class="hl-11">.</span><span class="hl-2">props</span><span class="hl-11">.</span><span class="hl-2">userback</span><span class="hl-11">.</span><span class="hl-4">open</span><span class="hl-11">(</span><span class="hl-3">&#39;general&#39;</span><span class="hl-11">, </span><span class="hl-3">&#39;screenshot&#39;</span><span class="hl-11">)</span><span class="hl-8">}</span><span class="hl-5">&gt;</span><span class="hl-0">Take a screenshot</span><span class="hl-5">&lt;/</span><span class="hl-10">button</span><span class="hl-5">&gt;</span><br/><span class="hl-0"> </span><span class="hl-5">&lt;</span><span class="hl-10">button</span><span class="hl-0"> </span><span class="hl-7">type</span><span class="hl-0">=</span><span class="hl-3">&quot;button&quot;</span><span class="hl-0"> </span><span class="hl-7">onClick</span><span class="hl-0">=</span><span class="hl-8">{</span><span class="hl-11">() </span><span class="hl-8">=&gt;</span><span class="hl-11"> </span><span class="hl-8">this</span><span class="hl-11">.</span><span class="hl-2">props</span><span class="hl-11">.</span><span class="hl-2">userback</span><span class="hl-11">.</span><span class="hl-4">hide</span><span class="hl-11">()</span><span class="hl-8">}</span><span class="hl-5">&gt;</span><span class="hl-0">Hide me :(</span><span class="hl-5">&lt;/</span><span class="hl-10">button</span><span class="hl-5">&gt;</span><br/><span class="hl-0"> </span><span class="hl-5">&lt;/</span><span class="hl-10">div</span><span class="hl-5">&gt;</span><br/><span class="hl-0"> )</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">}</span><br/><br/><span class="hl-1">export</span><span class="hl-0"> </span><span class="hl-1">default</span><span class="hl-0"> </span><span class="hl-4">withUserback</span><span class="hl-0">(</span><span class="hl-2">App</span><span class="hl-0">)</span>
5858
</code></pre>
59-
<p>For more information about available configuration settings and and functions available, see our <a href="https://support.userback.io/en/articles/5209252-javascript-api">Javascript API</a></p>
59+
<p>For more information about available configuration settings and and functions available, see our <a href="https://docs.userback.io/reference/javascript-api-overview">Javascript API</a></p>
6060
</section></section>
6161
<section class="tsd-panel-group tsd-index-group">
6262
<section class="tsd-panel tsd-index-panel">

docs/modules/_userback_vue.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ <h2>Quickstart</h2>
3636
<p>The <code>$userback</code> API can now be used throughout your application:</p>
3737
<pre><code class="language-vue"><span class="hl-5">&lt;</span><span class="hl-10">template</span><span class="hl-5">&gt;</span><br/><span class="hl-0"> </span><span class="hl-5">&lt;</span><span class="hl-10">button</span><span class="hl-0"> </span><span class="hl-7">type</span><span class="hl-0">=</span><span class="hl-12">&quot;button&quot;</span><span class="hl-0"> @</span><span class="hl-7">click</span><span class="hl-0">=</span><span class="hl-0">&quot;</span><span class="hl-2">$userback</span><span class="hl-0">.</span><span class="hl-4">show</span><span class="hl-0">()</span><span class="hl-0">&quot;</span><span class="hl-5">&gt;</span><span class="hl-0">Show</span><span class="hl-5">&lt;/</span><span class="hl-10">button</span><span class="hl-5">&gt;</span><br/><span class="hl-0"> </span><span class="hl-5">&lt;</span><span class="hl-10">button</span><span class="hl-0"> </span><span class="hl-7">type</span><span class="hl-0">=</span><span class="hl-12">&quot;button&quot;</span><span class="hl-0"> @</span><span class="hl-7">click</span><span class="hl-0">=</span><span class="hl-0">&quot;</span><span class="hl-2">$userback</span><span class="hl-0">.</span><span class="hl-4">hide</span><span class="hl-0">()</span><span class="hl-0">&quot;</span><span class="hl-5">&gt;</span><span class="hl-0">Hide</span><span class="hl-5">&lt;/</span><span class="hl-10">button</span><span class="hl-5">&gt;</span><br/><br/><span class="hl-0"> </span><span class="hl-5">&lt;</span><span class="hl-10">button</span><span class="hl-0"> </span><span class="hl-7">type</span><span class="hl-0">=</span><span class="hl-12">&quot;button&quot;</span><span class="hl-0"> @</span><span class="hl-7">click</span><span class="hl-0">=</span><span class="hl-0">&quot;</span><span class="hl-2">$userback</span><span class="hl-0">.</span><span class="hl-4">open</span><span class="hl-0">(</span><span class="hl-3">&#39;bug&#39;</span><span class="hl-0">)</span><span class="hl-0">&quot;</span><span class="hl-5">&gt;</span><span class="hl-0">Open Bugs</span><span class="hl-5">&lt;/</span><span class="hl-10">button</span><span class="hl-5">&gt;</span><br/><span class="hl-0"> </span><span class="hl-5">&lt;</span><span class="hl-10">button</span><span class="hl-0"> </span><span class="hl-7">type</span><span class="hl-0">=</span><span class="hl-12">&quot;button&quot;</span><span class="hl-0"> @</span><span class="hl-7">click</span><span class="hl-0">=</span><span class="hl-0">&quot;</span><span class="hl-2">$userback</span><span class="hl-0">.</span><span class="hl-4">open</span><span class="hl-0">(</span><span class="hl-3">&#39;general&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;screenshot&#39;</span><span class="hl-0">)</span><span class="hl-0">&quot;</span><span class="hl-5">&gt;</span><span class="hl-0">Screenshot me!</span><span class="hl-5">&lt;/</span><span class="hl-10">button</span><span class="hl-5">&gt;</span><br/><span class="hl-5">&lt;/</span><span class="hl-10">template</span><span class="hl-5">&gt;</span>
3838
</code></pre>
39-
<p>For more information about available configuration settings and and functions available, see our <a href="https://support.userback.io/en/articles/5209252-javascript-api">Javascript API</a></p>
39+
<p>For more information about available configuration settings and and functions available, see our <a href="https://docs.userback.io/reference/javascript-api-overview">Javascript API</a></p>
4040
</section></section>
4141
<section class="tsd-panel-group tsd-index-group">
4242
<section class="tsd-panel tsd-index-panel">

docs/modules/_userback_vue2.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ <h2>Quickstart</h2>
3636
<p>You can access the Userback api via the <code>Vue.prototype.$userback</code> object:</p>
3737
<pre><code class="language-vue"><span class="hl-5">&lt;</span><span class="hl-10">template</span><span class="hl-5">&gt;</span><br/><span class="hl-0"> </span><span class="hl-5">&lt;</span><span class="hl-10">div</span><span class="hl-0"> </span><span class="hl-7">id</span><span class="hl-0">=</span><span class="hl-12">&quot;app&quot;</span><span class="hl-5">&gt;</span><br/><span class="hl-0"> </span><span class="hl-5">&lt;</span><span class="hl-10">button</span><span class="hl-0"> </span><span class="hl-7">type</span><span class="hl-0">=</span><span class="hl-12">&quot;button&quot;</span><span class="hl-0"> </span><span class="hl-7">v-on</span><span class="hl-0">:</span><span class="hl-7">click</span><span class="hl-0">=</span><span class="hl-0">&quot;</span><span class="hl-2">$userback</span><span class="hl-0">.</span><span class="hl-4">open</span><span class="hl-0">(</span><span class="hl-3">&#39;bug&#39;</span><span class="hl-0">)</span><span class="hl-0">&quot;</span><span class="hl-5">&gt;</span><span class="hl-0">Open Bugs</span><span class="hl-5">&lt;/</span><span class="hl-10">button</span><span class="hl-5">&gt;</span><br/><span class="hl-0"> </span><span class="hl-5">&lt;</span><span class="hl-10">button</span><span class="hl-0"> </span><span class="hl-7">type</span><span class="hl-0">=</span><span class="hl-12">&quot;button&quot;</span><span class="hl-0"> </span><span class="hl-7">v-on</span><span class="hl-0">:</span><span class="hl-7">click</span><span class="hl-0">=</span><span class="hl-0">&quot;</span><span class="hl-2">$userback</span><span class="hl-0">.</span><span class="hl-4">open</span><span class="hl-0">(</span><span class="hl-3">&#39;general&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;screenshot&#39;</span><span class="hl-0">)</span><span class="hl-0">&quot;</span><span class="hl-5">&gt;</span><span class="hl-0">Screenshot me!</span><span class="hl-5">&lt;/</span><span class="hl-10">button</span><span class="hl-5">&gt;</span><br/><span class="hl-0"> </span><span class="hl-5">&lt;/</span><span class="hl-10">div</span><span class="hl-5">&gt;</span><br/><span class="hl-5">&lt;/</span><span class="hl-10">template</span><span class="hl-5">&gt;</span>
3838
</code></pre>
39-
<p>For more information about available configuration settings and and functions available, see our <a href="https://support.userback.io/en/articles/5209252-javascript-api">Javascript API</a></p>
39+
<p>For more information about available configuration settings and and functions available, see our <a href="https://docs.userback.io/reference/javascript-api-overview">Javascript API</a></p>
4040
</section></section>
4141
<section class="tsd-panel-group tsd-index-group">
4242
<section class="tsd-panel tsd-index-panel">

docs/modules/_userback_widget.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ <h2>Examples</h2>
4949
<p>After initialisation, you can use the named function <code>getUserback</code> to get a reference to the UserbackWidget.</p>
5050
<pre><code class="language-javascript"><span class="hl-1">import</span><span class="hl-0"> { </span><span class="hl-2">getUserback</span><span class="hl-0"> } </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&#39;@userback/widget&#39;</span><br/><br/><span class="hl-2">document</span><span class="hl-0">.</span><span class="hl-4">querySelector</span><span class="hl-0">(</span><span class="hl-3">&#39;button.screenshot&#39;</span><span class="hl-0">).</span><span class="hl-4">addEventListener</span><span class="hl-0">(</span><span class="hl-3">&#39;click&#39;</span><span class="hl-0">, (</span><span class="hl-2">event</span><span class="hl-0">) </span><span class="hl-8">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-2">event</span><span class="hl-0">.</span><span class="hl-4">preventDefault</span><span class="hl-0">()</span><br/><span class="hl-0"> </span><span class="hl-4">getUserback</span><span class="hl-0">().</span><span class="hl-4">open</span><span class="hl-0">(</span><span class="hl-3">&#39;bug&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;screenshot&#39;</span><span class="hl-0">)</span><br/><span class="hl-0">})</span>
5151
</code></pre>
52-
<p>For more information about available configuration settings and and functions available, see our <a href="https://support.userback.io/en/articles/5209252-javascript-api">Javascript API</a></p>
52+
<p>For more information about available configuration settings and and functions available, see our <a href="https://docs.userback.io/reference/javascript-api-overview">Javascript API</a></p>
5353
</section></section>
5454
<section class="tsd-panel-group tsd-index-group">
5555
<section class="tsd-panel tsd-index-panel">

widget-js/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,4 @@ document.querySelector('button.screenshot').addEventListener('click', (event) =>
5050
```
5151

5252

53-
For more information about available configuration settings and and functions available, see our [Javascript API](https://support.userback.io/en/articles/5209252-javascript-api)
53+
For more information about available configuration settings and and functions available, see our [Javascript API](https://docs.userback.io/reference/javascript-api-overview)

widget-react/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,4 +79,4 @@ export default withUserback(App)
7979
```
8080
8181
82-
For more information about available configuration settings and and functions available, see our [Javascript API](https://support.userback.io/en/articles/5209252-javascript-api)
82+
For more information about available configuration settings and and functions available, see our [Javascript API](https://docs.userback.io/reference/javascript-api-overview)

widget-vue/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ The `$userback` API can now be used throughout your application:
2525
</template>
2626
```
2727

28-
For more information about available configuration settings and and functions available, see our [Javascript API](https://support.userback.io/en/articles/5209252-javascript-api)
28+
For more information about available configuration settings and and functions available, see our [Javascript API](https://docs.userback.io/reference/javascript-api-overview)

widget-vue2/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ You can access the Userback api via the `Vue.prototype.$userback` object:
2424
</template>
2525
```
2626

27-
For more information about available configuration settings and and functions available, see our [Javascript API](https://support.userback.io/en/articles/5209252-javascript-api)
27+
For more information about available configuration settings and and functions available, see our [Javascript API](https://docs.userback.io/reference/javascript-api-overview)

0 commit comments

Comments
 (0)