Skip to content

Commit

Permalink
Merge pull request #78 from userback/aliu/update-docs
Browse files Browse the repository at this point in the history
Update broken javascript docs link
  • Loading branch information
lee-userback authored Jan 7, 2025
2 parents f529e88 + b0101d3 commit 0d9cc88
Show file tree
Hide file tree
Showing 10 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ yarn test:docker
```

## Documentation
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)
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/docs/javascript-sdk)

## Release Process

Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ <h3>End to End Testing</h3>
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
<h2>Documentation</h2>
</a>
<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>
<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/docs/javascript-sdk">Javascript API</a></p>

<a href="#release-process" id="release-process" style="color: inherit; text-decoration: none;">
<h2>Release Process</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/_userback_react.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ <h3>Class based components</h3>
<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>
<pre><code class="language-jsx"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-0">withUserback</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@userback/react&#39;</span><br/><br/><span class="hl-9">class</span><span class="hl-1"> </span><span class="hl-6">App</span><span class="hl-1"> </span><span class="hl-9">extends</span><span class="hl-1"> </span><span class="hl-6">React</span><span class="hl-1">.</span><span class="hl-6">Component</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">render</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">return</span><span class="hl-1"> (</span><br/><span class="hl-1"> </span><span class="hl-5">&lt;</span><span class="hl-12">div</span><span class="hl-1"> </span><span class="hl-7">id</span><span class="hl-1">=</span><span class="hl-2">&quot;app&quot;</span><span class="hl-5">&gt;</span><br/><span class="hl-1"> </span><span class="hl-5">&lt;</span><span class="hl-12">button</span><span class="hl-1"> </span><span class="hl-7">type</span><span class="hl-1">=</span><span class="hl-2">&quot;button&quot;</span><span class="hl-1"> </span><span class="hl-7">onClick</span><span class="hl-1">=</span><span class="hl-9">{</span><span class="hl-11">() </span><span class="hl-9">=&gt;</span><span class="hl-11"> </span><span class="hl-9">this</span><span class="hl-11">.</span><span class="hl-0">props</span><span class="hl-11">.</span><span class="hl-0">userback</span><span class="hl-11">.</span><span class="hl-4">open</span><span class="hl-11">(</span><span class="hl-2">&#39;general&#39;</span><span class="hl-11">, </span><span class="hl-2">&#39;screenshot&#39;</span><span class="hl-11">)</span><span class="hl-9">}</span><span class="hl-5">&gt;</span><span class="hl-1">Take a screenshot</span><span class="hl-5">&lt;/</span><span class="hl-12">button</span><span class="hl-5">&gt;</span><br/><span class="hl-1"> </span><span class="hl-5">&lt;</span><span class="hl-12">button</span><span class="hl-1"> </span><span class="hl-7">type</span><span class="hl-1">=</span><span class="hl-2">&quot;button&quot;</span><span class="hl-1"> </span><span class="hl-7">onClick</span><span class="hl-1">=</span><span class="hl-9">{</span><span class="hl-11">() </span><span class="hl-9">=&gt;</span><span class="hl-11"> </span><span class="hl-9">this</span><span class="hl-11">.</span><span class="hl-0">props</span><span class="hl-11">.</span><span class="hl-0">userback</span><span class="hl-11">.</span><span class="hl-4">hide</span><span class="hl-11">()</span><span class="hl-9">}</span><span class="hl-5">&gt;</span><span class="hl-1">Hide me :(</span><span class="hl-5">&lt;/</span><span class="hl-12">button</span><span class="hl-5">&gt;</span><br/><span class="hl-1"> </span><span class="hl-5">&lt;/</span><span class="hl-12">div</span><span class="hl-5">&gt;</span><br/><span class="hl-1"> )</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-3">export</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">withUserback</span><span class="hl-1">(</span><span class="hl-0">App</span><span class="hl-1">)</span>
</code></pre>
<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>
<p>For more information about available configuration settings and and functions available, see our <a href="https://docs.userback.io/docs/javascript-sdk">Javascript API</a></p>
</section></section>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/_userback_vue.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ <h2>Nuxt</h2>
<p>We also support the Nuxt framework and have an <a href="https://github.com/userback/widget-js/tree/develop/examples/nuxt">example</a> of it&#39;s usage within a project.</p>
<pre><code class="language-javascript"><span class="hl-8">// plugins/userback.client.js</span><br/><span class="hl-3">import</span><span class="hl-1"> </span><span class="hl-0">UserbackPlugin</span><span class="hl-1"> </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@userback/vue&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-3">export</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">defineNuxtPlugin</span><span class="hl-1">((</span><span class="hl-0">nuxtApp</span><span class="hl-1">) </span><span class="hl-9">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-9">const</span><span class="hl-1"> { </span><span class="hl-0">UB_TOKEN</span><span class="hl-1">: </span><span class="hl-10">token</span><span class="hl-1"> } = </span><span class="hl-4">useRuntimeConfig</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-0">nuxtApp</span><span class="hl-1">.</span><span class="hl-0">vueApp</span><span class="hl-1">.</span><span class="hl-4">use</span><span class="hl-1">(</span><span class="hl-0">UserbackPlugin</span><span class="hl-1">, { </span><span class="hl-0">token</span><span class="hl-1"> });</span><br/><span class="hl-1">});</span>
</code></pre>
<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>
<p>For more information about available configuration settings and and functions available, see our <a href="https://docs.userback.io/docs/javascript-sdk">Javascript API</a></p>
</section></section>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/_userback_vue2.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ <h2>Nuxt</h2>
<p>We also support the Nuxt framework and have an <a href="https://github.com/userback/widget-js/tree/develop/examples/nuxt2">example</a> of it&#39;s usage within a project.</p>
<pre><code class="language-javascript"><span class="hl-8">// plugins/userback.client.js</span><br/><span class="hl-3">import</span><span class="hl-1"> </span><span class="hl-0">UserbackPlugin</span><span class="hl-1"> </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@userback/vue2&#39;</span><span class="hl-1">;</span><br/><span class="hl-0">Vue</span><span class="hl-1">.</span><span class="hl-4">use</span><span class="hl-1">(</span><span class="hl-0">UserbackPlugin</span><span class="hl-1">, { </span><span class="hl-0">token:</span><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-0">env</span><span class="hl-1">.</span><span class="hl-10">USERBACK_TOKEN</span><span class="hl-1"> });</span>
</code></pre>
<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>
<p>For more information about available configuration settings and and functions available, see our <a href="https://docs.userback.io/docs/javascript-sdk">Javascript API</a></p>
</section></section>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/_userback_widget.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ <h2>Examples</h2>
<p>After initialisation, you can use the named function <code>getUserback</code> to get a reference to the UserbackWidget.</p>
<pre><code class="language-javascript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-0">getUserback</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@userback/widget&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">document</span><span class="hl-1">.</span><span class="hl-4">querySelector</span><span class="hl-1">(</span><span class="hl-2">&#39;button.screenshot&#39;</span><span class="hl-1">).</span><span class="hl-4">addEventListener</span><span class="hl-1">(</span><span class="hl-2">&#39;click&#39;</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-9">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-4">preventDefault</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-4">getUserback</span><span class="hl-1">().</span><span class="hl-4">open</span><span class="hl-1">(</span><span class="hl-2">&#39;bug&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;screenshot&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
</code></pre>
<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>
<p>For more information about available configuration settings and and functions available, see our <a href="https://docs.userback.io/docs/javascript-sdk">Javascript API</a></p>
</section></section>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
Expand Down
2 changes: 1 addition & 1 deletion widget-js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ document.querySelector('button.screenshot').addEventListener('click', (event) =>
```


For more information about available configuration settings and and functions available, see our [Javascript API](https://docs.userback.io/reference/javascript-api-overview)
For more information about available configuration settings and and functions available, see our [Javascript API](https://docs.userback.io/docs/javascript-sdk)
2 changes: 1 addition & 1 deletion widget-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,4 @@ export default withUserback(App)
```
For more information about available configuration settings and and functions available, see our [Javascript API](https://docs.userback.io/reference/javascript-api-overview)
For more information about available configuration settings and and functions available, see our [Javascript API](https://docs.userback.io/docs/javascript-sdk)
2 changes: 1 addition & 1 deletion widget-vue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ export default defineNuxtPlugin((nuxtApp) => {
});
```

For more information about available configuration settings and and functions available, see our [Javascript API](https://docs.userback.io/reference/javascript-api-overview)
For more information about available configuration settings and and functions available, see our [Javascript API](https://docs.userback.io/docs/javascript-sdk)
2 changes: 1 addition & 1 deletion widget-vue2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ import UserbackPlugin from '@userback/vue2';
Vue.use(UserbackPlugin, { token: process.env.USERBACK_TOKEN });
```

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

0 comments on commit 0d9cc88

Please sign in to comment.