Skip to content

Commit f7584de

Browse files
committed
update READMEs for vue(2/3)
1 parent 2d6724f commit f7584de

File tree

5 files changed

+43
-0
lines changed

5 files changed

+43
-0
lines changed

docs/assets/highlight.css

+7
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525
--dark-hl-11: #D4D4D4;
2626
--light-hl-12: #0000FF;
2727
--dark-hl-12: #CE9178;
28+
--light-hl-13: #008000;
29+
--dark-hl-13: #6A9955;
2830
--light-code-background: #FFFFFF;
2931
--dark-code-background: #1E1E1E;
3032
}
@@ -43,6 +45,7 @@
4345
--hl-10: var(--light-hl-10);
4446
--hl-11: var(--light-hl-11);
4547
--hl-12: var(--light-hl-12);
48+
--hl-13: var(--light-hl-13);
4649
--code-background: var(--light-code-background);
4750
} }
4851

@@ -60,6 +63,7 @@
6063
--hl-10: var(--dark-hl-10);
6164
--hl-11: var(--dark-hl-11);
6265
--hl-12: var(--dark-hl-12);
66+
--hl-13: var(--dark-hl-13);
6367
--code-background: var(--dark-code-background);
6468
} }
6569

@@ -77,6 +81,7 @@
7781
--hl-10: var(--light-hl-10);
7882
--hl-11: var(--light-hl-11);
7983
--hl-12: var(--light-hl-12);
84+
--hl-13: var(--light-hl-13);
8085
--code-background: var(--light-code-background);
8186
}
8287

@@ -94,6 +99,7 @@
9499
--hl-10: var(--dark-hl-10);
95100
--hl-11: var(--dark-hl-11);
96101
--hl-12: var(--dark-hl-12);
102+
--hl-13: var(--dark-hl-13);
97103
--code-background: var(--dark-code-background);
98104
}
99105

@@ -110,4 +116,5 @@
110116
.hl-10 { color: var(--hl-10); }
111117
.hl-11 { color: var(--hl-11); }
112118
.hl-12 { color: var(--hl-12); }
119+
.hl-13 { color: var(--hl-13); }
113120
pre, code { background: var(--code-background); }

docs/modules/_userback_vue.html

+7
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@ <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+
40+
<a href="#nuxt" id="nuxt" style="color: inherit; text-decoration: none;">
41+
<h2>Nuxt</h2>
42+
</a>
43+
<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>
44+
<pre><code class="language-javascript"><span class="hl-13">// plugins/userback.client.js</span><br/><span class="hl-1">import</span><span class="hl-0"> </span><span class="hl-2">UserbackPlugin</span><span class="hl-0"> </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&#39;@userback/vue&#39;</span><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">defineNuxtPlugin</span><span class="hl-0">((</span><span class="hl-2">nuxtApp</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-8">const</span><span class="hl-0"> { </span><span class="hl-2">UB_TOKEN</span><span class="hl-0">: </span><span class="hl-9">token</span><span class="hl-0"> } = </span><span class="hl-4">useRuntimeConfig</span><span class="hl-0">();</span><br/><span class="hl-0"> </span><span class="hl-2">nuxtApp</span><span class="hl-0">.</span><span class="hl-2">vueApp</span><span class="hl-0">.</span><span class="hl-4">use</span><span class="hl-0">(</span><span class="hl-2">UserbackPlugin</span><span class="hl-0">, { </span><span class="hl-2">token</span><span class="hl-0"> });</span><br/><span class="hl-0">});</span>
45+
</code></pre>
3946
<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>
4047
</section></section>
4148
<section class="tsd-panel-group tsd-index-group">

docs/modules/_userback_vue2.html

+7
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@ <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+
40+
<a href="#nuxt" id="nuxt" style="color: inherit; text-decoration: none;">
41+
<h2>Nuxt</h2>
42+
</a>
43+
<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>
44+
<pre><code class="language-javascript"><span class="hl-13">// plugins/userback.client.js</span><br/><span class="hl-1">import</span><span class="hl-0"> </span><span class="hl-2">UserbackPlugin</span><span class="hl-0"> </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&#39;@userback/vue2&#39;</span><span class="hl-0">;</span><br/><span class="hl-2">Vue</span><span class="hl-0">.</span><span class="hl-4">use</span><span class="hl-0">(</span><span class="hl-2">UserbackPlugin</span><span class="hl-0">, { </span><span class="hl-2">token:</span><span class="hl-0"> </span><span class="hl-2">process</span><span class="hl-0">.</span><span class="hl-2">env</span><span class="hl-0">.</span><span class="hl-9">USERBACK_TOKEN</span><span class="hl-0"> });</span>
45+
</code></pre>
3946
<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>
4047
</section></section>
4148
<section class="tsd-panel-group tsd-index-group">

widget-vue/README.md

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

28+
## Nuxt
29+
We also support the Nuxt framework and have an [example](https://github.com/userback/widget-js/tree/develop/examples/nuxt) of it's usage within a project.
30+
31+
``` javascript
32+
// plugins/userback.client.js
33+
import UserbackPlugin from '@userback/vue';
34+
35+
export default defineNuxtPlugin((nuxtApp) => {
36+
const { UB_TOKEN: token } = useRuntimeConfig();
37+
nuxtApp.vueApp.use(UserbackPlugin, { token });
38+
});
39+
```
40+
2841
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

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

27+
## Nuxt
28+
We also support the Nuxt framework and have an [example](https://github.com/userback/widget-js/tree/develop/examples/nuxt2) of it's usage within a project.
29+
30+
``` javascript
31+
// plugins/userback.client.js
32+
import UserbackPlugin from '@userback/vue2';
33+
Vue.use(UserbackPlugin, { token: process.env.USERBACK_TOKEN });
34+
```
35+
2736
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)